chore: clenup after review

Author: nohehf

tree-sitter-stack-graphs/src/lib.rs

@@ -435,10 +435,16 @@ static SCOPE_ATTRS: Lazy<HashSet<&'static str>> =
 static PRECEDENCE_ATTR: &'static str = "precedence";
 
 // Global variables
-static ROOT_NODE_VAR: &'static str = "ROOT_NODE";
-static JUMP_TO_SCOPE_NODE_VAR: &'static str = "JUMP_TO_SCOPE_NODE";
-static FILE_PATH_VAR: &'static str = "FILE_PATH";
-static ROOT_PATH_VAR: &'static str = "ROOT_PATH";
+/// Name of the variable used to pass the root node.
+pub const ROOT_NODE_VAR: &'static str = "ROOT_NODE";
+/// Name of the variable used to pass the jump-to-scope node.
+pub const JUMP_TO_SCOPE_NODE_VAR: &'static str = "JUMP_TO_SCOPE_NODE";
+/// Name of the variable used to pass the file path.
+/// If a root path is given, it should be a descendant the root path.
+pub const FILE_PATH_VAR: &'static str = "FILE_PATH";
+/// Name of the variable used to pass the root path.
+/// If given, should be an ancestor of the file path.
+pub const ROOT_PATH_VAR: &'static str = "ROOT_PATH";
 
 /// Holds information about how to construct stack graphs for a particular language.
 pub struct StackGraphLanguage {
@@ -649,11 +655,6 @@ impl<'a> Builder<'a> {
             .add(JUMP_TO_SCOPE_NODE_VAR.into(), jump_to_scope_node.into())
             .expect("Failed to set JUMP_TO_SCOPE_NODE");
 
-        // FILE_PATH is mandatory
-        globals
-            .get(&FILE_PATH_VAR.into())
-            .expect("FILE_PATH not set");
-
         let mut config = ExecutionConfig::new(&self.sgl.functions, &globals)
             .lazy(true)
             .debug_attributes(

tree-sitter-stack-graphs/src/loader.rs

@@ -31,6 +31,8 @@ use crate::FileAnalyzer;
 use crate::StackGraphLanguage;
 use crate::FILE_PATH_VAR;
 
+const BUILTINS_FILENAME: &str = "<builtins>";
+
 pub static DEFAULT_TSG_PATHS: Lazy<Vec<LoadPath>> =
     Lazy::new(|| vec![LoadPath::Grammar("queries/stack-graphs".into())]);
 pub static DEFAULT_BUILTINS_PATHS: Lazy<Vec<LoadPath>> =
@@ -77,18 +79,14 @@ impl LanguageConfiguration {
         if let Some((builtins_path, builtins_source)) = builtins_source {
             let mut builtins_globals = Variables::new();
 
-            let builtins_path_var = Path::new("<builtins>");
             builtins_globals
-                .add(
-                    FILE_PATH_VAR.into(),
-                    builtins_path_var.to_str().unwrap().into(),
-                )
+                .add(FILE_PATH_VAR.into(), BUILTINS_FILENAME.into())
                 .expect("failed to add file path variable");
 
             if let Some(builtins_config) = builtins_config {
                 Loader::load_globals_from_config_str(builtins_config, &mut builtins_globals)?;
             }
-            let file = builtins.add_file("<builtins>").unwrap();
+            let file = builtins.add_file(BUILTINS_FILENAME).unwrap();
             sgl.build_stack_graph_into(
                 &mut builtins,
                 file,
@@ -341,7 +339,7 @@ impl Loader {
         let mut globals = Variables::new();
 
         globals
-            .add(FILE_PATH_VAR.into(), path.to_str().unwrap().into())
+            .add(FILE_PATH_VAR.into(), BUILTINS_FILENAME.into())
             .expect("failed to add file path variable");
 
         Self::load_globals_from_config_str(&config, &mut globals)?;

tree-sitter-stack-graphs/tests/it/builder.rs

@@ -4,17 +4,14 @@
 // 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 std::path::Path;
-
 use stack_graphs::graph::StackGraph;
 use tree_sitter_graph::Variables;
 use tree_sitter_stack_graphs::NoCancellation;
 use tree_sitter_stack_graphs::StackGraphLanguage;
+use tree_sitter_stack_graphs::FILE_PATH_VAR;
 
 use crate::edges::check_stack_graph_edges;
 use crate::nodes::check_stack_graph_nodes;
-use crate::FILE_PATH_VAR;
 
 #[test]
 fn can_support_preexisting_nodes() {

tree-sitter-stack-graphs/tests/it/main.rs

@@ -14,8 +14,7 @@ use tree_sitter_graph::Variables;
 use tree_sitter_stack_graphs::BuildError;
 use tree_sitter_stack_graphs::NoCancellation;
 use tree_sitter_stack_graphs::StackGraphLanguage;
-
-static FILE_PATH_VAR: &'static str = "FILE_PATH";
+use tree_sitter_stack_graphs::FILE_PATH_VAR;
 
 mod builder;
 mod edges;
@@ -35,7 +34,6 @@ pub(self) fn build_stack_graph(
     let mut globals = Variables::new();
     let source_path = Path::new(file_name);
 
-    // The FILE_PATH_VAR is not accessible here
     globals
         .add(FILE_PATH_VAR.into(), source_path.to_str().unwrap().into())
         .expect("failed to add file path variable");