feat(forge lint): disable lints with inline comment #10776
Conversation
Good call 👍 |
let's keep the same name style as for |
crates/lint/src/inline_config.rs
Outdated
| 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
crates/lint/src/inline_config.rs
Outdated
|
|
||
| match item { | ||
| InlineConfigItem::DisableNextItem(lint) => { | ||
| let lints = match validate_ids(&mut invalid_ids, lints, lint, sp) { |
There was a problem hiding this comment.
can we move this to InlineConfigItem::parse? This is specific to the inline config parser not the disabled ranges. And this way we don't need to have 2 separate error handling in parse_inline_config
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