-
Notifications
You must be signed in to change notification settings - Fork 432
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Linter: Split ink_linting
into two libraries
#2032
Conversation
Split `ink_linting` to `ink_linting_mandatory` and `ink_linting`. Mandatory lints will be integrated in the `cargo-build` build process in use-ink/cargo-contract#1412. Extra lints are optional and could be run by the contract developer to highlight possible issues with secure coding style and to check the compliance with best practices. For more information about this design decision, see: use-ink/cargo-contract#1412 (comment). Closes use-ink#2006
🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑These are the results when building the
Link to the run | Last update: Sun Dec 24 14:26:22 CET 2023 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2032 +/- ##
==========================================
- Coverage 53.85% 53.65% -0.20%
==========================================
Files 221 221
Lines 6958 6965 +7
Branches 3068 3066 -2
==========================================
- Hits 3747 3737 -10
- Misses 3211 3228 +17 ☔ View full report in Codecov by Sentry. |
ink_linting was splitted up to two libraries in use-ink/ink#2032
This is necessary, because the lockfile needs to be updated since we run build with a different `rust-toolchain.yml`.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
* feat(linter): Automate the generation of documentation for ink-docs This commit introduces a script that extracts documentation from `ink_linting` lints and saves it to the local [ink-docs](https://github.com/paritytech/ink-docs) directory. The markdown formatting of the lints was also improved. * chore(script): Update after #2032 is merged * chore(linter): Wrap in docstring to improve appearance * Update scripts/generate_linter_docs.sh --------- Co-authored-by: Michael Müller <mich@elmueller.net>
Summary
Closes #2006
cargo-contract
orpallet-contracts
?Split
ink_linting
toink_linting_mandatory
andink_linting
.Description
Mandatory lints will be integrated in the
cargo-build
build process in use-ink/cargo-contract#1412.Extra lints are optional and could be run by the contract developer to highlight possible issues with secure coding style and to check the compliance with best practices.
For more information about this design decision, see: use-ink/cargo-contract#1412 (comment).
Checklist before requesting a review
CHANGELOG.md