Skip to content

Commit 20e20a7

Browse files
committed
update config and remove docgen module for package.json
1 parent b372b1b commit 20e20a7

7 files changed

Lines changed: 21 additions & 170 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ docs/
1212

1313
# Dotenv file
1414
.env
15+
# node_modules
16+
node_modules/
17+

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Contributing Guidelines
22

3-
There are many ways to contribute to RuleEngine Contracts.
3+
There are many ways to contribute to Rules Contracts.
4+
5+
## Development branch
6+
7+
If you want to propose some improvement to the codebase, use the current development branch `dev` to perform the modification.
48

59
## Opening an issue
610

doc/TOOLCHAIN.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -131,21 +131,9 @@ slither . --checklist --filter-paths "openzeppelin-contracts|test|CMTAT|forge-s
131131

132132
## Code style guidelines
133133

134-
We use the following tools to ensure consistent coding style:
134+
We use `Foundry` to perform code style guidelines
135135

136-
[Prettier](https://github.com/prettier-solidity/prettier-plugin-solidity)
137-
138-
```
139-
npm run-script lint:sol:prettier
140-
```
141-
142-
[Ethlint / Solium](https://github.com/duaraghav8/Ethlint)
143-
144-
```
145-
npm run-script lint:sol
146-
npm run-script lint:sol:fix
147-
npm run-script lint:sol:test
148-
npm run-script lint:sol:test:fix
136+
```bash
137+
forge fmt
149138
```
150139

151-
The related components can be installed with `npm install` (see [package.json](./package.json)).

foundry.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
[profile.default]
2-
src = "src"
3-
out = "out"
4-
libs = ["lib"]
2+
solc = "0.8.30"
3+
src = 'src'
4+
out = 'out'
5+
libs = ['lib']
6+
optimizer = true
7+
optimizer_runs = 200
8+
evm_version = 'prague'
59

610
# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

hardhat.config.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
/** @type import('hardhat/config').HardhatUserConfig */
22
require("@nomicfoundation/hardhat-foundry");
3-
require('solidity-docgen');
43
module.exports = {
5-
solidity: "0.8.27",
4+
solidity: "0.8.30",
65
settings: {
76
optimizer: {
87
enabled: true,
98
runs: 200
109
},
11-
evmVersion:"cancun"
10+
evmVersion:"prague"
1211
}
1312
};

package-lock.json

Lines changed: 1 addition & 147 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
"ethlint": "^1.2.5",
2020
"prettier-plugin-solidity": "^1.0.0-rc.1",
2121
"sol2uml": "^2.5.20",
22-
"solidity-docgen": "^0.6.0-beta.35",
2322
"surya": "^0.4.6"
2423
}
2524
}

0 commit comments

Comments
 (0)