Add simple package.json analyzer

Author: Hendrik van Antwerpen

languages/tree-sitter-stack-graphs-typescript/Cargo.toml

@@ -25,6 +25,8 @@ harness = false
 anyhow = "1.0"
 clap = "3"
 glob = "0.3"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
 stack-graphs = { version = "~0.10", path = "../../stack-graphs" }
 tree-sitter-stack-graphs = { version = "~0.5", path = "../../tree-sitter-stack-graphs", features=["cli"] }
 tree-sitter-typescript = { git = "https://github.com/tree-sitter/tree-sitter-typescript", rev="082da44a5263599186dadafd2c974c19f3a73d28" }

languages/tree-sitter-stack-graphs-typescript/rust/lib.rs

@@ -5,11 +5,14 @@
 // Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
 // ------------------------------------------------------------------------------------------------
 
-use crate::tsconfig::TsConfigAnalyzer;
 use tree_sitter_stack_graphs::loader::FileAnalyzers;
 use tree_sitter_stack_graphs::loader::LanguageConfiguration;
 use tree_sitter_stack_graphs::CancellationFlag;
 
+use crate::npm_package::NpmPackageAnalyzer;
+use crate::tsconfig::TsConfigAnalyzer;
+
+pub mod npm_package;
 pub mod tsconfig;
 pub mod util;
 
@@ -35,7 +38,9 @@ pub fn language_configuration(cancellation_flag: &dyn CancellationFlag) -> Langu
         STACK_GRAPHS_TSG_SOURCE,
         Some(STACK_GRAPHS_BUILTINS_SOURCE),
         Some(STACK_GRAPHS_BUILTINS_CONFIG),
-        FileAnalyzers::new().add("tsconfig.json".to_string(), TsConfigAnalyzer {}),
+        FileAnalyzers::new()
+            .add("tsconfig.json".to_string(), TsConfigAnalyzer {})
+            .add("package.json".to_string(), NpmPackageAnalyzer {}),
         cancellation_flag,
     )
     .unwrap()

languages/tree-sitter-stack-graphs-typescript/rust/npm_package.rs

@@ -0,0 +1,77 @@
+// -*- coding: utf-8 -*-
+// ------------------------------------------------------------------------------------------------
+// Copyright © 2022, stack-graphs authors.
+// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
+// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
+// ------------------------------------------------------------------------------------------------
+
+use serde::Deserialize;
+use stack_graphs::graph::NodeID;
+use std::collections::HashMap;
+use std::path::Path;
+
+use stack_graphs::arena::Handle;
+use stack_graphs::graph::File;
+use stack_graphs::graph::StackGraph;
+use tree_sitter_stack_graphs::FileAnalyzer;
+use tree_sitter_stack_graphs::LoadError;
+
+use crate::util::*;
+
+pub struct NpmPackageAnalyzer {}
+
+impl FileAnalyzer for NpmPackageAnalyzer {
+    fn build_stack_graph_into<'a>(
+        &self,
+        graph: &mut StackGraph,
+        file: Handle<File>,
+        _path: &Path,
+        source: &str,
+        _all_paths: &mut dyn Iterator<Item = &'a Path>,
+        globals: &HashMap<String, String>,
+        _cancellation_flag: &dyn tree_sitter_stack_graphs::CancellationFlag,
+    ) -> Result<(), tree_sitter_stack_graphs::LoadError> {
+        // read globals
+        let proj_name = globals
+            .get(crate::PROJECT_NAME_VAR)
+            .map(String::as_str)
+            .unwrap_or("");
+
+        // parse source
+        let npm_pkg: NpmPackage =
+            serde_json::from_str(source).map_err(|_| LoadError::ParseError)?;
+
+        // root node
+        let root = graph.node_for_id(NodeID::root()).unwrap();
+
+        // project scope
+        let proj_scope_id = graph.new_node_id(file);
+        let proj_scope = graph.add_scope_node(proj_scope_id, false).unwrap();
+        add_debug_name(graph, proj_scope, "npm_package.proj_scope");
+
+        // project definition
+        let proj_def = add_ns_pop(graph, file, root, PROJ_NS, proj_name);
+        add_debug_name(graph, proj_def, "npm_package.proj_def");
+        add_edge(graph, proj_def, proj_scope, 0);
+
+        // project reference
+        let proj_ref = add_ns_push(graph, file, root, PROJ_NS, proj_name);
+        add_debug_name(graph, proj_ref, "npm_package.proj_ref");
+        add_edge(graph, proj_scope, proj_ref, 0);
+
+        // package definition
+        let pkg_def = add_module_pops(graph, file, NON_REL_M_NS, Path::new(&npm_pkg.name), root);
+        add_debug_name(graph, pkg_def, "npm_package.pkg_def");
+        let pkg_ref = add_push(graph, file, proj_scope, PKG_M_NS);
+        add_debug_name(graph, pkg_ref, "npm_package.pkg_ref");
+        add_edge(graph, pkg_def, pkg_ref, 0);
+
+        Ok(())
+    }
+}
+
+#[derive(Default, Debug, Clone, PartialEq, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct NpmPackage {
+    pub name: String,
+}

languages/tree-sitter-stack-graphs-typescript/rust/tsconfig.rs

