react-auditor 0.5.1

A blazing-fast Rust CLI to scan JS/TS/React code for best practices, quality, and security issues.
Documentation
use oxc_ast::ast::Program;
use oxc_ast_visit::Visit;
use oxc_ast_visit::walk;
use oxc_semantic::Semantic;

use crate::rules::{Rule, RuleFinding, RuleMeta, Severity};

pub struct NoMissingKey;

const RULE_META: RuleMeta = RuleMeta {
    id: "no-missing-key",
    default_severity: Severity::Error,
    category: "react",
    description: "List items should have a `key` prop",
};

impl Rule for NoMissingKey {
    fn meta(&self) -> &RuleMeta {
        &RULE_META
    }

    fn run(&self, program: &Program, _semantic: &Semantic, source_text: &str) -> Vec<RuleFinding> {
        let mut collector = MissingKeyCollector {
            findings: Vec::new(),
            source: source_text,
            list_context_depth: 0,
        };
        collector.visit_program(program);
        collector.findings
    }
}

struct MissingKeyCollector<'a> {
    findings: Vec<RuleFinding>,
    source: &'a str,
    list_context_depth: usize,
}

impl<'a> Visit<'a> for MissingKeyCollector<'a> {
    fn visit_call_expression(&mut self, expr: &oxc_ast::ast::CallExpression<'a>) {
        let is_list_map = match &expr.callee {
            oxc_ast::ast::Expression::StaticMemberExpression(member) => {
                let prop = member.property.name.as_str();
                prop == "map" || prop == "flatMap"
            }
            _ => false,
        };

        let has_callback = expr.arguments.first().is_some_and(|arg| {
            matches!(
                arg,
                oxc_ast::ast::Argument::ArrowFunctionExpression(_)
                    | oxc_ast::ast::Argument::FunctionExpression(_)
            )
        });

        if is_list_map && has_callback {
            self.list_context_depth += 1;
            walk::walk_call_expression(self, expr);
            self.list_context_depth -= 1;
        } else {
            walk::walk_call_expression(self, expr);
        }
    }

    fn visit_jsx_opening_element(&mut self, el: &oxc_ast::ast::JSXOpeningElement<'a>) {
        if self.list_context_depth == 0 {
            return;
        }

        let has_key = el.attributes.iter().any(|attr| {
            if let oxc_ast::ast::JSXAttributeItem::Attribute(a) = attr {
                matches!(&a.name, oxc_ast::ast::JSXAttributeName::Identifier(id) if id.name.as_str() == "key")
            } else {
                false
            }
        });

        if !has_key {
            let start = el.span.start as usize;
            let line = self.source[..start].lines().count().max(1);
            let col = start - self.source[..start].rfind('\n').map(|i| i + 1).unwrap_or(0);

            let name_str = match &el.name {
                oxc_ast::ast::JSXElementName::Identifier(id) => Some(id.name.as_str()),
                oxc_ast::ast::JSXElementName::IdentifierReference(id) => Some(id.name.as_str()),
                _ => None,
            };

            if let Some(name) = name_str
                && name.chars().next().is_some_and(|c| c.is_uppercase())
            {
                self.findings.push(RuleFinding {
                    line,
                    column: col + 1,
                    message: format!("Component `<{name}>` is missing a `key` prop"),
                });
            }
        }
    }
}