move existing codegen_syntax to a legacy folder (#542)

NomicFoundation · Jul 24, 2023 · 14ec43a · 14ec43a
1 parent 0d04f95
commit 14ec43a
Show file tree

Hide file tree

Showing 99 changed files with 1,042 additions and 949 deletions.
diff --git a/.github/workflows/_jobs_check.yml b/.github/workflows/_jobs_check.yml
@@ -62,12 +62,6 @@ jobs:
  with:
  entrypoint: "scripts/cargo/test.sh"
 
- - name: "Run linters"
- if: "${{ (success() || failure()) && steps.installDependencies.outcome == 'success' }}"
- uses: "./.devcontainer"
- with:
- entrypoint: "scripts/lint/all.sh"
-
  - name: "NPM build"
  if: "${{ (success() || failure()) && steps.installDependencies.outcome == 'success' }}"
  uses: "./.devcontainer"
@@ -86,6 +80,12 @@ jobs:
  with:
  entrypoint: "scripts/mkdocs/build.sh"
 
+ - name: "Run linters"
+ if: "${{ (success() || failure()) && steps.installDependencies.outcome == 'success' }}"
+ uses: "./.devcontainer"
+ with:
+ entrypoint: "scripts/lint/all.sh"
+
  #
  # Update cache files:
  #

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,7 @@ publish = false
 members = [
  "crates/codegen/ebnf",
  "crates/codegen/syntax",
- "crates/codegen/syntax_templates",
+ "crates/codegen/legacy_syntax_templates",
  "crates/codegen/schema",
  "crates/codegen/spec",
  "crates/codegen/testing",

diff --git a/crates/codegen/syntax_templates/Cargo.toml → ...odegen/legacy_syntax_templates/Cargo.toml b/crates/codegen/syntax_templates/Cargo.toml → ...odegen/legacy_syntax_templates/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "codegen_syntax_templates"
+name = "codegen_legacy_syntax_templates"
 version.workspace = true
 rust-version.workspace = true
 edition.workspace = true

diff --git a/crates/codegen/syntax_templates/src/lib.rs → ...odegen/legacy_syntax_templates/src/lib.rs b/crates/codegen/syntax_templates/src/lib.rs → ...odegen/legacy_syntax_templates/src/lib.rs
@@ -1,5 +1,5 @@
 #[macro_use]
 extern crate napi_derive;
 
+pub mod napi;
 pub mod rust;
-pub mod typescript;
diff --git a/...mplates/src/typescript/cst_ts_wrappers.rs → ...tax_templates/src/napi/cst_ts_wrappers.rs b/...mplates/src/typescript/cst_ts_wrappers.rs → ...tax_templates/src/napi/cst_ts_wrappers.rs
@@ -11,7 +11,7 @@ use napi::bindgen_prelude::*;
 use napi::JsObject;
 use napi::NapiValue;
 
-#[napi(object)]
+#[napi(object, namespace = "legacy")]
 #[derive(Copy, Clone)]
 pub struct TextIndex {
  pub utf8: u32,
@@ -29,7 +29,7 @@ impl From<&RustTextIndex> for TextIndex {
  }
 }
 
-#[napi(object)]
+#[napi(object, namespace = "legacy")]
 #[derive(Copy, Clone)]
 pub struct TextRange {
  pub start: TextIndex,
@@ -45,19 +45,19 @@ impl From<&RustTextRange> for TextRange {
  }
 }
 
-#[napi(object)]
+#[napi(object, namespace = "legacy")]
 pub enum NodeType {
  Rule,
  Token,
 }
 
-#[napi]
+#[napi(namespace = "legacy")]
 pub struct RuleNode(Rc<RustRuleNode>);
 
-#[napi]
+#[napi(namespace = "legacy")]
 pub struct TokenNode(Rc<RustTokenNode>);
 
-#[napi]
+#[napi(namespace = "legacy")]
 impl RuleNode {
  #[napi(getter, js_name = "type", ts_return_type = "NodeType.Rule")]
  pub fn tipe(&self) -> NodeType {
@@ -88,7 +88,7 @@ impl RuleNode {
  }
 }
 
-#[napi]
+#[napi(namespace = "legacy")]
 impl TokenNode {
  #[napi(getter, js_name = "type", ts_return_type = "NodeType.Token")]
  pub fn tipe(&self) -> NodeType {

diff --git a/...ates/src/typescript/cursor_ts_wrappers.rs → ..._templates/src/napi/cursor_ts_wrappers.rs b/...ates/src/typescript/cursor_ts_wrappers.rs → ..._templates/src/napi/cursor_ts_wrappers.rs
@@ -7,10 +7,10 @@ use super::{
 use napi::bindgen_prelude::*;
 use napi::JsObject;
 
-#[napi]
+#[napi(namespace = "legacy")]
 pub struct Cursor(Box<RustCursor>);
 
-#[napi]
+#[napi(namespace = "legacy")]
 impl Cursor {
  pub(crate) fn new(cursor: RustCursor) -> Self {
  Self(Box::new(cursor))

diff --git a/.../syntax_templates/src/typescript/kinds.rs → ...legacy_syntax_templates/src/napi/kinds.rs b/.../syntax_templates/src/typescript/kinds.rs → ...legacy_syntax_templates/src/napi/kinds.rs
@@ -15,7 +15,7 @@ use serde::Serialize;
  strum_macros::AsRefStr,
  strum_macros::Display,
 )]
-#[napi]
+#[napi(namespace = "legacy")]
 pub enum TokenKind {
  SKIPPED,
  XXX,
@@ -32,7 +32,7 @@ pub enum TokenKind {
  strum_macros::AsRefStr,
  strum_macros::Display,
 )]
-#[napi]
+#[napi(namespace = "legacy")]
 pub enum RuleKind {
  XXX,
 }
@@ -48,7 +48,7 @@ pub enum RuleKind {
  strum_macros::AsRefStr,
  strum_macros::Display,
 )]
-#[napi]
+#[napi(namespace = "legacy")]
 pub enum ProductionKind {
  XXX,
 }
diff --git a/...en/syntax_templates/src/typescript/mod.rs → ...n/legacy_syntax_templates/src/napi/mod.rs b/...en/syntax_templates/src/typescript/mod.rs → ...n/legacy_syntax_templates/src/napi/mod.rs
diff --git a/..._templates/src/typescript/parse_output.rs → ...syntax_templates/src/napi/parse_output.rs b/..._templates/src/typescript/parse_output.rs → ...syntax_templates/src/napi/parse_output.rs
@@ -9,13 +9,13 @@ use super::{
 };
 use napi::bindgen_prelude::*;
 
-#[napi]
+#[napi(namespace = "legacy")]
 pub struct ParseOutput {
  pub(crate) parse_tree: cst::Node,
  pub(crate) errors: Vec<ParseError>,
 }
 
-#[napi]
+#[napi(namespace = "legacy")]
 impl ParseOutput {
  #[napi(getter, ts_return_type = "RuleNode | TokenNode | null")]
  pub fn parse_tree(&self, env: Env) -> napi::JsObject {
@@ -33,14 +33,14 @@ impl ParseOutput {
  }
 }
 
-#[napi]
+#[napi(namespace = "legacy")]
 #[derive(PartialEq, Clone)]
 pub struct ParseError {
  pub(crate) text_range: RustTextRange,
  pub(crate) tokens_that_would_have_allowed_more_progress: Vec<TokenKind>,
 }
 
-#[napi]
+#[napi(namespace = "legacy")]
 impl ParseError {
  #[napi(getter)]
  pub fn text_range(&self) -> TextRange {
@@ -59,7 +59,7 @@ impl ParseError {
  .collect();
  }
 
- #[napi]
+ #[napi(namespace = "legacy")]
  pub fn to_error_report(&self, source_id: String, source: String, with_colour: bool) -> String {
  return render_error_report(self, &source_id, &source, with_colour);
  }

diff --git a/...odegen/syntax_templates/src/rust/kinds.rs → ...legacy_syntax_templates/src/rust/kinds.rs b/...odegen/syntax_templates/src/rust/kinds.rs → ...legacy_syntax_templates/src/rust/kinds.rs
diff --git a/.../codegen/syntax_templates/src/rust/mod.rs → ...n/legacy_syntax_templates/src/rust/mod.rs b/.../codegen/syntax_templates/src/rust/mod.rs → ...n/legacy_syntax_templates/src/rust/mod.rs
diff --git a/...syntax_templates/src/rust/parse_output.rs → ...syntax_templates/src/rust/parse_output.rs b/...syntax_templates/src/rust/parse_output.rs → ...syntax_templates/src/rust/parse_output.rs
diff --git a/...odegen/syntax_templates/src/shared/cst.rs → ...legacy_syntax_templates/src/shared/cst.rs b/...odegen/syntax_templates/src/shared/cst.rs → ...legacy_syntax_templates/src/shared/cst.rs
@@ -28,8 +28,8 @@ pub enum Node {
  Token(Rc<TokenNode>),
 }
 
+#[allow(dead_code)]
 impl Node {
- #[allow(dead_code)]
  pub(crate) fn rule(kind: RuleKind, children: Vec<Self>) -> Self {
  let mut text_len = Default::default();
  for child in &children {
@@ -42,7 +42,6 @@ impl Node {
  }));
  }
 
- #[allow(dead_code)]
  pub(crate) fn token(kind: TokenKind, text: String) -> Self {
  Self::Token(Rc::new(TokenNode { kind, text }))
  }

diff --git a/...gen/syntax_templates/src/shared/cursor.rs → ...acy_syntax_templates/src/shared/cursor.rs b/...gen/syntax_templates/src/shared/cursor.rs → ...acy_syntax_templates/src/shared/cursor.rs
@@ -35,6 +35,7 @@ pub struct Cursor {
  is_completed: bool,
 }
 
+#[allow(dead_code)]
 impl Cursor {
  pub(crate) fn new(node: Node) -> Self {
  Self {

diff --git a/...n/syntax_templates/src/shared/language.rs → ...y_syntax_templates/src/shared/language.rs b/...n/syntax_templates/src/shared/language.rs → ...y_syntax_templates/src/shared/language.rs
diff --git a/...yntax_templates/src/shared/parse_error.rs → ...yntax_templates/src/shared/parse_error.rs b/...yntax_templates/src/shared/parse_error.rs → ...yntax_templates/src/shared/parse_error.rs
diff --git a/...x_templates/src/shared/parser_function.rs → ...x_templates/src/shared/parser_function.rs b/...x_templates/src/shared/parser_function.rs → ...x_templates/src/shared/parser_function.rs
diff --git a/...ax_templates/src/shared/parser_helpers.rs → ...ax_templates/src/shared/parser_helpers.rs b/...ax_templates/src/shared/parser_helpers.rs → ...ax_templates/src/shared/parser_helpers.rs
diff --git a/...tax_templates/src/shared/parser_result.rs → ...tax_templates/src/shared/parser_result.rs b/...tax_templates/src/shared/parser_result.rs → ...tax_templates/src/shared/parser_result.rs
diff --git a/..._templates/src/shared/scanner_function.rs → ..._templates/src/shared/scanner_function.rs b/..._templates/src/shared/scanner_function.rs → ..._templates/src/shared/scanner_function.rs
diff --git a/...ax_templates/src/shared/scanner_macros.rs → ...ax_templates/src/shared/scanner_macros.rs b/...ax_templates/src/shared/scanner_macros.rs → ...ax_templates/src/shared/scanner_macros.rs
diff --git a/...gen/syntax_templates/src/shared/stream.rs → ...acy_syntax_templates/src/shared/stream.rs b/...gen/syntax_templates/src/shared/stream.rs → ...acy_syntax_templates/src/shared/stream.rs
diff --git a/...syntax_templates/src/shared/text_index.rs → ...syntax_templates/src/shared/text_index.rs b/...syntax_templates/src/shared/text_index.rs → ...syntax_templates/src/shared/text_index.rs
diff --git a/...en/syntax_templates/src/shared/visitor.rs → ...cy_syntax_templates/src/shared/visitor.rs b/...en/syntax_templates/src/shared/visitor.rs → ...cy_syntax_templates/src/shared/visitor.rs
@@ -25,19 +25,22 @@ pub trait Visitor<E> {
  }
 }
 
+#[allow(dead_code)]
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub enum VisitorEntryResponse {
  Quit,
  StepIn,
  StepOver,
 }
 
+#[allow(dead_code)]
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub enum VisitorExitResponse {
  Quit,
  Continue,
 }
 
+#[allow(dead_code)]
 impl Cursor {
  pub fn drive_visitor<E, V: Visitor<E>>(
  &mut self,

diff --git a/crates/codegen/syntax/src/char_first_set.rs → ...degen/syntax/src/legacy/char_first_set.rs b/crates/codegen/syntax/src/char_first_set.rs → ...degen/syntax/src/legacy/char_first_set.rs
@@ -1,4 +1,4 @@
-use crate::char_set::CharSet;
+use crate::legacy::char_set::CharSet;
 
 pub struct CharFirstSet {
  pub includes_epsilon: bool,

diff --git a/crates/codegen/syntax/src/char_set.rs → crates/codegen/syntax/src/legacy/char_set.rs b/crates/codegen/syntax/src/char_set.rs → crates/codegen/syntax/src/legacy/char_set.rs
@@ -7,7 +7,7 @@ use codegen_schema::types::{ProductionDefinition, ScannerDefinition, ScannerRef}
 use proc_macro2::TokenStream;
 use quote::quote;
 
-use crate::combinator_tree::CombinatorTree;
+use crate::legacy::combinator_tree::CombinatorTree;
 
 #[derive(Clone, Debug)]
 pub struct CharSet(Vec<Range<u32>>);

diff --git a/crates/codegen/syntax/src/code_generator.rs → ...degen/syntax/src/legacy/code_generator.rs b/crates/codegen/syntax/src/code_generator.rs → ...degen/syntax/src/legacy/code_generator.rs
@@ -429,14 +429,14 @@ impl CodeGenerator {
  codegen.track_input_dir(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src"),
+ .join("crates/codegen/legacy_syntax_templates/src"),
  );
 
  codegen
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/cst.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/cst.rs"),
  &output_dir.join("cst.rs"),
  )
  .unwrap();
@@ -445,7 +445,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/cursor.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/cursor.rs"),
  &output_dir.join("cursor.rs"),
  )
  .unwrap();
@@ -454,7 +454,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/scanner_macros.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/scanner_macros.rs"),
  &output_dir.join("scanner_macros.rs"),
  )
  .unwrap();
@@ -463,7 +463,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/parser_helpers.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/parser_helpers.rs"),
  &output_dir.join("parser_helpers.rs"),
  )
  .unwrap();
@@ -472,7 +472,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/parse_error.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/parse_error.rs"),
  &output_dir.join("parse_error.rs"),
  )
  .unwrap();
@@ -481,7 +481,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/parser_function.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/parser_function.rs"),
  &output_dir.join("parser_function.rs"),
  )
  .unwrap();
@@ -490,7 +490,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/parser_result.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/parser_result.rs"),
  &output_dir.join("parser_result.rs"),
  )
  .unwrap();
@@ -499,7 +499,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/scanner_function.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/scanner_function.rs"),
  &output_dir.join("scanner_function.rs"),
  )
  .unwrap();
@@ -508,7 +508,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/stream.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/stream.rs"),
  &output_dir.join("stream.rs"),
  )
  .unwrap();
@@ -517,7 +517,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/text_index.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/text_index.rs"),
  &output_dir.join("text_index.rs"),
  )
  .unwrap();
@@ -526,7 +526,7 @@ impl CodeGenerator {
  .copy_file(
  &codegen
  .repo_root
- .join("crates/codegen/syntax_templates/src/shared/visitor.rs"),
+ .join("crates/codegen/legacy_syntax_templates/src/shared/visitor.rs"),
  &output_dir.join("visitor.rs"),
  )
  .unwrap();

diff --git a/.../codegen/syntax/src/combinator_context.rs → ...n/syntax/src/legacy/combinator_context.rs b/.../codegen/syntax/src/combinator_context.rs → ...n/syntax/src/legacy/combinator_context.rs
diff --git a/crates/codegen/syntax/src/combinator_node.rs → ...egen/syntax/src/legacy/combinator_node.rs b/crates/codegen/syntax/src/combinator_node.rs → ...egen/syntax/src/legacy/combinator_node.rs
diff --git a/crates/codegen/syntax/src/combinator_tree.rs → ...egen/syntax/src/legacy/combinator_tree.rs b/crates/codegen/syntax/src/combinator_tree.rs → ...egen/syntax/src/legacy/combinator_tree.rs