refactor(linter): add source metadata (#1519)

crates/biome_analyze/src/lib.rs

@@ -36,7 +36,7 @@ pub use crate::registry::{
 };
 pub use crate::rule::{
     CategoryLanguage, FixKind, GroupCategory, GroupLanguage, Rule, RuleAction, RuleDiagnostic,
-    RuleGroup, RuleMeta, RuleMetadata, Source, SourceKind, SuppressAction,
+    RuleGroup, RuleMeta, RuleMetadata, RuleSource, RuleSourceKind, SuppressAction,
 };
 pub use crate::services::{FromServices, MissingServicesDiagnostic, ServiceBag};
 pub use crate::signals::{

crates/biome_analyze/src/rule.rs

@@ -32,9 +32,9 @@ pub struct RuleMetadata {
     /// The kind of fix
     pub fix_kind: Option<FixKind>,
     /// The source URL of the rule
-    pub source: Option<Source>,
+    pub source: Option<RuleSource>,
     /// The source kind of the rule
-    pub source_kind: Option<SourceKind>,
+    pub source_kind: Option<RuleSourceKind>,
 }
 
 #[derive(Debug, Clone, Eq, PartialEq)]
@@ -57,11 +57,15 @@ impl Display for FixKind {
 }
 
 #[derive(Debug, Clone, Eq, PartialEq)]
-pub enum Source {
+pub enum RuleSource {
     /// Rules from [Rust Clippy](https://rust-lang.github.io/rust-clippy/master/index.html)
     Clippy(&'static str),
     /// Rules from [Eslint](https://eslint.org/)
     Eslint(&'static str),
+    /// Rules from [Eslint Plugin Import](https://github.com/import-js/eslint-plugin-import)
+    EslintImport(&'static str),
+    /// Rules from [Eslint Plugin Import Access](https://github.com/uhyo/eslint-plugin-import-access)
+    EslintImportAccess(&'static str),
     /// Rules from [Eslint Plugin Jest](https://github.com/jest-community/eslint-plugin-jest)
     EslintJest(&'static str),
     /// Rules from [Eslint Plugin JSX A11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
@@ -70,38 +74,50 @@ pub enum Source {
     EslintReact(&'static str),
     /// Rules from [Eslint Plugin React Hooks](https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md)
     EslintReactHooks(&'static str),
-    /// Rules from [Typescript Eslint Plugin](https://typescript-eslint.io)
+    /// Rules from [Eslint Plugin Sonar](https://github.com/SonarSource/eslint-plugin-sonarjs)
+    EslintSonarJs(&'static str),
+    /// Rules from [Eslint Plugin Stylistic](https://eslint.style)
+    EslintStylistic(&'static str),
+    /// Rules from [Eslint Plugin Typescript](https://typescript-eslint.io)
     EslintTypeScript(&'static str),
     /// Rules from [Eslint Plugin Unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
     EslintUnicorn(&'static str),
     /// Rules from [Eslint Plugin Mysticatea](https://github.com/mysticatea/eslint-plugin)
     EslintMysticatea(&'static str),
 }
 
-impl Source {
+impl RuleSource {
     pub fn as_rule_name(&self) -> &'static str {
         match self {
-            Self::Clippy(rule_name) => rule_name,
-            Self::Eslint(rule_name) => rule_name,
-            Self::EslintJest(rule_name) => rule_name,
-            Self::EslintJsxA11y(rule_name) => rule_name,
-            Self::EslintReact(rule_name) => rule_name,
-            Self::EslintReactHooks(rule_name) => rule_name,
-            Self::EslintTypeScript(rule_name) => rule_name,
-            Self::EslintUnicorn(rule_name) => rule_name,
-            Self::EslintMysticatea(rule_name) => rule_name,
+            Self::Clippy(rule_name)
+            | Self::Eslint(rule_name)
+            | Self::EslintImport(rule_name)
+            | Self::EslintImportAccess(rule_name)
+            | Self::EslintJest(rule_name)
+            | Self::EslintJsxA11y(rule_name)
+            | Self::EslintReact(rule_name)
+            | Self::EslintReactHooks(rule_name)
+            | Self::EslintTypeScript(rule_name)
+            | Self::EslintSonarJs(rule_name)
+            | Self::EslintStylistic(rule_name)
+            | Self::EslintUnicorn(rule_name)
+            | Self::EslintMysticatea(rule_name) => rule_name,
         }
     }
 
     pub fn as_rule_url(&self) -> String {
         match self {
             Self::Clippy(rule_name) => format!("https://rust-lang.github.io/rust-clippy/master/#/{rule_name}"),
-            Self::Eslint(rule_name) => format!( "https://eslint.org/docs/latest/rules/{rule_name}"),
+            Self::Eslint(rule_name) => format!("https://eslint.org/docs/latest/rules/{rule_name}"),
+            Self::EslintImport(rule_name) => format!("https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/{rule_name}.md"),
+            Self::EslintImportAccess(rule_name) => format!("https://github.com/uhyo/eslint-plugin-import-access/blob/main/docs/rules/{rule_name}.md"),
             Self::EslintJest(rule_name) => format!("https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/{rule_name}.md"),
             Self::EslintJsxA11y(rule_name) => format!("https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/{rule_name}.md"),
             Self::EslintReact(rule_name) => format!("https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/{rule_name}.md"),
             Self::EslintReactHooks(_) =>  "https://github.com/facebook/react/blob/main/packages/eslint-plugin-react-hooks/README.md".to_string(),
             Self::EslintTypeScript(rule_name) => format!("https://typescript-eslint.io/rules/{rule_name}"),
+            Self::EslintSonarJs(rule_name) => format!("https://github.com/SonarSource/eslint-plugin-sonarjs/blob/HEAD/docs/rules/{rule_name}.md"),
+            Self::EslintStylistic(rule_name) => format!("https://eslint.style/rules/default/{rule_name}"),
             Self::EslintUnicorn(rule_name) => format!("https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/{rule_name}.md"),
             Self::EslintMysticatea(rule_name) => format!("https://github.com/mysticatea/eslint-plugin/blob/master/docs/rules/{rule_name}.md"),
         }
@@ -112,9 +128,10 @@ impl Source {
     }
 }
 
-#[derive(Debug, Clone)]
-pub enum SourceKind {
+#[derive(Debug, Default, Clone)]
+pub enum RuleSourceKind {
     /// The rule implements the same logic of the source
+    #[default]
     SameLogic,
     /// The rule deviate of the logic of the source
     Inspired,
@@ -149,12 +166,15 @@ impl RuleMetadata {
         self
     }
 
-    pub const fn source(mut self, source: Source) -> Self {
+    pub const fn source(mut self, source: RuleSource) -> Self {
         self.source = Some(source);
+        //if self.source_kind.is_none() {
+        //    self.source_kind = Some(RuleSourceKind::SameLogic);
+        //}
         self
     }
 
-    pub const fn source_kind(mut self, source_kind: SourceKind) -> Self {
+    pub const fn source_kind(mut self, source_kind: RuleSourceKind) -> Self {
         self.source_kind = Some(source_kind);
         self
     }

crates/biome_js_analyze/src/analyzers/a11y/no_access_key.rs

@@ -1,6 +1,7 @@
 use crate::JsRuleAction;
 use biome_analyze::{
     context::RuleContext, declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic,
+    RuleSource,
 };
 use biome_console::markup;
 use biome_diagnostics::Applicability;
@@ -39,6 +40,7 @@ declare_rule! {
     pub(crate) NoAccessKey {
         version: "1.0.0",
         name: "noAccessKey",
+        source: RuleSource::EslintJsxA11y("no-access-key"),
         recommended: true,
         fix_kind: FixKind::Unsafe,
     }

crates/biome_js_analyze/src/analyzers/a11y/no_auto_focus.rs

@@ -1,6 +1,7 @@
 use crate::JsRuleAction;
 use biome_analyze::{
     context::RuleContext, declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic,
+    RuleSource,
 };
 use biome_console::markup;
 use biome_diagnostics::Applicability;
@@ -59,6 +60,7 @@ declare_rule! {
     pub(crate) NoAutoFocus {
         version: "1.0.0",
         name: "noAutofocus",
+        source: RuleSource::EslintJsxA11y("no-autofocus"),
         recommended: true,
         fix_kind: FixKind::Unsafe,
     }

crates/biome_js_analyze/src/analyzers/a11y/no_blank_target.rs

@@ -1,6 +1,6 @@
 use crate::JsRuleAction;
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_diagnostics::Applicability;
 use biome_js_factory::make::{
@@ -51,6 +51,7 @@ declare_rule! {
     pub(crate) NoBlankTarget {
         version: "1.0.0",
         name: "noBlankTarget",
+        source: RuleSource::EslintJsxA11y("jsx-no-target-blank"),
         recommended: true,
         fix_kind: FixKind::Safe,
     }

crates/biome_js_analyze/src/analyzers/a11y/no_distracting_elements.rs

@@ -1,5 +1,5 @@
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_diagnostics::Applicability;
 use biome_js_syntax::jsx_ext::AnyJsxElement;
@@ -40,6 +40,7 @@ declare_rule! {
     pub(crate) NoDistractingElements {
         version: "1.0.0",
         name: "noDistractingElements",
+        source: RuleSource::EslintJsxA11y("no-distracting-elements"),
         recommended: true,
         fix_kind: FixKind::Unsafe,
     }

crates/biome_js_analyze/src/analyzers/a11y/no_header_scope.rs

@@ -1,5 +1,5 @@
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_diagnostics::Applicability;
 use biome_js_syntax::jsx_ext::AnyJsxElement;
@@ -40,6 +40,7 @@ declare_rule! {
     pub(crate) NoHeaderScope {
         version: "1.0.0",
         name: "noHeaderScope",
+        source: RuleSource::EslintJsxA11y("scope"),
         recommended: true,
         fix_kind: FixKind::Unsafe,
     }

crates/biome_js_analyze/src/analyzers/a11y/no_redundant_alt.rs

@@ -1,5 +1,5 @@
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_js_syntax::jsx_ext::AnyJsxElement;
 use biome_js_syntax::{
@@ -42,6 +42,7 @@ declare_rule! {
     pub(crate) NoRedundantAlt {
         version: "1.0.0",
         name: "noRedundantAlt",
+        source: RuleSource::EslintJsxA11y("no-redundant-roles"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_alt_text.rs

@@ -1,4 +1,4 @@
-use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::{fmt::Display, fmt::Formatter, markup};
 use biome_js_syntax::{jsx_ext::AnyJsxElement, TextRange};
 use biome_rowan::AstNode;
@@ -46,6 +46,7 @@ declare_rule! {
     pub(crate) UseAltText {
         version: "1.0.0",
         name: "useAltText",
+        source: RuleSource::EslintJsxA11y("alt-text"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_anchor_content.rs

@@ -1,5 +1,5 @@
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_diagnostics::Applicability;
 use biome_js_syntax::jsx_ext::AnyJsxElement;
@@ -67,6 +67,7 @@ declare_rule! {
     pub(crate) UseAnchorContent {
         version: "1.0.0",
         name: "useAnchorContent",
+        source: RuleSource::EslintJsxA11y("anchor-has-content"),
         recommended: true,
         fix_kind: FixKind::Unsafe,
     }

crates/biome_js_analyze/src/analyzers/a11y/use_heading_content.rs

@@ -1,4 +1,4 @@
-use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_js_syntax::{jsx_ext::AnyJsxElement, JsxElement};
 use biome_rowan::AstNode;
@@ -47,6 +47,7 @@ declare_rule! {
     pub(crate) UseHeadingContent {
         version: "1.0.0",
         name: "useHeadingContent",
+        source: RuleSource::EslintJsxA11y("heading-has-content"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_html_lang.rs

@@ -1,4 +1,4 @@
-use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_js_syntax::{jsx_ext::AnyJsxElement, TextRange};
 use biome_rowan::AstNode;
@@ -55,6 +55,7 @@ declare_rule! {
     pub(crate) UseHtmlLang {
         version: "1.0.0",
         name: "useHtmlLang",
+        source: RuleSource::EslintJsxA11y("html-has-lang"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_iframe_title.rs

@@ -1,4 +1,4 @@
-use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_js_syntax::jsx_ext::AnyJsxElement;
 use biome_rowan::AstNode;
@@ -61,6 +61,7 @@ declare_rule! {
     pub(crate) UseIframeTitle {
         version: "1.0.0",
         name: "useIframeTitle",
+        source: RuleSource::EslintJsxA11y("iframe-has-title"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_key_with_click_events.rs

@@ -1,4 +1,4 @@
-use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{context::RuleContext, declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_js_syntax::{jsx_ext::AnyJsxElement, AnyJsxAttribute, AnyJsxElementName};
 use biome_rowan::AstNode;
@@ -59,6 +59,7 @@ declare_rule! {
     pub(crate) UseKeyWithClickEvents {
         version: "1.0.0",
         name: "useKeyWithClickEvents",
+        source: RuleSource::EslintJsxA11y("click-events-have-key-events"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_key_with_mouse_events.rs

@@ -1,6 +1,6 @@
 use crate::semantic_services::Semantic;
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, Rule, RuleDiagnostic, RuleSource};
 use biome_console::{markup, MarkupBuf};
 use biome_js_syntax::jsx_ext::AnyJsxElement;
 use biome_rowan::AstNode;
@@ -42,6 +42,7 @@ declare_rule! {
     pub(crate) UseKeyWithMouseEvents {
         version: "1.0.0",
         name: "useKeyWithMouseEvents",
+        source: RuleSource::EslintJsxA11y("mouse-events-have-key-events"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_media_caption.rs

@@ -1,5 +1,5 @@
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::markup;
 use biome_js_syntax::jsx_ext::AnyJsxElement;
 use biome_js_syntax::{AnyJsxChild, JsxElement, TextRange};
@@ -8,8 +8,6 @@ use biome_rowan::AstNode;
 declare_rule! {
     /// Enforces that `audio` and `video` elements must have a `track` for captions.
     ///
-    /// **ESLint Equivalent:** [media-has-caption](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/media-has-caption.md)
-    ///
     /// ## Examples
     ///
     /// ### Invalid
@@ -35,6 +33,7 @@ declare_rule! {
     pub(crate) UseMediaCaption {
         version: "1.0.0",
         name: "useMediaCaption",
+        source: RuleSource::EslintJsxA11y("media-has-caption"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/a11y/use_valid_anchor.rs

@@ -1,5 +1,5 @@
 use biome_analyze::context::RuleContext;
-use biome_analyze::{declare_rule, Ast, Rule, RuleDiagnostic};
+use biome_analyze::{declare_rule, Ast, Rule, RuleDiagnostic, RuleSource};
 use biome_console::{markup, MarkupBuf};
 use biome_js_syntax::jsx_ext::AnyJsxElement;
 use biome_rowan::{AstNode, TextRange};
@@ -66,6 +66,7 @@ declare_rule! {
     pub(crate) UseValidAnchor {
         version: "1.0.0",
         name: "useValidAnchor",
+        source: RuleSource::EslintJsxA11y("anchor-is-valid"),
         recommended: true,
     }
 }

crates/biome_js_analyze/src/analyzers/complexity/no_excessive_cognitive_complexity.rs

@@ -1,6 +1,6 @@
 use biome_analyze::{
     context::RuleContext, declare_rule, AddVisitor, Phases, QueryMatch, Queryable, Rule,
-    RuleDiagnostic, ServiceBag, Visitor, VisitorContext,
+    RuleDiagnostic, RuleSource, ServiceBag, Visitor, VisitorContext,
 };
 use biome_console::markup;
 use biome_deserialize::{
@@ -37,10 +37,6 @@ declare_rule! {
     /// The complexity score is calculated based on the Cognitive Complexity
     /// algorithm: http://redirect.sonarsource.com/doc/cognitive-complexity.html
     ///
-    /// Source:
-    ///
-    /// * https://github.com/SonarSource/eslint-plugin-sonarjs/blob/HEAD/docs/rules/cognitive-complexity.md
-    ///
     /// ## Examples
     ///
     /// ### Invalid
@@ -79,6 +75,7 @@ declare_rule! {
     pub(crate) NoExcessiveCognitiveComplexity {
         version: "1.0.0",
         name: "noExcessiveCognitiveComplexity",
+        source: RuleSource::EslintSonarJs("cognitive-complexity"),
         recommended: false,
     }
 }