Add debugging facilities to RuleNode/TokenNode exposed via N-API

.changeset/pink-bats-lie.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/slang": minor
+---
+
+Changed the cst.NodeType in TS to use more descriptive string values rather than 0/1 integers

.changeset/warm-maps-give.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/slang": minor
+---
+
+Add RuleNode/TokenNode::toJSON() in the TypeScript API

crates/codegen/parser/runtime/Cargo.toml

@@ -13,14 +13,15 @@ napi = { workspace = true, optional = true }
 napi-derive = { workspace = true, optional = true }
 nom = { workspace = true }
 serde = { workspace = true }
+serde_json = { workspace = true, optional = true }
 strum = { workspace = true }
 strum_macros = { workspace = true }
 
 # Since the source code is copied over as-is, we need to retain exact feature set with target crate,
 # i.e `slang_solidity_node_addon`.
 [features]
 default = ["slang_napi_interfaces"]
-slang_napi_interfaces = ["dep:napi", "dep:napi-derive"]
+slang_napi_interfaces = ["dep:napi", "dep:napi-derive", "dep:serde_json"]
 
 [lints]
 workspace = true

crates/codegen/parser/runtime/src/napi_interface/cst.rs

@@ -9,7 +9,7 @@ use crate::napi_interface::{
  RuleKind, RustNode, RustRuleNode, RustTextIndex, RustTokenNode, TokenKind,
 };
 
-#[napi(namespace = "cst")]
+#[napi(namespace = "cst", string_enum)]
 pub enum NodeType {
  Rule,
  Token,
@@ -83,10 +83,45 @@ impl RuleNode {
  .into()
  }
 
+ #[napi(catch_unwind, js_name = "toJSON")]
+ /// Serialize the token node to JSON.
+ pub fn to_json(&self) -> String {
+ serde_json::to_string(&self.0).unwrap()
+ }
+
  #[napi(catch_unwind)]
  pub fn unparse(&self) -> String {
  self.0.clone().unparse()
  }
+
+ // Expose the children as a hidden (non-enumerable, don't generate type definition)
+ // property that's eagerly evaluated (getter) for an inspected parent object in the debugger context.
+ #[napi(
+ enumerable = false,
+ configurable = false,
+ writable = false,
+ getter,
+ js_name = "__children", // Needed; otherwise, the property name would shadow `children`.
+ skip_typescript,
+ catch_unwind
+ )]
+ pub fn __children(&self) -> Vec<Either<RuleNode, TokenNode>> {
+ Self::children(self)
+ }
+
+ // Similarly, expose the eagerly evaluated unparsed text in the debugger context.
+ #[napi(
+ enumerable = false,
+ configurable = false,
+ writable = false,
+ getter,
+ js_name = "__text",
+ skip_typescript,
+ catch_unwind
+ )]
+ pub fn __text(&self) -> String {
+ self.unparse()
+ }
 }
 
 #[napi(namespace = "cst")]
@@ -122,6 +157,14 @@ impl TokenNode {
  self.0.text.clone()
  }
 
+ #[napi(catch_unwind, js_name = "toJSON")]
+ /// Serialize the token node to JSON.
+ ///
+ /// This method is intended for debugging purposes and may not be stable.
+ pub fn to_json(&self) -> String {
+ serde_json::to_string(&self.0).unwrap()
+ }
+
  #[napi(ts_return_type = "cursor.Cursor", catch_unwind)]
  pub fn create_cursor(
  &self,

crates/solidity/outputs/cargo/slang_solidity_node_addon/Cargo.toml

@@ -29,6 +29,7 @@ crate-type = ["cdylib"]
 default = ["slang_napi_interfaces"]
 slang_napi_interfaces = [
  # This enables '#[napi]' attributes on the Rust types imported via [lib.path] above.
+ "dep:serde_json",
 ]
 
 [build-dependencies]
@@ -43,6 +44,7 @@ napi-derive = { workspace = true }
 nom = { workspace = true }
 semver = { workspace = true }
 serde = { workspace = true }
+serde_json = { workspace = true, optional = true }
 strum = { workspace = true }
 strum_macros = { workspace = true }
 thiserror = { workspace = true }

crates/testlang/outputs/cargo/slang_testlang_node_addon/Cargo.toml

@@ -29,6 +29,7 @@ crate-type = ["cdylib"]
 default = ["slang_napi_interfaces"]
 slang_napi_interfaces = [
  # This enables '#[napi]' attributes on the Rust types imported via [lib.path] above.
+ "dep:serde_json",
 ]
 
 [build-dependencies]
@@ -43,6 +44,7 @@ napi-derive = { workspace = true }
 nom = { workspace = true }
 semver = { workspace = true }
 serde = { workspace = true }
+serde_json = { workspace = true, optional = true }
 strum = { workspace = true }
 strum_macros = { workspace = true }
 thiserror = { workspace = true }