Merge pull request #626 from protofire/feature/duplicated-imports

feature: duplicated import rule
protofire · Jan 16, 2025 · 9de0535 · 9de0535
2 parents 0494368 + fa1d56c
commit 9de0535
Show file tree

Hide file tree

Showing 9 changed files with 642 additions and 13 deletions.
diff --git a/conf/rulesets/solhint-all.js b/conf/rulesets/solhint-all.js
@@ -36,6 +36,7 @@ module.exports = Object.freeze({
     'gas-strict-inequalities': 'warn',
     'gas-struct-packing': 'warn',
     'comprehensive-interface': 'warn',
+    'duplicated-imports': 'warn',
     quotes: ['error', 'double'],
     'const-name-snakecase': 'warn',
     'contract-name-capwords': 'warn',

diff --git a/docs/rules.md b/docs/rules.md
@@ -28,6 +28,7 @@ title:       "Rule Index of Solhint"
 | Rule Id                                                                              | Error                                                                                                         | Recommended  | Deprecated  |
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | ------------ | ----------- |
 | [interface-starts-with-i](./rules/naming/interface-starts-with-i.md)                 | Solidity Interfaces names should start with an `I`                                                            |              |             |
+| [duplicated-imports](./rules/miscellaneous/duplicated-imports.md)                    | Check if an import is done twice in the same file and there is no alias                                       |              |             |
 | [const-name-snakecase](./rules/naming/const-name-snakecase.md)                       | Constant name must be in capitalized SNAKE_CASE. (Does not check IMMUTABLES, use immutable-vars-naming)       | $~~~~~~~~$✔️ |             |
 | [contract-name-capwords](./rules/naming/contract-name-capwords.md)                   | Contract, Structs and Enums should be in CapWords.                                                            | $~~~~~~~~$✔️ |             |
 | [event-name-capwords](./rules/naming/event-name-capwords.md)                         | Event name must be in CapWords.                                                                               | $~~~~~~~~$✔️ |             |

diff --git a/docs/rules/miscellaneous/duplicated-imports.md b/docs/rules/miscellaneous/duplicated-imports.md
@@ -0,0 +1,41 @@
+---
+warning:     "This is a dynamically generated file. Do not edit manually."
+layout:      "default"
+title:       "duplicated-imports | Solhint"
+---
+
+# duplicated-imports
+![Category Badge](https://img.shields.io/badge/-Style%20Guide%20Rules-informational)
+![Default Severity Badge warn](https://img.shields.io/badge/Default%20Severity-warn-yellow)
+
+## Description
+Check if an import is done twice in the same file and there is no alias
+
+## Options
+This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Defaults to warn.
+
+### Example Config
+```json
+{
+  "rules": {
+    "duplicated-imports": "warn"
+  }
+}
+```
+
+### Notes
+- Rule reports "(inline) duplicated" if the same object is imported more than once in the same import statement
+- Rule reports "(globalSamePath) duplicated" if the same object is imported on another import statement from same location
+- Rule reports "(globalDiffPath) duplicated" if the same object is imported on another import statement, from other location, but no alias
+- Rule does NOT support this kind of import "import * as Alias from "./filename.sol"
+
+## Examples
+This rule does not have examples.
+
+## Version
+This rule is introduced in the latest version.
+
+## Resources
+- [Rule source](https://github.com/protofire/solhint/blob/master/lib/rules/miscellaneous/duplicated-imports.js)
+- [Document source](https://github.com/protofire/solhint/blob/master/docs/rules/miscellaneous/duplicated-imports.md)
+- [Test cases](https://github.com/protofire/solhint/blob/master/test/rules/miscellaneous/duplicated-imports.js)
diff --git a/e2e/autofix-test.js b/e2e/autofix-test.js
@@ -145,7 +145,7 @@ describe('e2e', function () {
 
           const reportLines = stdout.split('\n')
           const finalLine = '5 problems (5 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
 
           result = compareTextFiles(currentFile, afterFixFile)
           expect(result).to.be.true
@@ -194,7 +194,7 @@ describe('e2e', function () {
         it('should get the right report (2)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '27 problems (27 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -240,7 +240,7 @@ describe('e2e', function () {
         it('should get the right report (3)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '9 problems (9 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -286,7 +286,7 @@ describe('e2e', function () {
         it('should get the right report (4)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '19 problems (19 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -332,7 +332,7 @@ describe('e2e', function () {
         it('should get the right report (5)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '11 problems (11 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -379,7 +379,7 @@ describe('e2e', function () {
         it('should get the right report (6)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '8 problems (8 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -419,7 +419,7 @@ describe('e2e', function () {
         it('should get the right report (6)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '8 problems (8 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -466,7 +466,7 @@ describe('e2e', function () {
       it('should get the right report (7)', () => {
         const reportLines = stdout.split('\n')
         const finalLine = '3 problems (3 errors, 0 warnings)'
-        expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+        expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
       })
     })
 
@@ -512,7 +512,7 @@ describe('e2e', function () {
       it('should get the right report (8)', () => {
         const reportLines = stdout.split('\n')
         const finalLine = '5 problems (5 errors, 0 warnings)'
-        expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+        expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
       })
     })
 
@@ -558,7 +558,7 @@ describe('e2e', function () {
       it('should get the right report (9)', () => {
         const reportLines = stdout.split('\n')
         const finalLine = '6 problems (6 errors, 0 warnings)'
-        expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+        expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
       })
     })
 
@@ -604,7 +604,7 @@ describe('e2e', function () {
         it('should get the right report (10)', () => {
           const reportLines = stdout.split('\n')
           const finalLine = '18 problems (18 errors, 0 warnings)'
-          expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+          expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
         })
       })
 
@@ -649,7 +649,7 @@ describe('e2e', function () {
     //     it('should get the right report (11)', () => {
     //       const reportLines = stdout.split('\n')
     //       const finalLine = '12 problems (12 errors, 0 warnings)'
-    //       expect(reportLines[reportLines.length - 3]).to.contain(finalLine)
+    //       expect(reportLines[reportLines.length - 7]).to.contain(finalLine)
     //     })
     //   })