refactor: Make tags strongly typed (#1367)

* refactor: Make tags strongly typed * fmt
denoland · Nov 29, 2024 · 3184b40 · 3184b40
1 parent 718c6fb
commit 3184b40
Show file tree

Hide file tree

Showing 95 changed files with 330 additions and 187 deletions.
diff --git a/examples/dlint/rules.rs b/examples/dlint/rules.rs
@@ -2,13 +2,14 @@
 
 use crate::color::colorize_markdown;
 use deno_lint::rules::get_all_rules;
+use deno_lint::tags;
 use serde::Serialize;
 
-#[derive(Clone, Copy, Serialize)]
+#[derive(Clone, Serialize)]
 pub struct Rule {
   code: &'static str,
   docs: &'static str,
-  tags: &'static [&'static str],
+  tags: Vec<&'static str>,
 }
 
 pub fn get_all_rules_metadata() -> Vec<Rule> {
@@ -17,7 +18,7 @@ pub fn get_all_rules_metadata() -> Vec<Rule> {
     .map(|rule| Rule {
       code: rule.code(),
       docs: rule.docs(),
-      tags: rule.tags(),
+      tags: rule.tags().iter().map(|tag| tag.display()).collect(),
     })
     .collect()
 }
@@ -89,7 +90,7 @@ impl RuleFormatter for PrettyFormatter {
         list.push("Available rules (trailing ✔️ mark indicates it is included in the recommended rule set):".to_string());
         list.extend(rules.iter().map(|r| {
           let mut s = format!(" - {}", r.code);
-          if r.tags.contains(&"recommended") {
+          if r.tags.contains(&tags::RECOMMENDED.display()) {
             s += " ✔️";
           }
           s

diff --git a/src/lib.rs b/src/lib.rs
@@ -22,6 +22,7 @@ pub mod linter;
 mod performance_mark;
 pub mod rules;
 pub mod swc_util;
+pub mod tags;
 
 pub use deno_ast::view::Program;
 pub use deno_ast::view::ProgramRef;

diff --git a/src/rules.rs b/src/rules.rs
@@ -1,6 +1,8 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
 use crate::context::Context;
+use crate::tags;
+use crate::tags::Tags;
 use crate::Program;
 use crate::ProgramRef;
 use std::cmp::Ordering;
@@ -132,7 +134,7 @@ pub trait LintRule: std::fmt::Debug + Send + Sync {
   fn code(&self) -> &'static str;
 
   /// Returns the tags this rule belongs to, e.g. `recommended`
-  fn tags(&self) -> &'static [&'static str] {
+  fn tags(&self) -> Tags {
     &[]
   }
 
@@ -168,7 +170,7 @@ pub fn recommended_rules(
 ) -> Vec<Box<dyn LintRule>> {
   all_rules
     .into_iter()
-    .filter(|r| r.tags().contains(&"recommended"))
+    .filter(|r| r.tags().contains(&tags::RECOMMENDED))
     .collect()
 }
 
@@ -367,6 +369,8 @@ fn get_all_rules_raw() -> Vec<Box<dyn LintRule>> {
 mod tests {
   use std::sync::Arc;
 
+  use crate::tags;
+
   use super::*;
 
   #[test]
@@ -474,7 +478,7 @@ mod tests {
         let rules = Arc::clone(&rules);
         spawn(move || {
           for rule in rules.iter() {
-            assert!(rule.tags().contains(&"recommended"));
+            assert!(rule.tags().contains(&tags::RECOMMENDED));
           }
         })
       })

diff --git a/src/rules/adjacent_overload_signatures.rs b/src/rules/adjacent_overload_signatures.rs
@@ -3,6 +3,7 @@
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
 use crate::swc_util::StringRepr;
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::{view as ast_view, SourceRanged};
 use derive_more::Display;
@@ -26,8 +27,8 @@ enum AdjacentOverloadSignaturesHint {
 }
 
 impl LintRule for AdjacentOverloadSignatures {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/ban_ts_comment.rs b/src/rules/ban_ts_comment.rs
@@ -1,6 +1,8 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
 use super::{Context, LintRule};
+use crate::tags;
+use crate::tags::Tags;
 use crate::Program;
 use deno_ast::swc::common::comments::Comment;
 use deno_ast::swc::common::comments::CommentKind;
@@ -68,8 +70,8 @@ impl BanTsComment {
 }
 
 impl LintRule for BanTsComment {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/ban_types.rs b/src/rules/ban_types.rs
@@ -2,6 +2,7 @@
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::view::TsEntityName;
 use deno_ast::{view as ast_view, SourceRanged};
@@ -74,8 +75,8 @@ impl TryFrom<&str> for BannedType {
 }
 
 impl LintRule for BanTypes {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/ban_unknown_rule_code.rs b/src/rules/ban_unknown_rule_code.rs
@@ -1,7 +1,10 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
 use super::{Context, LintRule};
-use crate::Program;
+use crate::{
+  tags::{self, Tags},
+  Program,
+};
 
 /// This is a dummy struct just for having the docs.
 /// The actual implementation resides in [`Context`].
@@ -11,8 +14,8 @@ pub struct BanUnknownRuleCode;
 pub(crate) const CODE: &str = "ban-unknown-rule-code";
 
 impl LintRule for BanUnknownRuleCode {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/ban_untagged_ignore.rs b/src/rules/ban_untagged_ignore.rs
@@ -1,7 +1,10 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
 use super::{Context, LintRule};
-use crate::Program;
+use crate::{
+  tags::{self, Tags},
+  Program,
+};
 use deno_ast::SourceRange;
 
 #[derive(Debug)]
@@ -10,8 +13,8 @@ pub struct BanUntaggedIgnore;
 const CODE: &str = "ban-untagged-ignore";
 
 impl LintRule for BanUntaggedIgnore {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/ban_unused_ignore.rs b/src/rules/ban_unused_ignore.rs
@@ -1,16 +1,19 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
 use super::{Context, LintRule};
-use crate::Program;
+use crate::{
+  tags::{self, Tags},
+  Program,
+};
 
 /// This is a dummy struct just for having the docs.
 /// The actual implementation resides in [`Context`].
 #[derive(Debug)]
 pub struct BanUnusedIgnore;
 
 impl LintRule for BanUnusedIgnore {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/camelcase.rs b/src/rules/camelcase.rs
@@ -3,6 +3,7 @@
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
 use crate::swc_util::StringRepr;
+use crate::tags::Tags;
 
 use deno_ast::view::{Node, NodeKind, NodeTrait};
 use deno_ast::{view as ast_view, SourceRange, SourceRanged};
@@ -16,7 +17,7 @@ pub struct Camelcase;
 const CODE: &str = "camelcase";
 
 impl LintRule for Camelcase {
-  fn tags(&self) -> &'static [&'static str] {
+  fn tags(&self) -> Tags {
     &[]
   }
 

diff --git a/src/rules/constructor_super.rs b/src/rules/constructor_super.rs
@@ -2,6 +2,7 @@
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::{view as ast_view, SourceRange, SourceRanged};
 use if_chain::if_chain;
@@ -14,8 +15,8 @@ const CODE: &str = "constructor-super";
 // This rule currently differs from the ESlint implementation
 // as there is currently no way of handling code paths in dlint
 impl LintRule for ConstructorSuper {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/for_direction.rs b/src/rules/for_direction.rs
@@ -2,6 +2,7 @@
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::swc::ast::AssignOp;
 use deno_ast::swc::ast::BinaryOp;
@@ -15,8 +16,8 @@ use deno_ast::{view as ast_view, SourceRanged};
 pub struct ForDirection;
 
 impl LintRule for ForDirection {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/fresh_handler_export.rs b/src/rules/fresh_handler_export.rs
@@ -2,6 +2,7 @@
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 
 use deno_ast::view::{Decl, Pat, Program};
 use deno_ast::SourceRanged;
@@ -15,8 +16,8 @@ const MESSAGE: &str =
 const HINT: &str = "Did you mean \"handler\"?";
 
 impl LintRule for FreshHandlerExport {
-  fn tags(&self) -> &'static [&'static str] {
-    &["fresh"]
+  fn tags(&self) -> Tags {
+    &[tags::FRESH]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/fresh_server_event_handlers.rs b/src/rules/fresh_server_event_handlers.rs
@@ -2,6 +2,7 @@
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 
 use deno_ast::view::{
   Expr, JSXAttrName, JSXAttrValue, JSXElementName, JSXExpr, Program,
@@ -18,8 +19,8 @@ const HINT: &str =
   "Remove this property or turn the enclosing component into an island";
 
 impl LintRule for FreshServerEventHandlers {
-  fn tags(&self) -> &'static [&'static str] {
-    &["fresh"]
+  fn tags(&self) -> Tags {
+    &[tags::FRESH]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/getter_return.rs b/src/rules/getter_return.rs
@@ -3,6 +3,7 @@
 use super::program_ref;
 use super::{Context, LintRule};
 use crate::swc_util::StringRepr;
+use crate::tags::{self, Tags};
 use crate::Program;
 use crate::ProgramRef;
 use deno_ast::swc::ast::{
@@ -39,8 +40,8 @@ enum GetterReturnHint {
 }
 
 impl LintRule for GetterReturn {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/jsx_curly_braces.rs b/src/rules/jsx_curly_braces.rs
@@ -3,6 +3,7 @@
 use super::{Context, LintRule};
 use crate::diagnostic::{LintFix, LintFixChange};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::view::{
   Expr, JSXAttr, JSXAttrValue, JSXElement, JSXElementChild, JSXExpr, Lit,
@@ -16,8 +17,8 @@ pub struct JSXCurlyBraces;
 const CODE: &str = "jsx-curly-braces";
 
 impl LintRule for JSXCurlyBraces {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended", "react", "jsx"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED, tags::REACT, tags::JSX]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/jsx_no_children_prop.rs b/src/rules/jsx_no_children_prop.rs
@@ -2,6 +2,7 @@
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::view::{JSXAttrName, JSXAttrOrSpread, JSXOpeningElement};
 use deno_ast::SourceRanged;
@@ -12,8 +13,8 @@ pub struct JSXNoChildrenProp;
 const CODE: &str = "jsx-no-children-prop";
 
 impl LintRule for JSXNoChildrenProp {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended", "react", "jsx", "fresh"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED, tags::REACT, tags::JSX, tags::FRESH]
   }
 
   fn code(&self) -> &'static str {

diff --git a/src/rules/jsx_no_duplicate_props.rs b/src/rules/jsx_no_duplicate_props.rs
@@ -4,6 +4,7 @@ use std::collections::HashSet;
 
 use super::{Context, LintRule};
 use crate::handler::{Handler, Traverse};
+use crate::tags::{self, Tags};
 use crate::Program;
 use deno_ast::view::{JSXAttrName, JSXAttrOrSpread, JSXOpeningElement};
 use deno_ast::SourceRanged;
@@ -14,8 +15,8 @@ pub struct JSXNoDuplicateProps;
 const CODE: &str = "jsx-no-duplicate-props";
 
 impl LintRule for JSXNoDuplicateProps {
-  fn tags(&self) -> &'static [&'static str] {
-    &["recommended", "react", "jsx"]
+  fn tags(&self) -> Tags {
+    &[tags::RECOMMENDED, tags::REACT, tags::JSX]
   }
 
   fn code(&self) -> &'static str {