chore: delete Husky configuration
build: remove unused Node.js deps chore: delete Commitlint configuration chore: delete unneeded ".solhintignore" file chore: delete Lint Staged config docs: delete "Conventional Commits" section in README docs: delete "Git Hooks" section in README docs: update README with latest set-up
This commit is contained in:
parent
fa0aa1cc7d
commit
be349dae78
|
@ -1,2 +0,0 @@
|
||||||
extends:
|
|
||||||
- "@commitlint/config-conventional"
|
|
|
@ -1,4 +0,0 @@
|
||||||
"*.{json,md,yml}":
|
|
||||||
- prettier --write
|
|
||||||
"*.sol":
|
|
||||||
- forge fmt
|
|
|
@ -1,3 +0,0 @@
|
||||||
# directories
|
|
||||||
**/lib
|
|
||||||
**/node_modules
|
|
15
README.md
15
README.md
|
@ -50,13 +50,10 @@ interested in reading the [Writing Tests](https://book.getfoundry.sh/forge/writi
|
||||||
This template comes with sensible default configurations in the following files:
|
This template comes with sensible default configurations in the following files:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
├── .commitlintrc.yml
|
|
||||||
├── .editorconfig
|
├── .editorconfig
|
||||||
├── .gitignore
|
├── .gitignore
|
||||||
├── .lintstagedrc.yml
|
|
||||||
├── .prettierignore
|
├── .prettierignore
|
||||||
├── .prettierrc.yml
|
├── .prettierrc.yml
|
||||||
├── .solhintignore
|
|
||||||
├── .solhint.json
|
├── .solhint.json
|
||||||
├── .yarnrc.yml
|
├── .yarnrc.yml
|
||||||
├── foundry.toml
|
├── foundry.toml
|
||||||
|
@ -78,18 +75,6 @@ request made to the `main` branch.
|
||||||
|
|
||||||
You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.yml).
|
You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.yml).
|
||||||
|
|
||||||
### Conventional Commits
|
|
||||||
|
|
||||||
This template enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard for git commit
|
|
||||||
messages. This is a lightweight convention that creates an explicit commit history, which makes it easier to write
|
|
||||||
automated tools on top of.
|
|
||||||
|
|
||||||
### Git Hooks
|
|
||||||
|
|
||||||
This template uses [Husky](https://github.com/typicode/husky) to run automated checks on commit messages, and
|
|
||||||
[Lint Staged](https://github.com/okonet/lint-staged) to automatically format the code with Forge and Prettier when
|
|
||||||
making a git commit.
|
|
||||||
|
|
||||||
## Writing Tests
|
## Writing Tests
|
||||||
|
|
||||||
To write a new test contract, you start by importing [PRBTest](https://github.com/PaulRBerg/prb-test) and inherit from
|
To write a new test contract, you start by importing [PRBTest](https://github.com/PaulRBerg/prb-test) and inherit from
|
||||||
|
|
|
@ -7,12 +7,6 @@
|
||||||
"url": "https://github.com/paulrberg"
|
"url": "https://github.com/paulrberg"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "^17.4.4",
|
|
||||||
"@commitlint/config-conventional": "^17.4.4",
|
|
||||||
"commitizen": "^4.3.0",
|
|
||||||
"cz-conventional-changelog": "^3.3.0",
|
|
||||||
"husky": "^8.0.3",
|
|
||||||
"lint-staged": "^13.1.2",
|
|
||||||
"prettier": "^2.8.4",
|
"prettier": "^2.8.4",
|
||||||
"rimraf": "^4.1.2",
|
"rimraf": "^4.1.2",
|
||||||
"solhint": "^3.4.0"
|
"solhint": "^3.4.0"
|
||||||
|
@ -32,7 +26,6 @@
|
||||||
"clean": "rimraf cache out",
|
"clean": "rimraf cache out",
|
||||||
"lint": "yarn lint:sol && yarn prettier:check",
|
"lint": "yarn lint:sol && yarn prettier:check",
|
||||||
"lint:sol": "forge fmt --check && yarn solhint \"{script,src,test}/**/*.sol\"",
|
"lint:sol": "forge fmt --check && yarn solhint \"{script,src,test}/**/*.sol\"",
|
||||||
"postinstall": "husky install",
|
|
||||||
"prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
|
"prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
|
||||||
"prettier:write": "prettier --write \"**/*.{json,md,yml}\""
|
"prettier:write": "prettier --write \"**/*.{json,md,yml}\""
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue