use super::LintRule;
use crate::{globals::GLOBALS, linter::Context, swc_util::find_lhs_ids};
use std::{collections::HashSet, sync::Arc};
use swc_common::Span;
use swc_ecmascript::{
ast::*,
utils::find_ids,
utils::ident::IdentLike,
utils::Id,
visit::Node,
visit::{noop_visit_type, Visit, VisitWith},
};
pub struct NoGlobalAssign;
impl LintRule for NoGlobalAssign {
fn new() -> Box<Self> {
Box::new(NoGlobalAssign)
}
fn code(&self) -> &'static str {
"no-global-assign"
}
fn lint_module(
&self,
context: Arc<Context>,
module: &swc_ecmascript::ast::Module,
) {
let mut collector = Collector {
bindings: Default::default(),
};
module.visit_with(module, &mut collector);
let mut visitor = NoGlobalAssignVisitor::new(context, collector.bindings);
module.visit_with(module, &mut visitor);
}
}
struct Collector {
bindings: HashSet<Id>,
}
impl Visit for Collector {
noop_visit_type!();
fn visit_import_named_specifier(
&mut self,
i: &ImportNamedSpecifier,
_: &dyn Node,
) {
self.bindings.insert(i.local.to_id());
}
fn visit_import_default_specifier(
&mut self,
i: &ImportDefaultSpecifier,
_: &dyn Node,
) {
self.bindings.insert(i.local.to_id());
}
fn visit_import_star_as_specifier(
&mut self,
i: &ImportStarAsSpecifier,
_: &dyn Node,
) {
self.bindings.insert(i.local.to_id());
}
fn visit_fn_decl(&mut self, n: &FnDecl, _: &dyn Node) {
self.bindings.insert(n.ident.to_id());
}
fn visit_class_decl(&mut self, n: &ClassDecl, _: &dyn Node) {
self.bindings.insert(n.ident.to_id());
}
fn visit_var_declarator(&mut self, n: &VarDeclarator, _: &dyn Node) {
let ids: Vec<Id> = find_ids(&n.name);
for id in ids {
self.bindings.insert(id);
}
}
fn visit_expr(&mut self, _: &Expr, _: &dyn Node) {}
}
struct NoGlobalAssignVisitor {
context: Arc<Context>,
bindings: HashSet<Id>,
}
impl NoGlobalAssignVisitor {
fn new(context: Arc<Context>, bindings: HashSet<Id>) -> Self {
Self { context, bindings }
}
fn check(&self, span: Span, id: Id) {
if id.1 != self.context.top_level_ctxt {
return;
}
if self.bindings.contains(&id) {
return;
}
if !GLOBALS.contains(&&*id.0) {
return;
}
self.context.add_diagnostic(
span,
"no-global-assign",
"Assignment to global is not allowed",
);
}
}
impl Visit for NoGlobalAssignVisitor {
noop_visit_type!();
fn visit_assign_expr(&mut self, e: &AssignExpr, _: &dyn Node) {
let idents: Vec<Ident> = find_lhs_ids(&e.left);
for ident in idents {
self.check(ident.span, ident.to_id());
}
}
fn visit_update_expr(&mut self, e: &UpdateExpr, _: &dyn Node) {
if let Expr::Ident(i) = &*e.arg {
self.check(e.span, i.to_id());
} else {
e.visit_children_with(self);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test_util::*;
#[test]
fn ok_1() {
assert_lint_ok::<NoGlobalAssign>("string = 'hello world';");
assert_lint_ok::<NoGlobalAssign>("var string;");
assert_lint_ok::<NoGlobalAssign>("top = 0;");
}
#[test]
fn ok_2() {
assert_lint_ok::<NoGlobalAssign>("require = 0;");
}
#[test]
fn err_1() {
assert_lint_err::<NoGlobalAssign>("String = 'hello world';", 0);
assert_lint_err::<NoGlobalAssign>("String++;", 0);
assert_lint_err_n::<NoGlobalAssign>(
"({Object = 0, String = 0} = {});",
vec![2, 14],
);
}
#[test]
fn err_2() {
assert_lint_err::<NoGlobalAssign>("Array = 1;", 0);
}
}