feat(forge lint): disable lints with inline comment #10776
Conversation
This file contains hidden or 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
0xrusowsky
commented
Jun 13, 2025
Good call 👍 |
let's keep the same name style as for |
0xrusowsky
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
0xrusowsky
commented
Jun 16, 2025
Comment on lines
+102
to
+119
| InlineConfigItem::DisableNextItem(lint) => { | ||
| let lints = match validate_ids(&mut invalid_ids, lints, lint, sp) { | ||
| Some(lints) => lints, | ||
| None => continue, | ||
| }; | ||
|
|
||
| let comment_end = sp.hi().to_usize(); | ||
|
|
||
| if let Some(next_item) = NextItemFinder::new(comment_end).find(ast) { | ||
| for lint in lints { | ||
| disabled_ranges.entry(lint).or_default().push(DisabledRange { | ||
| start: next_item.lo().to_usize(), | ||
| end: next_item.hi().to_usize(), | ||
| loose: false, | ||
| }); | ||
| } | ||
| }; | ||
| } |
There was a problem hiding this comment.
@DaniPopes this is the only custom logic regarding InlineConfigItem "identification" (the others mimic your fmt-2 code).
your fmt code seemed to be targeting the next word for the fmt, but in my case i wanted to target the next AST item (fn, contract, etc).
lmk if this makes sense or if i should follow a different approach
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.
ref:
forge lint): create syntax for ignoring a linting rule on a line-level (// forge-lint-ignore: foo-bar-baz) #10769 (comment)Motivation
easily allow disabling lints with inline-config via comments
Implementation
having standardization in mind, i decided to follow the same naming convention as
forge-fmt(and borrowed some code from https://github.com/foundry-rs/foundry/blob/dani/fmt-solar/crates/fmt-2/src/inline_config.rs)because of that, these are the available config options:
forge-lint: disable-next-itemforge-lint: disable-lineforge-lint: disable-next-lineforge-lint: disable-startforge-lint: disable-endunlike when formatting though, devs can also inform the target lints by wrapping their ids in parentheses:
forge-lint: disable-next-line(asm-keccak256)forge-lint: disable-next-line(asm-keccak256, mixed-case-variable)if no lint ids are provided (or "all" is used), all lints will be disabled:
forge-lint: disable-next-line(all)forge-lint: disable-next-line