Add LintRule::docs() and LintDiagnostic::hint (denoland#343)

kitsonk · Sep 29, 2020 · 8167501 · 8167501
1 parent 0c37124
commit 8167501
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/src/diagnostic.rs b/src/diagnostic.rs
@@ -36,4 +36,5 @@ pub struct LintDiagnostic {
   pub filename: String,
   pub message: String,
   pub code: String,
+  pub hint: Option<String>,
 }
diff --git a/src/linter.rs b/src/linter.rs
@@ -59,6 +59,7 @@ impl Context {
       filename: self.file_name.clone(),
       message: message.to_string(),
       code: code.to_string(),
+      hint: None,
     };
 
     let time_end = Instant::now();

diff --git a/src/rules/mod.rs b/src/rules/mod.rs
@@ -94,6 +94,9 @@ pub trait LintRule {
     module: &swc_ecmascript::ast::Module,
   );
   fn code(&self) -> &'static str;
+  fn docs(&self) -> &'static str {
+    ""
+  }
 }
 
 pub fn get_recommended_rules() -> Vec<Box<dyn LintRule>> {