Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[eradicate] Better detection of IntelliJ language injection comments (ERA001) #14094

Merged
merged 11 commits into from
Nov 6, 2024
Merged

[eradicate] Better detection of IntelliJ language injection comments (ERA001) #14094

Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fe28cdd
Better detection of IntelliJ language injection comments
InSyncWithFoo Nov 4, 2024
4ce89f2
Remove unnecessary non-capturing group
InSyncWithFoo Nov 4, 2024
8794047
Move `^` to a more prominent place
InSyncWithFoo Nov 4, 2024
81f536f
Sort allowlist by case sensitivity
InSyncWithFoo Nov 4, 2024
219a39c
Add missing operator
InSyncWithFoo Nov 4, 2024
683ebc7
Preserve old behaviour for "unknown case sensitivity" entries, reformat
InSyncWithFoo Nov 4, 2024
20d852f
Move `mypy` to "case sensitive", add `fmt: skip`
InSyncWithFoo Nov 4, 2024
5dcbdf0
Remove unnecessary group
InSyncWithFoo Nov 4, 2024
5f0dcc3
`region`/`endregion` are case sensitive
InSyncWithFoo Nov 5, 2024
30eff3f
Add some more tests for `language`'s case sensitivity
InSyncWithFoo Nov 5, 2024
6c89dd7
Formatting
InSyncWithFoo Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 62 additions & 6 deletions crates/ruff_linter/src/rules/eradicate/detection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,43 @@ static CODE_INDICATORS: LazyLock<AhoCorasick> = LazyLock::new(|| {

static ALLOWLIST_REGEX: LazyLock<Regex> = LazyLock::new(|| {
Regex::new(
r"^(?i)(?:pylint|pyright|noqa|nosec|region|endregion|type:\s*ignore|fmt:\s*(on|off)|isort:\s*(on|off|skip|skip_file|split|dont-add-imports(:\s*\[.*?])?)|mypy:|SPDX-License-Identifier:|language=[a-zA-Z](?: ?[-_.a-zA-Z0-9]+)+(?:\s+prefix=\S+)?(?:\s+suffix=\S+)?|(?:en)?coding[:=][ \t]*([-_.a-zA-Z0-9]+))",
).unwrap()
r"(?x)
^
(?:
InSyncWithFoo marked this conversation as resolved.
Show resolved Hide resolved
# Case-sensitive
pyright
| mypy:
| type:\s*ignore
| SPDX-License-Identifier:
| fmt:\s*(on|off|skip)

# Case-insensitive
| (?i:
noqa
)

# Unknown case sensitivity
| (?i:
pylint
| nosec
| region|endregion
| isort:\s*(on|off|skip|skip_file|split|dont-add-imports(:\s*\[.*?])?)
| (?:en)?coding[:=][\x20\t]*([-_.A-Z0-9]+)
)

# IntelliJ language injection comments:
# * `language` must be lowercase.
# * No spaces around `=`.
# * Language IDs as used in comments must have no spaces,
# though to IntelliJ they can be anything.
# * May optionally contain `prefix=` and/or `suffix=`,
# not declared here since we use `.is_match()`.
| language=[-_.a-zA-Z0-9]+

)
",
)
.unwrap()
});

static HASH_NUMBER: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"#\d").unwrap());
Expand Down Expand Up @@ -299,17 +334,38 @@ mod tests {

#[test]
fn comment_contains_language_injection() {
assert!(comment_contains_code("# language=123", &[]));
// Unreasonable language IDs, possibly literals
assert!(comment_contains_code("# language=\"pt\"", &[]));
assert!(comment_contains_code("# language='en'", &[]));

assert!(!comment_contains_code("# language=xml", &[]));
// Spaces around equal sign
assert!(comment_contains_code("# language =xml", &[]));
assert!(comment_contains_code("# language= html", &[]));
assert!(comment_contains_code("# language = RegExp", &[]));

// Leading whitespace
assert!(!comment_contains_code("#language=CSS", &[]));
assert!(!comment_contains_code("# \t language=C++", &[]));

// Human language false negatives
assert!(!comment_contains_code("# language=en", &[]));
assert!(!comment_contains_code("# language=en-US", &[]));

// Casing (fine because such IDs cannot be validated)
assert!(!comment_contains_code("# language=PytHoN", &[]));
assert!(!comment_contains_code("# language=jaVaScrIpt", &[]));

// Space within ID (fine because `Shell` is considered the ID)
assert!(!comment_contains_code("# language=Shell Script", &[]));

// With prefix and/or suffix
assert!(!comment_contains_code("# language=HTML prefix=<body>", &[]));
assert!(!comment_contains_code(
"# language=HTML prefix=<body> suffix=</body>",
r"# language=Requirements suffix=\n",
&[]
));
assert!(!comment_contains_code(
"# language=ecma script level 4",
"language=javascript prefix=(function(){ suffix=})()",
&[]
));
}
Expand Down
Loading