Merge pull request #678 from protofire/config-multiple-folders

dbale-altoros · web-flow · commit d4d63630850d · 2025-06-20T17:21:38.000-03:00
feat: config in multiple dirs
diff --git a/README.md b/README.md
@@ -62,7 +62,7 @@ Options:
   -V, --version                           output the version number
   -f, --formatter [name]                  report formatter name (stylish, table, tap, unix, json, compact, sarif)
   -w, --max-warnings [maxWarningsNumber]  number of allowed warnings, works in quiet mode as well
-  -c, --config [file_name]                file to use as your .solhint.json
+  -c, --config [file_name]                file to use as your rules configuration file (not compatible with multiple configs)
   -q, --quiet                             report errors only - default: false
   --ignore-path [file_name]               file to use as your .solhintignore
   --fix                                   automatically fix problems and show report
@@ -111,9 +111,37 @@ This file has the following format:
   "extends": "solhint:recommended"
 }
 ```
-### Note
+### Note 1
 The `solhint:default` configuration contains only two rules: max-line-length & no-console
 It is now deprecated since version 5.1.0
+<br>
+
+### Note 2
+Multiple configs files can be used at once. All config files should be named `.solhint.json`.
+If not done like this, multiple hierarchy configuration will not work.
+Solhint will go though all config files automatically.
+
+Given this structure:
+```
+Project ROOT =>
+/contracts
+---> RootAndContractRules.sol
+---> .solhint.json
+
+/src
+--->RootRules.sol
+--->interfaces/
+------->InterfaceRules.sol
+------->solhint.json  
+
+.solhint.json  
+```
+- Solhint config located on `root` will be the main one.
+- When analyzing `RootRules.sol`, `root` file config will be used that file.
+- `InterfaceRules.sol` will be using the one inside its own folder taking precedence over the `root` folder one.
+- Rules not present in `interfaces/` folder and present in `root` will be active.
+- Rules not present in `root` folder and present in `interfaces/` folder will be active.
+- If rule is present in both files, the closest to the analyzed file will take precedence. Meaning when analyzing `InterfaceRules.sol` the config file located in `Interfaces/` will be used with the remaining rules of the `root` one.
 <br><br>
 
 
diff --git a/docs/rules.md b/docs/rules.md
@@ -98,5 +98,5 @@ title:       "Rule Index of Solhint"
 
 ## References
 
-- [ConsenSys Guide for Smart Contracts](https://consensysdiligence.github.io/smart-contract-best-practices/development-recommendations/)
+- [ConsenSys Guide for Smart Contracts](https://consensys.github.io/smart-contract-best-practices/development-recommendations/)
 - [Solidity Style Guide](http://solidity.readthedocs.io/en/develop/style-guide.html)
diff --git a/docs/rules/miscellaneous/duplicated-imports.md b/docs/rules/miscellaneous/duplicated-imports.md
@@ -33,7 +33,7 @@ This rule accepts a string option for rule severity. Must be one of "error", "wa
 This rule does not have examples.
 
 ## Version
-This rule was introduced in the latest version.
+This rule was introduced in [Solhint 5.1.0](https://github.com/protofire/solhint/blob/v5.1.0)
 
 ## Resources
 - [Rule source](https://github.com/protofire/solhint/blob/master/lib/rules/miscellaneous/duplicated-imports.js)
diff --git a/docs/rules/miscellaneous/import-path-check.md b/docs/rules/miscellaneous/import-path-check.md
@@ -58,7 +58,7 @@ This rule accepts an array of options:
 This rule does not have examples.
 
 ## Version
-This rule was introduced in the latest version.
+This rule was introduced in [Solhint 5.1.0](https://github.com/protofire/solhint/blob/v5.1.0)
 
 ## Resources
 - [Rule source](https://github.com/protofire/solhint/blob/master/lib/rules/miscellaneous/import-path-check.js)
diff --git a/docs/rules/naming/imports-order.md b/docs/rules/naming/imports-order.md
@@ -35,7 +35,7 @@ This rule accepts a string option for rule severity. Must be one of "error", "wa
 This rule does not have examples.
 
 ## Version
-This rule was introduced in the latest version.
+This rule was introduced in [Solhint 5.1.0](https://github.com/protofire/solhint/blob/v5.1.0)
 
 ## Resources
 - [Rule source](https://github.com/protofire/solhint/blob/master/lib/rules/order/imports-order.js)
diff --git a/e2e/11-multiple-configs/.solhint.json b/e2e/11-multiple-configs/.solhint.json
@@ -0,0 +1,8 @@
+{
+  "rules": {
+    "compiler-version": "off",
+    "quotes": ["error", "double"],
+    "no-console": "error"
+  }
+}
+
diff --git a/e2e/11-multiple-configs/contracts/.solhint.json b/e2e/11-multiple-configs/contracts/.solhint.json
@@ -0,0 +1,7 @@
+{
+  "rules": {
+    "quotes": ["error", "single"],
+    "compiler-version": "off"
+  }
+}
+
diff --git a/e2e/11-multiple-configs/contracts/RootAndContractRules.sol b/e2e/11-multiple-configs/contracts/RootAndContractRules.sol
@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+contract RootAndContractRules {
+    string public test = 'this one should NOT fail';
+
+    constructor() {
+
+        console.log("error on no-console");
+    }
+}
+
diff --git a/e2e/11-multiple-configs/src/RootRules.sol b/e2e/11-multiple-configs/src/RootRules.sol
@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+contract RootRules {
+    string public test = 'this one should fail';
+
+    constructor() {
+
+        console.log("error on no-console");
+    }
+}
+
diff --git a/e2e/11-multiple-configs/src/interfaces/.solhint.json b/e2e/11-multiple-configs/src/interfaces/.solhint.json
@@ -0,0 +1,9 @@
+{
+  "rules": {
+    "compiler-version": "off",
+    "quotes": ["error", "single"],
+    "no-console": "off",
+    "no-empty-blocks": "error"
+  }
+}
+
diff --git a/e2e/11-multiple-configs/src/interfaces/InterfaceRules.sol b/e2e/11-multiple-configs/src/interfaces/InterfaceRules.sol
@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+contract InterfaceRules {
+    string public test = 'this one should NOT fail';
+
+    constructor() {
+
+        console.log('NO error: no-console is OFF');
+    }
+    
+    function emptyBlocksToFail() external {}
+}
+
diff --git a/e2e/test.js b/e2e/test.js
@@ -200,9 +200,8 @@ describe('e2e general tests', function () {
 
     beforeEach(() => {
       const padded = String(folderCounter).padStart(2, '0')
-      
-      const ROOT = PATH + padded + '/'
 
+      const ROOT = PATH + padded + '/'
       useFixtureFolder(this, ROOT + 'project')
 
       folderCounter++
@@ -223,9 +222,9 @@ describe('e2e general tests', function () {
     })
 
     it('Should succeed when importing from node_modules - filesystem03', () => {
-      const fileName = "node_modules/@openzeppelin/contracts/token/ERC20/ERC20.sol";
+      const fileName = 'node_modules/@openzeppelin/contracts/token/ERC20/ERC20.sol'
       createDummyFile(fileName)
-      
+
       const { code, stdout } = shell.exec(`solhint -c ".solhintS03.json" "./contracts/Test.sol"`)
 
       expect(code).to.equal(EXIT_CODES.OK)
@@ -241,11 +240,45 @@ describe('e2e general tests', function () {
       )
     })
   })
+
+  describe('config-hierarchy-test', () => {
+    const PATH = '11-multiple-configs'
+    const ERROR_CONSOLE = 'Unexpected console statement'
+    const ERROR_QUOTES = 'quotes for string literals'
+    const ERROR_EMPTY_BLOCKS = 'Code contains empty blocks'
+
+    useFixture(PATH)
+
+    it(`should inherit no-console rule from root and add contract folder config rules`, () => {
+      const { code, stdout } = shell.exec(`solhint contracts/RootAndContractRules.sol`)
+
+      expect(code).to.equal(EXIT_CODES.REPORTED_ERRORS)
+      expect(stdout.trim()).to.contain(ERROR_CONSOLE)
+      expect(stdout.trim()).to.contain(ERROR_QUOTES)
+    })
+
+    it(`should inherit both rules from root `, () => {
+      const { code, stdout } = shell.exec(`solhint src/RootRules.sol`)
+
+      expect(code).to.equal(EXIT_CODES.REPORTED_ERRORS)
+      expect(stdout.trim()).to.contain(ERROR_CONSOLE)
+      expect(stdout.trim()).to.contain(ERROR_QUOTES)
+    })
+
+    it(`should override no console and quotes rules`, () => {
+      const { code, stdout } = shell.exec(`solhint src/interfaces/InterfaceRules.sol`)
+
+      expect(code).to.equal(EXIT_CODES.REPORTED_ERRORS)
+      expect(stdout.trim()).to.contain(ERROR_EMPTY_BLOCKS)
+      expect(stdout.trim()).to.not.contain(ERROR_CONSOLE)
+      expect(stdout.trim()).to.not.contain(ERROR_QUOTES)
+    })
+  })
 })
 
 function useFixture(dir) {
   beforeEach(`switch to ${dir}`, function () {
-    useFixtureFolder(this, dir);
+    useFixtureFolder(this, dir)
   })
 }
 
@@ -265,7 +298,7 @@ function useFixtureFolder(ctx, dir) {
 }
 
 function createDummyFile(fullFilePath, content = '// dummy file\npragma solidity ^0.8.0;') {
-  const dir = path.dirname(fullFilePath);
-  fs.mkdirSync(dir, { recursive: true });
-  fs.writeFileSync(fullFilePath, content);
-}
+  const dir = path.dirname(fullFilePath)
+  fs.mkdirSync(dir, { recursive: true })
+  fs.writeFileSync(fullFilePath, content)
+}
diff --git a/lib/config/config-file.js b/lib/config/config-file.js
@@ -87,8 +87,38 @@ const applyExtends = (config, getter = configGetter) => {
   }, config)
 }
 
+// Load and merge all .solhint.json files from the file's directory up to rootDir,
+// unless explicitConfigPath is present (in that case use custom config file, not doing hierarchy).
+function loadConfigForFile(filePath, rootDir, explicitConfigPath) {
+  if (explicitConfigPath) {
+    return loadConfig(explicitConfigPath)
+  }
+
+  let dir = path.dirname(path.resolve(filePath))
+  const configs = []
+  const configFileName = '.solhint.json'
+  rootDir = path.resolve(rootDir)
+
+  // Search from the file's directory up to rootDir (inclusive)
+  // merge all found .solhint.json files (the config in the deepest directory overrides)
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    const configPath = path.join(dir, configFileName)
+    if (fs.existsSync(configPath)) {
+      // use loadConfig to parse, so it supports extends/etc.
+      configs.unshift(loadConfig(configPath))
+    }
+    if (dir === rootDir || path.dirname(dir) === dir) break
+    dir = path.dirname(dir)
+  }
+
+  // merge all configs found (from root to the deepest one)
+  return _.merge({}, ...configs)
+}
+
 module.exports = {
   applyExtends,
   configGetter,
   loadConfig,
+  loadConfigForFile,
 }
diff --git a/lib/index.js b/lib/index.js
@@ -3,7 +3,7 @@ const parser = require('@solidity-parser/parser')
 const glob = require('glob')
 const ignore = require('ignore')
 const astParents = require('ast-parents')
-const { applyExtends } = require('./config/config-file')
+const { applyExtends, loadConfigForFile } = require('./config/config-file')
 const Reporter = require('./reporter')
 const TreeListener = require('./tree-listener')
 const checkers = require('./rules/index')
@@ -51,20 +51,27 @@ function processStr(inputStr, config = {}, fileName = '') {
   return reporter
 }
 
-function processFile(file, config) {
-  const report = processStr(fs.readFileSync(file).toString(), config, file)
+// Process the solidity file using the specified config or, if not provided,
+// searches for .solhint.json files in the file's directory hierarchy.
+// explicitConfigPath is optional and is used to force a specific config.
+// eslint-disable-next-line default-param-last
+function processFile(file, config, rootDir = process.cwd(), explicitConfigPath) {
+  // If we receive an explicit config, we use it; otherwise, we search hierarchically or use the config passed by -c
+  const finalConfig =
+    config !== undefined ? config : loadConfigForFile(file, rootDir, explicitConfigPath)
+  const report = processStr(fs.readFileSync(file, 'utf8').toString(), finalConfig, file)
   report.file = file
-
   return report
 }
 
-function processPath(path, config) {
-  const ignoreFilter = ignore({ allowRelativePaths: true }).add(config.excludedFiles)
-
-  const allFiles = glob.sync(path, { nodir: true })
+// eslint-disable-next-line default-param-last
+function processPath(pattern, config, rootDir = process.cwd(), explicitConfigPath) {
+  const ignoreFilter = ignore({ allowRelativePaths: true }).add(
+    (config && config.excludedFiles) || []
+  )
+  const allFiles = glob.sync(pattern, { nodir: true })
   const files = ignoreFilter.filter(allFiles)
-
-  return files.map((curFile) => processFile(curFile, config))
+  return files.map((curFile) => processFile(curFile, config, rootDir, explicitConfigPath))
 }
 
 module.exports = { processPath, processFile, processStr }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/solhint.js b/solhint.js
diff --git a/test/rules/miscellaneous/config-hierarchy.js b/test/rules/miscellaneous/config-hierarchy.js