@@ -35,7 +35,7 @@ impl FileAnalyzer for TsConfigAnalyzer {
     ) -> Result<(), tree_sitter_stack_graphs::LoadError> {
         // read globals
         let proj_name = globals
-            .get("PROJECT_NAME")
+            .get(crate::PROJECT_NAME_VAR)
             .map(String::as_str)
             .unwrap_or("");
 
@@ -48,41 +48,49 @@ impl FileAnalyzer for TsConfigAnalyzer {
         // project scope
         let proj_scope_id = graph.new_node_id(file);
         let proj_scope = graph.add_scope_node(proj_scope_id, false).unwrap();
-        add_debug_name(graph, proj_scope, "proj_scope");
+        add_debug_name(graph, proj_scope, "tsconfig.proj_scope");
 
         // project definition
         let proj_def = add_ns_pop(graph, file, root, PROJ_NS, proj_name);
-        add_debug_name(graph, proj_def, "proj_def");
+        add_debug_name(graph, proj_def, "tsconfig.proj_def");
         add_edge(graph, proj_def, proj_scope, 0);
 
         // project reference
         let proj_ref = add_ns_push(graph, file, root, PROJ_NS, proj_name);
-        add_debug_name(graph, proj_ref, "proj_ref");
+        add_debug_name(graph, proj_ref, "tsconfig.proj_ref");
         add_edge(graph, proj_scope, proj_ref, 0);
 
         // root directory
         let pkg_def = add_pop(graph, file, proj_scope, PKG_M_NS);
-        add_debug_name(graph, pkg_def, "pkg_def");
+        add_debug_name(graph, pkg_def, "tsconfig.pkg_def");
         let root_dir_ref =
             add_module_pushes(graph, file, M_NS, &tsc.root_dir(all_paths), proj_scope);
-        add_debug_name(graph, root_dir_ref, "root_dir.ref");
+        add_debug_name(graph, root_dir_ref, "tsconfig.root_dir.ref");
         add_edge(graph, pkg_def, root_dir_ref, 0);
 
         // auxiliary root directories, map relative imports to module paths
         for (idx, root_dir) in tsc.root_dirs().iter().enumerate() {
             let root_dir_def = add_pop(graph, file, proj_scope, REL_M_NS);
-            add_debug_name(graph, root_dir_def, &format!("root_dirs[{}].def", idx));
+            add_debug_name(
+                graph,
+                root_dir_def,
+                &format!("tsconfig.root_dirs[{}].def", idx),
+            );
             let root_dir_ref = add_module_pushes(graph, file, M_NS, root_dir, proj_scope);
-            add_debug_name(graph, root_dir_ref, &format!("root_dirs[{}].ref", idx));
+            add_debug_name(
+                graph,
+                root_dir_ref,
+                &format!("tsconfig.root_dirs[{}].ref", idx),
+            );
             add_edge(graph, root_dir_def, root_dir_ref, 0);
         }
 
         // base URL
         let base_url = tsc.base_url();
         let base_url_def = add_pop(graph, file, proj_scope, NON_REL_M_NS);
-        add_debug_name(graph, base_url_def, "base_url.def");
+        add_debug_name(graph, base_url_def, "tsconfig.base_url.def");
         let base_url_ref = add_module_pushes(graph, file, M_NS, &base_url, proj_scope);
-        add_debug_name(graph, base_url_ref, "base_url.ref");
+        add_debug_name(graph, base_url_ref, "tsconfig.base_url.ref");
         add_edge(graph, base_url_def, base_url_ref, 0);
 
         // path mappings
@@ -94,14 +102,18 @@ impl FileAnalyzer for TsConfigAnalyzer {
                 &from
             };
             let from_def = add_module_pops(graph, file, NON_REL_M_NS, from, proj_scope);
-            add_debug_name(graph, from_def, &format!("paths[{}].from_def", from_idx));
+            add_debug_name(
+                graph,
+                from_def,
+                &format!("tsconfig.paths[{}].from_def", from_idx),
+            );
             for (to_idx, to) in tos.iter().enumerate() {
                 let to = if is_prefix { to.parent().unwrap() } else { &to };
                 let to_ref = add_module_pushes(graph, file, M_NS, to, proj_scope);
                 add_debug_name(
                     graph,
                     to_ref,
-                    &format!("paths[{}][{}].to_ref", from_idx, to_idx),
+                    &format!("tsconfig.paths[{}][{}].to_ref", from_idx, to_idx),
                 );
                 add_edge(graph, from_def, to_ref, 0);
             }

languages/tree-sitter-stack-graphs-typescript/rust/util.rs

@@ -21,7 +21,7 @@ pub const PKG_M_NS: &str = "%PkgM";
 
 pub fn add_debug_name(graph: &mut StackGraph, node: Handle<Node>, name: &str) {
     let key = graph.add_string("name");
-    let value = graph.add_string(&["tsconfig", name].join("."));
+    let value = graph.add_string(name);
     graph.debug_info_mut(node).add(key, value);
 }
 

languages/tree-sitter-stack-graphs-typescript/src/stack-graphs.tsg

@@ -190,7 +190,8 @@ attribute node_symbol = node            => symbol = (source-text node), source_n
 ;     proj_scope -> ↑"%PkgM" -> ↓"src" -> ↓"%M"
 ;
 ; The various references and definitions for `tsconfig.json` are not created by this TSG file, but
-; by the `TsConfigAnalyzer` defined in `rust/tsconfig.rs`.
+; by the `TsConfigAnalyzer` defined in `rust/tsconfig.rs`. The global package definition is created
+; by the `NpmPackageAnalyzer` in `rust/npm_package.rs`.
 
 
 

languages/tree-sitter-stack-graphs-typescript/test/projects/package-with-baseurl.ts

@@ -0,0 +1,15 @@
+/* --- path: ./package.json --- */
+{
+    "name": "@my/pkg"
+}
+
+/* --- path: ./tsconfig.json --- */
+{
+}
+
+/* --- path: ./src/foo.ts --- */
+export const bar = 42;
+
+/* --- path: ./src/index.ts --- */
+import { bar } from "@my/pkg/foo";
+//       ^ defined: 11