From 4a447bca4f7bd1af2f3df654b06cf8a010fc17b2 Mon Sep 17 00:00:00 2001
From: Boshen <boshenc@gmail.com>
Date: Tue, 28 Mar 2023 21:44:44 +0800
Subject: [PATCH] feat(linter): add a simple linter example

closes #216
---
 crates/oxc_linter/examples/linter.rs | 92 ++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 crates/oxc_linter/examples/linter.rs

diff --git a/crates/oxc_linter/examples/linter.rs b/crates/oxc_linter/examples/linter.rs
new file mode 100644
index 000000000..966bcc0bd
--- /dev/null
+++ b/crates/oxc_linter/examples/linter.rs
@@ -0,0 +1,92 @@
+//! The simplest linter
+
+use std::{env, path::Path, rc::Rc};
+
+use oxc_allocator::Allocator;
+use oxc_ast::{AstKind, SourceType, Span};
+use oxc_diagnostics::{
+    miette::{self, Diagnostic},
+    thiserror::Error,
+};
+use oxc_parser::Parser;
+use oxc_semantic::SemanticBuilder;
+
+// Instruction:
+// create a `test.js`,
+// run `cargo run -p oxc_linter --example linter`
+// or `cargo watch -x "run -p oxc_linter --example linter"`
+
+fn main() {
+    let name = env::args().nth(1).unwrap_or_else(|| "test.js".to_string());
+    let path = Path::new(&name);
+    let source_text = std::fs::read_to_string(path).unwrap_or_else(|_| panic!("{name} not found"));
+    let allocator = Allocator::default();
+    let source_type = SourceType::from_path(path).unwrap();
+    let ret = Parser::new(&allocator, &source_text, source_type).parse();
+
+    // Handle parser errors
+    if !ret.errors.is_empty() {
+        print_errors(&source_text, ret.errors);
+        return;
+    }
+
+    let program = allocator.alloc(ret.program);
+    let trivias = Rc::new(ret.trivias);
+    let semantic_ret = SemanticBuilder::new(&source_text, source_type, &trivias).build(program);
+
+    let mut errors: Vec<oxc_diagnostics::Error> = vec![];
+
+    for node in semantic_ret.semantic.nodes().iter() {
+        match node.get().kind() {
+            AstKind::DebuggerStatement(stmt) => {
+                errors.push(NoDebugger(stmt.span).into());
+            }
+            AstKind::ArrayPattern(array) if array.elements.is_empty() => {
+                errors.push(NoEmptyPattern("array", array.span).into());
+            }
+            AstKind::ObjectPattern(object) if object.properties.is_empty() => {
+                errors.push(NoEmptyPattern("object", object.span).into());
+            }
+            _ => {}
+        }
+    }
+
+    if !errors.is_empty() {
+        print_errors(&source_text, errors);
+        return;
+    }
+
+    println!("Success!");
+}
+
+fn print_errors(source_text: &str, errors: Vec<oxc_diagnostics::Error>) {
+    for error in errors {
+        let error = error.with_source_code(source_text.to_string());
+        println!("{error:?}");
+    }
+}
+
+// This prints:
+//
+//   ⚠ `debugger` statement is not allowed
+//   ╭────
+// 1 │ debugger;
+//   · ─────────
+//   ╰────
+#[derive(Debug, Error, Diagnostic)]
+#[error("`debugger` statement is not allowed")]
+#[diagnostic(severity(warning))]
+struct NoDebugger(#[label] pub Span);
+
+// This prints:
+//
+//   ⚠ empty destructuring pattern is not allowed
+//   ╭────
+// 1 │ let {} = {};
+//   ·     ─┬
+//   ·      ╰── Empty object binding pattern
+//   ╰────
+#[derive(Debug, Error, Diagnostic)]
+#[error("empty destructuring pattern is not allowed")]
+#[diagnostic(severity(warning))]
+struct NoEmptyPattern(&'static str, #[label("Empty {0} binding pattern")] pub Span);