replace stack-graphs fork with workspace metaslang_stack_graphs (#1447)

- added `README` and `LICENSE`
- disabled optional unused features
- enabled crate to be published along other `metaslang_*` crates

Author: OmarTawfik

Cargo.lock

@@ -29,6 +29,7 @@ members = [
     "crates/metaslang/bindings",
     "crates/metaslang/cst",
     "crates/metaslang/graph_builder",
+    "crates/metaslang/stack_graphs",
 
     "crates/solidity/inputs/language",
 
@@ -72,8 +73,9 @@ language_v2_macros = { path = "crates/language-v2/macros", version = "1.3.0" }
 language_v2_tests = { path = "crates/language-v2/tests", version = "1.3.0" }
 
 metaslang_bindings = { path = "crates/metaslang/bindings", version = "1.3.0" }
-metaslang_graph_builder = { path = "crates/metaslang/graph_builder", version = "1.3.0" }
 metaslang_cst = { path = "crates/metaslang/cst", version = "1.3.0" }
+metaslang_graph_builder = { path = "crates/metaslang/graph_builder", version = "1.3.0" }
+metaslang_stack_graphs = { path = "crates/metaslang/stack_graphs", version = "1.3.0" }
 
 solidity_language = { path = "crates/solidity/inputs/language", version = "1.3.0" }
 
@@ -100,13 +102,18 @@ ariadne = { version = "0.2.0" }
 # Currently 'bencher' backend API is under development/unstable.
 # They recommend always running with the latest CLI version from 'main' until it is stabilized.
 bencher_cli = { git = "https://github.com/bencherdev/bencher", branch = "main" }
+bitvec = { version = "1.0.1" }
 cargo-edit = { version = "0.12.3" }
 cargo-nextest = { version = "0.9.72" }
 clap = { version = "4.5.40", features = ["derive", "wrap_help"] }
 clap_complete = { version = "4.5.54" }
 console = { version = "0.15.11" }
+controlled-option = { version = "0.4.1" }
 derive-new = { version = "0.6.0" }
+either = { version = "1.6.0" }
+enumset = { version = "1.1.0" }
 env_logger = { version = "0.11.6" }
+fxhash = { version = "0.2.0" }
 iai-callgrind = { version = "0.12.3" }
 iai-callgrind-runner = { version = "0.12.3" }
 ignore = { version = "0.4.23" }
@@ -115,7 +122,9 @@ indicatif = { version = "0.17.12", features = ["in_memory"] }
 indoc = { version = "2.0.6" }
 Inflector = { version = "0.11.4" }
 itertools = { version = "0.13.0" }
+libc = { version = "0.2.0" }
 log = { version = "0.4.27" }
+lsp-positions = { version = "0.3.0" } 
 markdown = { version = "0.3.0" }
 nom = { version = "7.1.3" }
 num-format = { version = "0.4.4" }
@@ -133,7 +142,6 @@ serde_json = { version = "1.0.140", features = ["preserve_order"] }
 similar-asserts = { version = "1.7.0" }
 smallvec = { version = "1.15.0", features = ["union"] }
 solar = { version = "0.1.3", package = "solar-compiler" }
-stack-graphs = { git = "https://github.com/NomicFoundation/stack-graphs", branch = "nomic" }
 streaming-iterator = { version = "0.1.9" }
 string-interner = { version = "0.17.0", features = [
     "std",

Cargo.toml

@@ -11,6 +11,7 @@ pub enum UserFacingCrate {
     // Sorted by dependency order (from dependencies to dependents):
     metaslang_cst,
     metaslang_graph_builder,
+    metaslang_stack_graphs,
     metaslang_bindings,
     slang_solidity,
     slang_solidity_cli,
@@ -51,6 +52,7 @@ fn has_library_target(crate_name: UserFacingCrate) -> bool {
     match crate_name {
         UserFacingCrate::metaslang_cst => true,
         UserFacingCrate::metaslang_graph_builder => true,
+        UserFacingCrate::metaslang_stack_graphs => true,
         UserFacingCrate::metaslang_bindings => true,
         UserFacingCrate::slang_solidity => true,
         UserFacingCrate::slang_solidity_cli => false,

crates/infra/cli/src/toolchains/public_api/mod.rs

@@ -21,8 +21,8 @@ categories = ["compilers", "parsing", "parser-implementations"]
 [dependencies]
 metaslang_cst = { workspace = true }
 metaslang_graph_builder = { workspace = true }
+metaslang_stack_graphs = { workspace = true }
 semver = { workspace = true }
-stack-graphs = { workspace = true }
 thiserror = { workspace = true }
 
 [dev-dependencies]

crates/metaslang/bindings/Cargo.toml

@@ -25,9 +25,10 @@ pub trait CancellationFlag: Sync {
 #[error("Cancelled at \"{0}\"")]
 pub struct CancellationError(pub &'static str);
 
-impl stack_graphs::CancellationFlag for &dyn CancellationFlag {
-    fn check(&self, at: &'static str) -> Result<(), stack_graphs::CancellationError> {
-        CancellationFlag::check(*self, at).map_err(|err| stack_graphs::CancellationError(err.0))
+impl metaslang_stack_graphs::CancellationFlag for &dyn CancellationFlag {
+    fn check(&self, at: &'static str) -> Result<(), metaslang_stack_graphs::CancellationError> {
+        CancellationFlag::check(*self, at)
+            .map_err(|err| metaslang_stack_graphs::CancellationError(err.0))
     }
 }
 

crates/metaslang/bindings/src/builder/loader/cancellation.rs

@@ -289,8 +289,8 @@ use metaslang_graph_builder::ast::File as GraphBuilderFile;
 use metaslang_graph_builder::functions::Functions;
 use metaslang_graph_builder::graph::{Edge, Graph, GraphNode, GraphNodeRef, Value};
 use metaslang_graph_builder::{ExecutionConfig, ExecutionError, Variables};
-use stack_graphs::arena::Handle;
-use stack_graphs::graph::{File, Node, NodeID, StackGraph};
+use metaslang_stack_graphs::arena::Handle;
+use metaslang_stack_graphs::graph::{File, Node, NodeID, StackGraph};
 use thiserror::Error;
 
 use crate::builder::{DefinitionBindingInfo, ReferenceBindingInfo};
@@ -547,8 +547,8 @@ pub enum BuildError {
     InvalidParent(GraphNodeRef),
 }
 
-impl From<stack_graphs::CancellationError> for BuildError {
-    fn from(value: stack_graphs::CancellationError) -> Self {
+impl From<metaslang_stack_graphs::CancellationError> for BuildError {
+    fn from(value: metaslang_stack_graphs::CancellationError) -> Self {
         Self::Cancelled(value.0)
     }
 }
@@ -564,7 +564,7 @@ impl From<ExecutionError> for BuildError {
 
 impl<KT: KindTypes + 'static> Loader<'_, KT> {
     fn load(&mut self, cancellation_flag: &dyn CancellationFlag) -> Result<(), BuildError> {
-        let cancellation_flag: &dyn stack_graphs::CancellationFlag = &cancellation_flag;
+        let cancellation_flag: &dyn metaslang_stack_graphs::CancellationFlag = &cancellation_flag;
 
         // By default graph ids are used for stack graph local_ids. A remapping is computed
         // for local_ids that already exist in the graph---all other graph ids are mapped to

crates/metaslang/bindings/src/builder/loader/mod.rs

@@ -10,11 +10,12 @@ use metaslang_cst::kinds::KindTypes;
 use metaslang_cst::nodes::NodeId;
 use metaslang_graph_builder::ast::File;
 use metaslang_graph_builder::functions::Functions;
+use metaslang_stack_graphs::graph::{NodeID as GraphNodeId, StackGraph};
 use semver::Version;
-use stack_graphs::graph::{NodeID as GraphNodeId, StackGraph};
 
-pub type GraphHandle = stack_graphs::arena::Handle<stack_graphs::graph::Node>;
-pub(crate) type FileHandle = stack_graphs::arena::Handle<stack_graphs::graph::File>;
+pub type GraphHandle = metaslang_stack_graphs::arena::Handle<metaslang_stack_graphs::graph::Node>;
+pub(crate) type FileHandle =
+    metaslang_stack_graphs::arena::Handle<metaslang_stack_graphs::graph::File>;
 
 pub use crate::graph::BindingGraph;
 

crates/metaslang/bindings/src/builder/mod.rs

@@ -2,13 +2,13 @@ use std::collections::{HashMap, HashSet};
 use std::iter::once;
 
 use metaslang_cst::kinds::KindTypes;
-use stack_graphs::arena::Handle;
-use stack_graphs::graph::{Degree, Edge, StackGraph};
-use stack_graphs::partial::{PartialPath, PartialPaths};
-use stack_graphs::stitching::{
+use metaslang_stack_graphs::arena::Handle;
+use metaslang_stack_graphs::graph::{Degree, Edge, StackGraph};
+use metaslang_stack_graphs::partial::{PartialPath, PartialPaths};
+use metaslang_stack_graphs::stitching::{
     Database, ForwardCandidates, ForwardPartialPathStitcher, StitcherConfig, ToAppendable,
 };
-use stack_graphs::{CancellationError, NoCancellation};
+use metaslang_stack_graphs::{CancellationError, NoCancellation};
 
 use crate::builder::{ExtendedStackGraph, GraphHandle};
 

crates/metaslang/bindings/src/graph/resolver.rs

@@ -0,0 +1 @@
+ignore = ["src/"] # __NOMIC_FOUNDATION_FORK__ (disable formatting to minimize changes to the fork)

crates/metaslang/stack_graphs/.rustfmt.toml

@@ -1,50 +1,56 @@
 [package]
-name = "stack-graphs"
-version = "0.14.1"
-description = "Name binding for arbitrary programming languages"
-homepage = "https://github.com/github/stack-graphs/tree/main/stack-graphs"
-repository = "https://github.com/github/stack-graphs/"
-readme = "README.md"
-license = "MIT OR Apache-2.0"
+version.workspace = true
+rust-version.workspace = true
+edition.workspace = true
+publish = true
+
+name = "metaslang_stack_graphs"
+description = "Stack graphs utilities used in Slang"
+homepage = "https://nomicfoundation.github.io/slang/"
+repository = "https://github.com/NomicFoundation/slang/"
 authors = [
-  "GitHub <opensource+stack-graphs@github.com>",
-  "Douglas Creager <dcreager@dcreager.net>"
+  "Slang Team <slang@nomic.foundation>",
+  "Nomic Foundation <packages@nomic.foundation>",
 ]
-edition = "2018"
 
-[features]
-bincode = ["dep:bincode", "lsp-positions/bincode"]
-copious-debugging = []
-serde = ["dep:serde", "serde_with", "lsp-positions/serde"]
-storage = ["bincode", "rusqlite"]
-visualization = ["serde", "serde_json"]
+readme = "README.md"
+license = "MIT"
+keywords = ["stack-graphs"]
+categories = ["compilers"]
 
-[lib]
-# All of our tests are in the tests/it "integration" test executable.
-test = false
+# __NOMIC_FOUNDATION_FORK__ (disable optional features not used in Slang)
+# [features]
+# bincode = ["dep:bincode", "lsp-positions/bincode"]
+# copious-debugging = []
+# serde = ["dep:serde", "serde_with", "lsp-positions/serde"]
+# storage = ["bincode", "rusqlite"]
+# visualization = ["serde", "serde_json"]
 
 [dependencies]
-bincode = { version = "2.0.0-rc.3", optional = true }
-bitvec = "1.0.1"
-controlled-option = "0.4.1"
-either = "1.6"
-enumset = "1.1"
-fxhash = "0.2"
-itertools = "0.10.2"
-libc = "0.2"
-lsp-positions = { version = "0.3", path = "../lsp-positions" } # explicit version is required to be able to publish crate
-rusqlite = { version = "0.28", optional = true, features = ["bundled", "functions"] }
-serde = { version = "1.0", optional = true, features = ["derive"] }
-serde_json = { version = "1.0", optional = true }
-serde_with = { version = "3.1", optional = true }
-smallvec = { version = "1.6", features = ["union"] }
-thiserror = { version = "1.0" }
-
-[dev-dependencies]
-assert-json-diff = "2"
-maplit = "1.0"
-pretty_assertions = "0.7"
-serde_json = { version = "1.0" }
-
-[package.metadata.docs.rs]
-all-features = true
+bitvec = { workspace = true }
+controlled-option = { workspace = true }
+either = { workspace = true }
+enumset = { workspace = true }
+fxhash = { workspace = true }
+itertools = { workspace = true }
+libc = { workspace = true }
+lsp-positions = { workspace = true }
+smallvec = { workspace = true, features = ["union"] }
+thiserror = { workspace = true }
+
+# __NOMIC_FOUNDATION_FORK__ (disable optional dependencies not used in Slang)
+# [dependencies]
+# bincode = { version = "2.0.0-rc.3", optional = true }
+# rusqlite = { version = "0.28", optional = true, features = ["bundled", "functions"] }
+# serde = { version = "1.0", optional = true, features = ["derive"] }
+# serde_json = { version = "1.0", optional = true }
+# serde_with = { version = "3.1", optional = true }
+
+[lints.rust]
+unexpected_cfgs = "allow" # __NOMIC_FOUNDATION_FORK__ (disable warning about non-existing features, disabled above)
+
+[lints.rustdoc]
+all = "allow" # __NOMIC_FOUNDATION_FORK__ (disable lints to minimize changes to the fork)
+
+[lints.clippy]
+all = "allow" # __NOMIC_FOUNDATION_FORK__ (disable lints to minimize changes to the fork)