Skip to content

docs(linter): note which rules require type info to run on rule page #13675

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

Merged
graphite-app merged 1 commit into from
Sep 11, 2025
Merged

docs(linter): note which rules require type info to run on rule page #13675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions crates/oxc_linter/src/table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ pub struct RuleTableRow {

pub turned_on_by_default: bool,
pub autofix: RuleFixMeta,
pub is_tsgolint_rule: bool,
}

impl Default for RuleTable {
Expand Down Expand Up @@ -65,6 +66,7 @@ impl RuleTable {
category: rule.category(),
turned_on_by_default: default_rules.contains(name),
autofix: rule.fix(),
is_tsgolint_rule: rule.is_tsgolint_rule(),
}
})
.collect::<Vec<_>>();
Expand Down
8 changes: 8 additions & 0 deletions tasks/website/src/linter/rules/doc_page.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ impl Context {
turned_on_by_default,
autofix,
category,
is_tsgolint_rule,
} = rule;
let resolved =
schema.as_ref().map(|schema| self.schemas.dereference(schema).unwrap_or(schema));
Expand Down Expand Up @@ -71,6 +72,13 @@ const source = `{}`;
p.writeln(r#"<span class="emoji">✅</span> This rule is turned on by default."#)
})?;
}
if *is_tsgolint_rule {
p.Alert(r#"type="info""#, |p| {
p.writeln(
r#"<span class="emoji">💭</span> This rule requires <a href="https://oxc.rs/docs/guide/usage/linter/type-aware.html" target="_blank" rel="noreferrer">type information</a>."#
)
})?;
}

if let Some(emoji) = autofix.emoji() {
p.Alert(r#"class="fix" type="info""#, |p| {
Expand Down
Loading