sdivi-lang-javascript 0.2.9

JavaScript language adapter for sdivi-rust
Documentation
//! JavaScript language adapter for sdivi-rust.
//!
//! Implements [`sdivi_parsing::adapter::LanguageAdapter`] for `.js` and `.mjs`
//! source files using the `tree-sitter-javascript` grammar.
//!
//! # Thread safety
//!
//! `tree_sitter::Parser` is not `Send`. Parsers are stored in `thread_local!`
//! storage so that `JavaScriptAdapter` itself can be `Send + Sync` and
//! participate in rayon parallel parsing.

mod extract;

use std::cell::RefCell;
use std::path::Path;

use sdivi_parsing::adapter::LanguageAdapter;
use sdivi_parsing::feature_record::FeatureRecord;

use extract::{collect_hints, extract_exports, extract_imports, extract_signatures};

thread_local! {
    static PARSER: RefCell<tree_sitter::Parser> = RefCell::new({
        let mut p = tree_sitter::Parser::new();
        p.set_language(&tree_sitter_javascript::language())
            .expect("tree-sitter-javascript grammar failed to load");
        p
    });
}

/// Language adapter for JavaScript source files.
///
/// Parses `.js` and `.mjs` files with the `tree-sitter-javascript` grammar
/// and extracts:
/// - `imports` from `import` statements
/// - `exports` from `export` statements at module scope
/// - `signatures` from function and method declarations
/// - `pattern_hints` for the patterns stage
///
/// # Examples
///
/// ```rust
/// use sdivi_lang_javascript::JavaScriptAdapter;
/// use sdivi_parsing::adapter::LanguageAdapter;
///
/// let adapter = JavaScriptAdapter;
/// assert_eq!(adapter.language_name(), "javascript");
/// assert!(adapter.file_extensions().contains(&".js"));
/// ```
pub struct JavaScriptAdapter;

impl LanguageAdapter for JavaScriptAdapter {
    fn language_name(&self) -> &'static str {
        "javascript"
    }

    fn file_extensions(&self) -> &[&'static str] {
        &[".js", ".mjs"]
    }

    /// Parses `content` and returns a [`FeatureRecord`].
    ///
    /// The tree-sitter CST is created, traversed, and **dropped** before this
    /// method returns. No tree-sitter type escapes into the returned record.
    fn parse_file(&self, path: &Path, content: String) -> FeatureRecord {
        let source = content.as_bytes();

        let (imports, exports, signatures, pattern_hints) = PARSER.with(|cell| {
            let mut parser = cell.borrow_mut();
            let tree = parser
                .parse(source, None)
                .expect("tree-sitter-javascript failed to parse");
            let root = tree.root_node();
            let imports = extract_imports(root, source);
            let exports = extract_exports(root, source);
            let signatures = extract_signatures(root, source);
            let hints = collect_hints(root, source);
            (imports, exports, signatures, hints)
        });

        FeatureRecord {
            path: path.to_path_buf(),
            language: "javascript".to_string(),
            imports,
            exports,
            signatures,
            pattern_hints,
        }
    }
}