changed default cache location

Author: dbale-altoros

README.md

@@ -173,14 +173,21 @@ additional-tests.sol
 Solhint supports a caching mechanism using the `--cache` flag to avoid re-linting files that haven't changed. 
 When enabled, Solhint stores a hash of each file's content and effective configuration, skipping analysis if neither has changed. 
 By default, the cache is saved in `.solhintcache.json` in the current working directory. 
-You can customize this location using the `--cache-location option`.
+You can customize this location using the `--cache-location option`. If no location is specified, the file will be stored in:
+`node_modules/.cache/solhint/.solhint-cache.json`
+
+Warning:
+When using `cache` flag. If a file was analyzed with not error for a certain config, the hash will be stored. If the file is not changed but the config file (`.solhint.json`) has some new rules, the file will not be analyzed. 
+To analyze it again, remove `cache` option.
 
 Example:
 ```
 solhint contracts/**/*.sol --cache
 solhint Foo.sol --cache --cache-location tmp/my-cache.json
 ```
 
+
+
 ### Extendable rulesets
 
 The rulesets provided by solhint are the following:

e2e/test.js

@@ -282,7 +282,7 @@ describe('e2e general tests', function () {
     useFixture(PATH)
 
     beforeEach(() => {
-      cacheFilePath = path.join(shell.pwd().toString(), '.solhintcache.json')
+      cacheFilePath = path.join('node_modules', '.cache', 'solhint', '.solhintcache.json')
       if (fs.existsSync(cacheFilePath)) fs.unlinkSync(cacheFilePath)
     })
 

lib/cache/cache-manager.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 const crypto = require('crypto')
 const path = require('path')
 

lib/common/utils.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 
 const getLocFromIndex = (text, index) => {

lib/config/config-file.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 const _ = require('lodash')
 const { cosmiconfigSync } = require('cosmiconfig')

lib/index.js

@@ -1,4 +1,5 @@
-const fs = require('fs')
+const fs = require('fs-extra')
+const path = require('path')
 const parser = require('@solidity-parser/parser')
 const glob = require('glob')
 const ignore = require('ignore')
@@ -84,9 +85,12 @@ function processFile(file, config, rootDir = process.cwd(), explicitConfigPath)
   const finalConfig =
     config !== undefined ? config : loadConfigForFile(file, rootDir, explicitConfigPath)
 
+  const defaultCachePath = path.join('node_modules', '.cache', 'solhint', '.solhintcache.json')
+  const cachePath = finalConfig.cacheLocation || defaultCachePath
+
   let cacheState = null
   if (finalConfig.cache) {
-    const cacheData = readCache(finalConfig.cacheLocation || '.solhintcache.json')
+    const cacheData = readCache(cachePath)
     cacheState = {
       cacheData,
       updatedCache: { ...cacheData },
@@ -96,7 +100,8 @@ function processFile(file, config, rootDir = process.cwd(), explicitConfigPath)
   const { report, updatedCache } = processAndCache(file, finalConfig, cacheState)
 
   if (finalConfig.cache && updatedCache) {
-    writeCache(finalConfig.cacheLocation || '.solhintcache.json', updatedCache)
+    fs.ensureDirSync(path.dirname(cachePath)) // make sure the directory exists
+    writeCache(cachePath, updatedCache)
   }
 
   return report
@@ -109,7 +114,9 @@ function processPath(pattern, config, rootDir = process.cwd(), explicitConfigPat
   const files = ignoreFilter.filter(allFiles)
 
   const useCache = config?.cache
-  const cachePath = config?.cacheLocation || '.solhintcache.json'
+  const defaultCachePath = path.join('node_modules', '.cache', 'solhint', '.solhintcache.json')
+  const cachePath = config?.cacheLocation || defaultCachePath
+
   const cacheData = useCache ? readCache(cachePath) : {}
   const updatedCache = { ...cacheData }
 
@@ -128,6 +135,7 @@ function processPath(pattern, config, rootDir = process.cwd(), explicitConfigPat
   }
 
   if (useCache) {
+    fs.ensureDirSync(path.dirname(cachePath)) // make sure the directory exists
     writeCache(cachePath, updatedCache)
   }
 

lib/rules/miscellaneous/import-path-check.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 const BaseChecker = require('../base-checker')
 const { severityDescription } = require('../../doc/utils')

package.json

@@ -60,7 +60,8 @@
     "semver": "^7.5.2",
     "strip-ansi": "^6.0.1",
     "table": "^6.8.1",
-    "text-table": "^0.2.0"
+    "text-table": "^0.2.0",
+    "fs-extra": "^11.1.0"
   },
   "devDependencies": {
     "assert": "^2.0.0",
@@ -71,7 +72,6 @@
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^4.2.1",
-    "fs-extra": "^11.1.0",
     "get-stream": "^6.0.0",
     "markdown-table": "^2.0.0",
     "mocha": "^10.2.0",

scripts/generate-rule-docs.js

@@ -1,5 +1,5 @@
 #!env node
-const fs = require('fs')
+const fs = require('fs-extra')
 const { exec, mkdir } = require('shelljs')
 const semver = require('semver')
 const path = require('path')

scripts/generate-rulesets.js

@@ -1,4 +1,4 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 
 const { loadRules } = require('../lib/load-rules')