Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
disallow imports that potentially pollute the namespace by importing every defined name of the imported file. ~when registering an ImportDirective method on the NoGlobalImportsChecker class, it's only called by imports that explicitly define a new Identifier, the only way I found to find global imports is to search for them in the SourceUnit nodes~ ^ was recommended against in review and when trying to replicate it to show the issue to fvictorio, I wasn't able to. So the cleaner way, using the ImportDirective visitor, will remain.
- Loading branch information
1 parent
d4c0a46
commit 2fa6418
Showing
5 changed files
with
148 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
warning: "This is a dynamically generated file. Do not edit manually." | ||
layout: "default" | ||
title: "no-global-import | Solhint" | ||
--- | ||
|
||
# no-global-import | ||
![Category Badge](https://img.shields.io/badge/-Best%20Practise%20Rules-informational) | ||
![Default Severity Badge warn](https://img.shields.io/badge/Default%20Severity-warn-yellow) | ||
|
||
## Description | ||
Import statement includes an entire file instead of selected symbols | ||
|
||
## Options | ||
This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Default to warn. | ||
|
||
### Example Config | ||
```json | ||
{ | ||
"rules": { | ||
"no-global-import": "warn" | ||
} | ||
} | ||
``` | ||
|
||
|
||
## Examples | ||
### 👍 Examples of **correct** code for this rule | ||
|
||
#### import names explicitly | ||
|
||
```solidity | ||
import {A} from "./A.sol" | ||
``` | ||
|
||
### 👎 Examples of **incorrect** code for this rule | ||
|
||
#### import all members from a file | ||
|
||
```solidity | ||
import * from "foo.sol" | ||
``` | ||
|
||
#### import an entire file | ||
|
||
```solidity | ||
import "foo.sol" | ||
``` | ||
|
||
## Version | ||
This rule is introduced in the latest version. | ||
|
||
## Resources | ||
- [Rule source](https://github.com/protofire/solhint/tree/master/lib/rules/best-practises/no-global-import.js) | ||
- [Document source](https://github.com/protofire/solhint/tree/master/docs/rules/best-practises/no-global-import.md) | ||
- [Test cases](https://github.com/protofire/solhint/tree/master/test/rules/best-practises/no-global-import.js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
const BaseChecker = require('../base-checker') | ||
|
||
const ruleId = 'no-global-import' | ||
const meta = { | ||
type: 'best-practises', | ||
|
||
docs: { | ||
description: 'Import statement includes an entire file instead of selected symbols', | ||
category: 'Best Practise Rules', | ||
examples: { | ||
bad: [ | ||
{ description: 'import all members from a file', code: 'import * from "foo.sol"' }, | ||
{ description: 'import an entire file', code: 'import "foo.sol"' }, | ||
], | ||
good: [{ description: 'import names explicitly', code: 'import {A} from "./A.sol"' }], | ||
}, | ||
}, | ||
|
||
isDefault: false, | ||
recommended: false, | ||
defaultSetup: 'warn', | ||
|
||
schema: null, | ||
} | ||
|
||
class NoGlobalImportsChecker extends BaseChecker { | ||
constructor(reporter) { | ||
super(reporter, ruleId, meta) | ||
} | ||
|
||
ImportDirective(node) { | ||
if (!node.symbolAliases) { | ||
this.error( | ||
node, | ||
`global import of path ${node.path} is not allowed. Specify names to import individually` | ||
) | ||
} | ||
} | ||
} | ||
|
||
module.exports = NoGlobalImportsChecker |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
const linter = require('../../../lib/index') | ||
const { | ||
assertNoWarnings, | ||
assertLineNumber, | ||
assertErrorMessage, | ||
assertWarnsCount, | ||
} = require('../../common/asserts') | ||
|
||
describe('Linter - no-global-import', () => { | ||
it('should raise on import * from "path"', () => { | ||
const code = `import * from './A.sol';` | ||
|
||
const report = linter.processStr(code, { | ||
rules: { 'no-global-import': 'warn' }, | ||
}) | ||
assertWarnsCount(report, 1) | ||
assertErrorMessage(report, 'global import') | ||
assertErrorMessage(report, 'Specify names to import individually') | ||
}) | ||
it('should raise on import "path"', () => { | ||
const code = `import './A.sol';` | ||
|
||
const report = linter.processStr(code, { | ||
rules: { 'no-global-import': 'warn' }, | ||
}) | ||
assertWarnsCount(report, 1) | ||
assertErrorMessage(report, 'global import') | ||
assertErrorMessage(report, 'Specify names to import individually') | ||
}) | ||
it('should report correct line', () => { | ||
const code = `import {A} from './A.sol'; | ||
import './A.sol';` | ||
|
||
const report = linter.processStr(code, { | ||
rules: { 'no-global-import': 'warn' }, | ||
}) | ||
assertLineNumber(report.reports[0], 2) | ||
assertWarnsCount(report, 1) | ||
}) | ||
it('should not raise on import {identifier} from "path"', () => { | ||
const code = `import {A} from './A.sol';` | ||
|
||
const report = linter.processStr(code, { | ||
rules: { 'no-global-import': 'warn' }, | ||
}) | ||
assertNoWarnings(report) | ||
}) | ||
}) |