Merge branch 'develop' into 601-pre-release

dbale-altoros · dbale-altoros · commit f9dd5e157f0f · 2025-08-15T12:12:52.000+08:00
diff --git a/.github/workflows/DOCKER.yml b/.github/workflows/DOCKER.yml
@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Login to Docker Hub
       run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_ACCESS_TOKEN }}
diff --git a/.github/workflows/E2E.yml b/.github/workflows/E2E.yml
@@ -17,7 +17,7 @@ jobs:
         node: [16, 18, 20]
     
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
@@ -52,7 +52,7 @@ jobs:
       - name: Enable Debugging
         run: |
           echo "::debug::Debugging enabled"
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 18
@@ -90,7 +90,7 @@ jobs:
     name: Test on MacOS
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: actions/setup-node@v4
       with:
         node-version: 18
diff --git a/.github/workflows/PRE-COMMIT-HOOK-TEST.yml b/.github/workflows/PRE-COMMIT-HOOK-TEST.yml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Test Hook
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: actions/setup-node@v4
         with:
           node-version: 20
diff --git a/.github/workflows/TESTS.yml b/.github/workflows/TESTS.yml
@@ -19,7 +19,7 @@ jobs:
         node-version: [16, 18, 20]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
@@ -38,7 +38,7 @@ jobs:
     runs-on: windows-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: actions/setup-node@v4
       with:
         node-version: 18
@@ -57,7 +57,7 @@ jobs:
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - uses: actions/setup-node@v4
       with:
         node-version: 18
