ci: use lintspec instead of natspec-smells #98
Conversation
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
0xJabberwock
requested changes
Mar 7, 2025
0xGorilla
reviewed
Mar 8, 2025
| @@ -17,7 +17,7 @@ | |||
| "deploy:sepolia": "bash -c 'source .env && forge script Deploy --rpc-url $SEPOLIA_RPC --account $SEPOLIA_DEPLOYER_NAME --broadcast --verify --chain sepolia -vvvvv'", | |||
| "lint:check": "yarn lint:sol && forge fmt --check", | |||
| "lint:fix": "sort-package-json && forge fmt && yarn lint:sol --fix", | |||
| "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js", | |||
| "lint:natspec": "lintspec src -f variable", | |||
There was a problem hiding this comment.
how come you are using lintspec here without adding it to the package.json? I believe the dependency is missing, I don't recommend expecting people to instal it globally
There was a problem hiding this comment.
lintspec is not distributed via npm. CI installs it via a specific action for cargo packages, and I modified the README to instruct users to install it globally via cargo. I think this is acceptable given it's what we already do for bulloak. Other alternatives are:
- push to get lintspec released on npm (should be possible to distribute a binary I think)
- migrate the entire boilerplate to use nix instead of npm?
0xJabberwock
approved these changes
Mar 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is part of the soft-deprecation of natspec-smells started in defi-wonderland/natspec-smells#67