-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove OpenZeppelin Contracts from git submodules
- Loading branch information
Showing
9 changed files
with
122 additions
and
9 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,6 @@ | ||
[submodule "lib/forge-std"] | ||
path = lib/forge-std | ||
url = https://github.com/foundry-rs/forge-std | ||
[submodule "lib/openzeppelin-contracts"] | ||
path = lib/openzeppelin-contracts | ||
url = https://github.com/OpenZeppelin/openzeppelin-contracts | ||
[submodule "lib/solidity-stringutils"] | ||
path = lib/solidity-stringutils | ||
url = https://github.com/Arachnid/solidity-stringutils |
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[profile.default] | ||
src = "src" | ||
out = "out" | ||
libs = ["lib"] | ||
libs = ["node_modules", "lib"] | ||
build_info = true | ||
extra_output = ["storageLayout"] |
Submodule openzeppelin-contracts
deleted from
932fdd
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 |
---|---|---|
@@ -1,2 +1 @@ | ||
@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/ | ||
openzeppelin-foundry-upgrades/=src/ |
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,84 @@ | ||
const path = require('path'); | ||
const minimatch = require('minimatch'); | ||
|
||
// Files matching these patterns will be ignored unless a rule has `static global = true` | ||
const ignore = ['contracts/mocks/**/*', 'test/**/*']; | ||
|
||
class Base { | ||
constructor(reporter, config, source, fileName) { | ||
this.reporter = reporter; | ||
this.ignored = this.constructor.global || ignore.some(p => minimatch(path.normalize(fileName), p)); | ||
this.ruleId = this.constructor.ruleId; | ||
if (this.ruleId === undefined) { | ||
throw Error('missing ruleId static property'); | ||
} | ||
} | ||
|
||
error(node, message) { | ||
if (!this.ignored) { | ||
this.reporter.error(node, this.ruleId, message); | ||
} | ||
} | ||
} | ||
|
||
module.exports = [ | ||
class extends Base { | ||
static ruleId = 'interface-names'; | ||
|
||
ContractDefinition(node) { | ||
if (node.kind === 'interface' && !/^I[A-Z]/.test(node.name)) { | ||
this.error(node, 'Interface names should have a capital I prefix'); | ||
} | ||
} | ||
}, | ||
|
||
class extends Base { | ||
static ruleId = 'private-variables'; | ||
|
||
VariableDeclaration(node) { | ||
const constantOrImmutable = node.isDeclaredConst || node.isImmutable; | ||
if (node.isStateVar && !constantOrImmutable && node.visibility !== 'private') { | ||
this.error(node, 'State variables must be private'); | ||
} | ||
} | ||
}, | ||
|
||
class extends Base { | ||
static ruleId = 'leading-underscore'; | ||
|
||
VariableDeclaration(node) { | ||
if (node.isDeclaredConst) { | ||
// TODO: expand visibility and fix | ||
if (node.visibility === 'private' && /^_/.test(node.name)) { | ||
this.error(node, 'Constant variables should not have leading underscore'); | ||
} | ||
} else if (node.visibility === 'private' && !/^_/.test(node.name)) { | ||
this.error(node, 'Non-constant private variables must have leading underscore'); | ||
} | ||
} | ||
|
||
FunctionDefinition(node) { | ||
if (node.visibility === 'private' || (node.visibility === 'internal' && node.parent.kind !== 'library')) { | ||
if (!/^_/.test(node.name)) { | ||
this.error(node, 'Private and internal functions must have leading underscore'); | ||
} | ||
} | ||
if (node.visibility === 'internal' && node.parent.kind === 'library') { | ||
if (/^_/.test(node.name)) { | ||
this.error(node, 'Library internal functions should not have leading underscore'); | ||
} | ||
} | ||
} | ||
}, | ||
|
||
// TODO: re-enable and fix | ||
// class extends Base { | ||
// static ruleId = 'no-external-virtual'; | ||
// | ||
// FunctionDefinition(node) { | ||
// if (node.visibility == 'external' && node.isVirtual) { | ||
// this.error(node, 'Functions should not be external and virtual'); | ||
// } | ||
// } | ||
// }, | ||
]; |
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,5 @@ | ||
{ | ||
"name": "solhint-plugin-openzeppelin", | ||
"version": "0.0.0", | ||
"private": true | ||
} |
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 |
---|---|---|
@@ -1 +1,24 @@ | ||
module.exports = require('./lib/openzeppelin-contracts/solhint.config.js'); | ||
const customRules = require('./scripts/solhint-custom'); | ||
|
||
console.log('Using custom rules:', JSON.stringify(customRules, null, 2)); | ||
|
||
const rules = [ | ||
'no-unused-vars', | ||
'const-name-snakecase', | ||
'contract-name-camelcase', | ||
'event-name-camelcase', | ||
'func-name-mixedcase', | ||
'func-param-name-mixedcase', | ||
'modifier-name-mixedcase', | ||
'var-name-mixedcase', | ||
'imports-on-top', | ||
'no-global-import', | ||
...customRules.map(r => `openzeppelin/${r.ruleId}`), | ||
]; | ||
|
||
console.log('Using rules:', JSON.stringify(rules, null, 2)); | ||
|
||
module.exports = { | ||
plugins: ['openzeppelin'], | ||
rules: Object.fromEntries(rules.map(r => [r, 'error'])), | ||
}; |
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