diff --git a/_config.yml b/_config.yml
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/rules/naming/func-name-mixedcase.md b/docs/rules/naming/func-name-mixedcase.md
@@ -26,6 +26,9 @@ This rule accepts a string option for rule severity. Must be one of "error", "wa
 }
 ```
 
+### Notes
+- SNAKE_CASE allowed only in interfaces when matching constant/immutable getter signatures.
+- Return must be elementary, enum, UDVT, or contract/interface.
 
 ## Examples
 This rule does not have examples.
diff --git a/e2e/autofix-test.js b/e2e/autofix-test.js
@@ -1,6 +1,6 @@
 const chai = require('chai')
 const { expect } = chai
-const fs = require('fs-extra')
+const fs = require('fs')
 const os = require('os')
 const path = require('path')
 const shell = require('shelljs')
@@ -566,10 +566,12 @@ function useFixture(dir) {
     const tmpDirContainer = os.tmpdir()
     this.testDirPath = path.join(tmpDirContainer, `solhint-tests-${dir}`)
 
-    fs.ensureDirSync(this.testDirPath)
-    fs.emptyDirSync(this.testDirPath)
+    fs.mkdirSync(this.testDirPath, { recursive: true })
+    for (const entry of fs.readdirSync(this.testDirPath)) {
+      fs.rmSync(path.join(this.testDirPath, entry), { recursive: true, force: true });
+    }
 
-    fs.copySync(fixturePath, this.testDirPath)
+    fs.cpSync(fixturePath, this.testDirPath, { recursive: true })
 
     shell.cd(this.testDirPath)
   })
diff --git a/e2e/formatters-test.js b/e2e/formatters-test.js
@@ -1,6 +1,6 @@
 const chai = require('chai')
 const { expect } = chai
-const fs = require('fs-extra')
+const fs = require('fs')
 const shell = require('shelljs')
 const url = require('url')
 const os = require('os')
@@ -705,10 +705,12 @@ function useFixture(dir) {
     const tmpDirContainer = os.tmpdir()
     this.testDirPath = path.join(tmpDirContainer, `solhint-tests-${dir}`)
 
-    fs.ensureDirSync(this.testDirPath)
-    fs.emptyDirSync(this.testDirPath)
+    fs.mkdirSync(this.testDirPath, { recursive: true })
+    for (const entry of fs.readdirSync(this.testDirPath)) {
+      fs.rmSync(path.join(this.testDirPath, entry), { recursive: true, force: true });
+    }
 
-    fs.copySync(fixturePath, this.testDirPath)
+    fs.cpSync(fixturePath, this.testDirPath, { recursive: true })
 
     shell.cd(this.testDirPath)
   })
diff --git a/e2e/test.js b/e2e/test.js
@@ -1,6 +1,6 @@
 const { expect } = require('chai')
 const cp = require('child_process')
-const fs = require('fs-extra')
+const fs = require('fs')
 const getStream = require('get-stream')
 const os = require('os')
 const path = require('path')
@@ -478,9 +478,12 @@ function useFixtureFolder(ctx, dir) {
 
   ctx.testDirPath = testDirPath
 
-  fs.ensureDirSync(testDirPath)
-  fs.emptyDirSync(testDirPath)
-  fs.copySync(fixturePath, testDirPath)
+    fs.mkdirSync(testDirPath, { recursive: true })
+    for (const entry of fs.readdirSync(testDirPath)) {
+      fs.rmSync(path.join(testDirPath, entry), { recursive: true, force: true });
+    }
+
+    fs.cpSync(fixturePath, testDirPath, { recursive: true })
 
   shell.cd(testDirPath)
 }
diff --git a/lib/cache/cache-manager.js b/lib/cache/cache-manager.js
@@ -1,4 +1,4 @@
-const fs = require('fs-extra')
+const fs = require('fs')
 const crypto = require('crypto')
 const path = require('path')
 
diff --git a/lib/common/utils.js b/lib/common/utils.js
@@ -1,4 +1,4 @@
-const fs = require('fs-extra')
+const fs = require('fs')
 const path = require('path')
 
 const getLocFromIndex = (text, index) => {
diff --git a/lib/config/config-file.js b/lib/config/config-file.js
@@ -1,4 +1,4 @@
-const fs = require('fs-extra')
+const fs = require('fs')
 const path = require('path')
 const _ = require('lodash')
 const { cosmiconfigSync } = require('cosmiconfig')
diff --git a/lib/index.js b/lib/index.js
@@ -1,4 +1,4 @@
-const fs = require('fs-extra')
+const fs = require('fs')
 const path = require('path')
 const parser = require('@solidity-parser/parser')
 const glob = require('glob')
@@ -100,7 +100,7 @@ function processFile(file, config, rootDir = process.cwd(), explicitConfigPath)
   const { report, updatedCache } = processAndCache(file, finalConfig, cacheState)
 
   if (finalConfig.cache && updatedCache) {
-    fs.ensureDirSync(path.dirname(cachePath)) // make sure the directory exists
+    fs.mkdirSync(path.dirname(cachePath), { recursive: true }) // make sure the directory exists
     writeCache(cachePath, updatedCache)
   }
 
@@ -135,7 +135,7 @@ function processPath(pattern, config, rootDir = process.cwd(), explicitConfigPat
   }
 
   if (useCache) {
-    fs.ensureDirSync(path.dirname(cachePath)) // make sure the directory exists
+    fs.mkdirSync(path.dirname(cachePath), { recursive: true }) // make sure the directory exists
     writeCache(cachePath, updatedCache)
   }
 
diff --git a/lib/rules/miscellaneous/import-path-check.js b/lib/rules/miscellaneous/import-path-check.js
@@ -1,4 +1,4 @@
-const fs = require('fs-extra')
+const fs = require('fs')
 const path = require('path')
 const BaseChecker = require('../base-checker')
 const { severityDescription } = require('../../doc/utils')
diff --git a/lib/rules/naming/func-name-mixedcase.js b/lib/rules/naming/func-name-mixedcase.js
@@ -8,6 +8,14 @@ const meta = {
   docs: {
     description: 'Function name must be in mixedCase.',
     category: 'Style Guide Rules',
+    notes: [
+      {
+        note: 'SNAKE_CASE allowed only in interfaces when matching constant/immutable getter signatures.',
+      },
+      {
+        note: 'Return must be elementary, enum, UDVT, or contract/interface.',
+      },
+    ],
   },
 
   recommended: true,
@@ -19,13 +27,66 @@ const meta = {
 class FuncNameMixedcaseChecker extends BaseChecker {
   constructor(reporter) {
     super(reporter, ruleId, meta)
+    this._ifaceDepth = 0
+  }
+
+  ContractDefinition(node) {
+    if (node.kind === 'interface') this._ifaceDepth++
+  }
+
+  'ContractDefinition:exit'(node) {
+    if (node.kind === 'interface') this._ifaceDepth--
   }
 
   FunctionDefinition(node) {
-    if (naming.isNotMixedCase(node.name) && !node.isConstructor) {
+    if (node.isConstructor) return
+
+    // Strict exception: only getters of constant/immutable in interfaces
+    const inInterface = this._ifaceDepth > 0
+    const noParams = (node.parameters?.length || 0) === 0
+    const isView = node.stateMutability === 'view'
+    const isSnake = naming.isUpperSnakeCase(node.name)
+
+    const returns = node.returnParameters || []
+
+    // check return values
+    const isReturnValid = this.hasSingleAllowedReturn(returns)
+
+    if (inInterface && noParams && isView && isSnake && isReturnValid) {
+      return // allowed
+    }
+
+    if (naming.isNotMixedCase(node.name)) {
       this.error(node, 'Function name must be in mixedCase')
     }
   }
+
+  hasSingleAllowedReturn(returns) {
+    // more than 1 element, not allowed
+    if (returns.length !== 1) return false
+    const ret = returns[0]
+    const tn = ret?.typeName
+
+    // check return element and type
+    if (!tn || !tn.type) return false
+
+    // exclude arrays and tuples
+    if (tn.type === 'ArrayTypeName' || tn.type === 'TupleTypeName') return false
+
+    // elementary: bool, address, int/uint*, bytes*, string...
+    if (tn.type === 'ElementaryTypeName') return true
+
+    // check if it's a user-defined type without storage location (contract/interface, enum, UDVT)
+    if (tn.type === 'UserDefinedTypeName') {
+      const hasStorage = !!ret.storageLocation // 'memory' | 'calldata' | undefined
+      return !hasStorage
+    }
+
+    // optional: some older parsers separate address/bytes
+    if (tn.type === 'AddressTypeName' || tn.type === 'BytesTypeName') return true
+
+    return false
+  }
 }
 
 module.exports = FuncNameMixedcaseChecker
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -51,7 +51,6 @@
     "commander": "^10.0.0",
     "cosmiconfig": "^8.0.0",
     "fast-diff": "^1.2.0",
-    "fs-extra": "^11.1.0",
     "glob": "^8.0.3",
     "ignore": "^5.2.4",
     "js-yaml": "^4.1.0",
diff --git a/scripts/generate-rule-docs.js b/scripts/generate-rule-docs.js
@@ -1,5 +1,5 @@
 #!env node
-const fs = require('fs-extra')
+const fs = require('fs')
 const { exec, mkdir } = require('shelljs')
 const semver = require('semver')
 const path = require('path')
diff --git a/scripts/generate-rulesets.js b/scripts/generate-rulesets.js
@@ -1,4 +1,4 @@
-const fs = require('fs-extra')
+const fs = require('fs')
 
 const { loadRules } = require('../lib/load-rules')
 
diff --git a/solhint.js b/solhint.js
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 const program = require('commander')
 const _ = require('lodash')
-const fs = require('fs-extra')
+const fs = require('fs')
 const process = require('process')
 const readline = require('readline')
 const chalk = require('chalk')
diff --git a/test/common/utils.js b/test/common/utils.js
diff --git a/test/rules/miscellaneous/config-hierarchy.js b/test/rules/miscellaneous/config-hierarchy.js
diff --git a/test/rules/miscellaneous/import-path-check.js b/test/rules/miscellaneous/import-path-check.js
diff --git a/test/rules/naming/func-name-mixedcase.js b/test/rules/naming/func-name-mixedcase.js

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ This rule accepts a string option for rule severity. Must be one of "error", "wa`
`26`	`26`	`}`
`27`	`27`	```
`28`	`28`
	`29`	`+### Notes`
	`30`	`+- SNAKE_CASE allowed only in interfaces when matching constant/immutable getter signatures.`
	`31`	`+- Return must be elementary, enum, UDVT, or contract/interface.`
`29`	`32`
`30`	`33`	`## Examples`
`31`	`34`	`This rule does not have examples.`