@bearcove/codemirror-lang-styx 0.1.0

package/src/index.ts

@@ -0,0 +1,247 @@
+import { parser } from "./syntax.grammar";
+import {
+  LRLanguage,
+  LanguageSupport,
+  foldNodeProp,
+  foldInside,
+  indentNodeProp,
+  continuedIndent,
+  syntaxTree,
+  foldService,
+  Language,
+} from "@codemirror/language";
+import { completeFromList } from "@codemirror/autocomplete";
+import { parseMixed } from "@lezer/common";
+import type { SyntaxNodeRef, Input, NestedParse, Parser } from "@lezer/common";
+
+/**
+ * Configuration for nested languages in heredocs.
+ * Maps language hints (e.g., "sql", "json") to CodeMirror LanguageSupport objects.
+ */
+export interface NestedLanguage {
+  /** Language hint as it appears after comma in heredoc (e.g., "sql" in <<SQL,sql) */
+  tag: string;
+  /** The CodeMirror LanguageSupport to use for parsing */
+  language: LanguageSupport;
+}
+
+/**
+ * Parse heredoc text to extract marker info.
+ * Returns { delimiter, langHint, contentStart, contentEnd }
+ */
+function parseHeredocText(text: string): {
+  delimiter: string;
+  langHint: string | null;
+  contentStart: number;
+  contentEnd: number;
+} | null {
+  // Format: <<DELIM[,lang]\n...content...\nDELIM
+  const match = text.match(/^<<([A-Z][A-Z0-9_]*)(?:,([a-z][a-z0-9_.-]*))?\r?\n/);
+  if (!match) return null;
+
+  const delimiter = match[1];
+  const langHint = match[2] || null;
+  const headerLen = match[0].length;
+
+  // Find where the closing delimiter starts
+  const delimPattern = new RegExp(`^[ \\t]*${delimiter}$`, "m");
+  const contentMatch = text.slice(headerLen).match(delimPattern);
+
+  if (!contentMatch || contentMatch.index === undefined) {
+    // No closing delimiter found - content goes to end
+    return {
+      delimiter,
+      langHint,
+      contentStart: headerLen,
+      contentEnd: text.length,
+    };
+  }
+
+  return {
+    delimiter,
+    langHint,
+    contentStart: headerLen,
+    contentEnd: headerLen + contentMatch.index,
+  };
+}
+
+/**
+ * Creates a parser wrapper that handles nested language injection for heredocs.
+ */
+function createMixedParser(nestedLanguages: NestedLanguage[]) {
+  const langMap = new Map<string, Parser>();
+  for (const { tag, language } of nestedLanguages) {
+    langMap.set(tag, language.language.parser);
+  }
+
+  return parseMixed((node: SyntaxNodeRef, input: Input): NestedParse | null => {
+    if (node.type.name !== "Heredoc") return null;
+
+    // Get the heredoc text
+    const text = input.read(node.from, node.to);
+    const parsed = parseHeredocText(text);
+
+    if (!parsed || !parsed.langHint) return null;
+
+    // Find the parser for this language hint
+    const nestedParser = langMap.get(parsed.langHint);
+    if (!nestedParser) return null;
+
+    // Return overlay for just the content portion
+    return {
+      parser: nestedParser,
+      overlay: [{ from: node.from + parsed.contentStart, to: node.from + parsed.contentEnd }],
+    };
+  });
+}
+
+// Custom fold service for Styx - finds Object/Sequence nodes and returns fold ranges
+const styxFoldService = foldService.of((state, lineStart, lineEnd) => {
+  const tree = syntaxTree(state);
+  let node = tree.resolveInner(lineEnd, -1);
+
+  // Walk up the tree looking for Object or Sequence
+  for (let cur: typeof node | null = node; cur; cur = cur.parent) {
+    if (cur.type.name === "Object" || cur.type.name === "Sequence") {
+      const first = cur.firstChild;
+      const last = cur.lastChild;
+      // Only fold if:
+      // 1. It spans multiple lines (first.to < last.from)
+      // 2. The opening brace is on THIS line (first.from >= lineStart)
+      if (first && last && first.to < last.from && first.from >= lineStart) {
+        return { from: first.to, to: last.from };
+      }
+    }
+  }
+  return null;
+});
+
+// Base parser props
+const baseProps = [
+  indentNodeProp.add({
+    Object: continuedIndent({ except: /^\s*\}/ }),
+    Sequence: continuedIndent({ except: /^\s*\)/ }),
+  }),
+  foldNodeProp.add({
+    Object: foldInside,
+    Sequence: foldInside,
+  }),
+];
+
+// Language definition with syntax highlighting and code folding
+// Using parser.configure() like @codemirror/lang-json does
+export const styxLanguage = LRLanguage.define({
+  name: "styx",
+  parser: parser.configure({ props: baseProps }),
+  languageData: {
+    commentTokens: { line: "//" },
+    closeBrackets: { brackets: ["(", "{", '"'] },
+  },
+});
+
+/**
+ * Create a Styx language with nested language support for heredocs.
+ */
+function createStyxLanguage(nestedLanguages: NestedLanguage[]): LRLanguage {
+  if (nestedLanguages.length === 0) {
+    return styxLanguage;
+  }
+
+  const mixedParser = parser.configure({
+    props: baseProps,
+    wrap: createMixedParser(nestedLanguages),
+  });
+
+  return LRLanguage.define({
+    name: "styx",
+    parser: mixedParser,
+    languageData: {
+      commentTokens: { line: "//" },
+      closeBrackets: { brackets: ["(", "{", '"'] },
+    },
+  });
+}
+
+// Common Styx schema tags for autocompletion
+const builtinTags = [
+  "@string",
+  "@int",
+  "@float",
+  "@bool",
+  "@null",
+  "@object",
+  "@array",
+  "@optional",
+  "@required",
+  "@default",
+  "@enum",
+  "@pattern",
+  "@min",
+  "@max",
+  "@minLength",
+  "@maxLength",
+].map((label) => ({ label, type: "keyword" }));
+
+// Basic autocompletion for tags
+const styxCompletion = styxLanguage.data.of({
+  autocomplete: completeFromList(builtinTags),
+});
+
+/**
+ * Configuration options for Styx language support.
+ */
+export interface StyxConfig {
+  /**
+   * Nested languages for heredoc content.
+   * Maps language hints to CodeMirror Language objects.
+   *
+   * Example:
+   * ```ts
+   * import { sql } from "@codemirror/lang-sql";
+   *
+   * styx({
+   *   nestedLanguages: [
+   *     { tag: "sql", language: sql() }
+   *   ]
+   * })
+   * ```
+   */
+  nestedLanguages?: NestedLanguage[];
+}
+
+/**
+ * Styx language support for CodeMirror 6.
+ *
+ * Usage:
+ * ```ts
+ * import { styx } from "@bearcove/codemirror-lang-styx";
+ * import { EditorView, basicSetup } from "codemirror";
+ *
+ * new EditorView({
+ *   extensions: [basicSetup, styx()],
+ *   parent: document.body,
+ * });
+ * ```
+ *
+ * With nested language support:
+ * ```ts
+ * import { sql } from "@codemirror/lang-sql";
+ *
+ * new EditorView({
+ *   extensions: [basicSetup, styx({ nestedLanguages: [{ tag: "sql", language: sql() }] })],
+ *   parent: document.body,
+ * });
+ * ```
+ */
+export function styx(config: StyxConfig = {}): LanguageSupport {
+  const nestedLanguages = config.nestedLanguages || [];
+  const lang = createStyxLanguage(nestedLanguages);
+
+  // Collect nested language supports for proper extension loading
+  const nestedSupports = nestedLanguages.flatMap((n) => n.language.support);
+
+  return new LanguageSupport(lang, [styxCompletion, styxFoldService, ...nestedSupports]);
+}
+
+// Re-export for advanced usage
+export { parser } from "./syntax.grammar";

package/src/styx.grammar

@@ -0,0 +1,110 @@
+// Lezer grammar for Styx configuration language
+// Simplified for syntax highlighting
+
+@top Document { line* }
+
+line {
+  Comment newline |
+  DocComment newline |
+  Entry newline |
+  newline
+}
+
+@skip { whitespace }
+
+Entry { KeyExpr ValueExpr? }
+
+KeyExpr {
+  Tag ~tagAmb KeyPayload |
+  Tag ~tagAmb |
+  KeyAtom
+}
+
+ValueExpr {
+  Tag ~tagAmb ValuePayload |
+  Tag ~tagAmb |
+  ValueAtom
+}
+
+Tag { tagName }
+
+KeyPayload { QuotedScalar | RawScalar | Sequence | Object | Unit | Attributes }
+ValuePayload { QuotedScalar | RawScalar | Sequence | Object | Unit | Attributes }
+
+KeyAtom { BareScalar | QuotedScalar | RawScalar | Sequence | Object | Unit | Attributes }
+ValueAtom { BareScalar | QuotedScalar | RawScalar | Heredoc | Sequence | Object | Unit | Attributes }
+
+BareScalar { bareWord }
+
+QuotedScalar { stringLiteral }
+
+RawScalar { rawString }
+
+Heredoc { heredoc }
+
+Unit { unitAt }
+
+Sequence { "(" SeqContent? ")" }
+
+SeqContent { newline* SeqItem (newline* SeqItem)* newline* }
+
+SeqItem {
+  Tag ~tagAmb SeqPayload |
+  Tag ~tagAmb |
+  SeqAtom
+}
+
+SeqPayload { QuotedScalar | RawScalar | Sequence | Object | Unit | Attributes }
+SeqAtom { BareScalar | QuotedScalar | RawScalar | Sequence | Object | Unit | Attributes }
+
+Object { "{" ObjContent? "}" }
+
+ObjContent { ObjSep* ObjItem (ObjSep ObjItem)* ObjSep* }
+
+ObjItem { DocComment? Entry }
+
+ObjSep { "," | newline }
+
+Attributes { attributeGroup }
+
+Comment { lineComment }
+DocComment { docCommentLine+ }
+
+docCommentLine { docCommentToken }
+
+@tokens {
+  whitespace { $[ \t]+ }
+  newline { "\r"? "\n" }
+
+  lineComment { "//" ![/\n\r] ![^\n\r]* }
+  docCommentToken { "///" ![^\n\r]* "\r"? "\n" }
+
+  tagName { "@" $[A-Za-z_] $[A-Za-z0-9_\-]* }
+  unitAt { "@" }
+
+  bareWord { ![{}\(\),"=@<>\r\n\t ] ![{}\(\),"<>\r\n\t ]* }
+
+  // Attribute group: one or more key>value pairs
+  attributeGroup {
+    ![{}\(\),"=@>\r\n\t ] ![{}\(\),">\r\n\t ]* ">" ![{}\(\),"\r\n\t ]+
+    ($[ \t]+ ![{}\(\),"=@>\r\n\t ] ![{}\(\),">\r\n\t ]* ">" ![{}\(\),"\r\n\t ]+)*
+  }
+
+  // String literal as a single token
+  stringLiteral { '"' (!["\\\n\r] | "\\" ![])* '"' }
+
+  rawString { "r" "#"* '"' !["]* '"' "#"* }
+
+  "(" ")" "{" "}" "," ">"
+
+  @precedence {
+    tagName, unitAt, docCommentToken, lineComment,
+    rawString, attributeGroup, bareWord
+  }
+}
+
+@external tokens heredocTokenizer from "./heredoc" { heredoc }
+
+@external propSource styxHighlight from "./highlight"
+
+@detectDelim

package/src/syntax.grammar.terms.ts

@@ -0,0 +1,29 @@
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+export const
+  heredoc = 39,
+  Document = 1,
+  Comment = 2,
+  DocComment = 3,
+  Entry = 4,
+  KeyExpr = 5,
+  Tag = 6,
+  KeyPayload = 7,
+  QuotedScalar = 8,
+  RawScalar = 9,
+  Sequence = 12,
+  SeqContent = 13,
+  SeqItem = 14,
+  SeqPayload = 15,
+  Object = 18,
+  ObjContent = 19,
+  ObjSep = 20,
+  ObjItem = 22,
+  Unit = 23,
+  Attributes = 24,
+  SeqAtom = 25,
+  BareScalar = 26,
+  KeyAtom = 27,
+  ValueExpr = 28,
+  ValuePayload = 29,
+  ValueAtom = 30,
+  Heredoc = 31

package/src/syntax.grammar.ts

@@ -0,0 +1,23 @@
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+import {LRParser} from "@lezer/lr"
+import {heredocTokenizer} from "./heredoc"
+import {styxHighlight} from "./highlight"
+export const parser = LRParser.deserialize({
+  version: 14,
+  states: "*tQVQPOOOOQO'#C^'#C^OzQPO'#C_OOQQ'#Cb'#CbOOQQ'#Cd'#CdOOQQ'#Ce'#CeO#aQPO'#CnOOQQ'#Cs'#CsOOQQ'#Ct'#CtOOQQ'#Cv'#CvO$VQPO'#ChOOQQ'#Cw'#CwO$rQRO'#CaOOQQ'#Ca'#CaO%lQRO'#C`O&SQPO'#DWOOQO'#DW'#DWOOQO'#C|'#C|QVQPOOOOQO'#C}'#C}OOQO-E6{-E6{OOQO'#Cp'#CpOOQO'#DP'#DPO!lQPO'#CoOOQO'#Cr'#CrO&XQPO'#CrO&cQPO'#CoOOQQ,59Y,59YO&nQPO,59YOOQO'#DO'#DOO#hQPO'#CiOOQO'#Cu'#CuO&sQPO'#CjOOQO'#Cj'#CjO'gQPO'#CiOOQQ,59S,59SO'nQPO,59SOOQQ'#Cc'#CcOOQQ,58{,58{OOQO'#C{'#C{OOQO'#Cz'#CzO'sQPO'#CxOOQO'#Cx'#CxOOQO,58z,58zOOQO,59r,59rOOQO-E6z-E6zOOQO-E6}-E6}O(QQPO,59ZOOQO,59^,59^O(]QPO'#DPO(QQPO,59ZO(QQPO,59ZOOQQ1G.t1G.tOOQO-E6|-E6|O(sQPO,59TOOQO'#Ck'#CkOOQO,59U,59UO(sQPO,59TOOQO'#DR'#DRO(sQPO,59TOOQQ1G.n1G.nOOQO'#Cy'#CyOOQO,59d,59dO(zQPO1G.uO(zQPO1G.uOOQO,59l,59lOOQO-E7O-E7OO)VQPO1G.oO)VQPO1G.oOOQO,59m,59mOOQO-E7P-E7PO)^QPO7+$aP)iQPO'#DQO)vQPO7+$ZP#hQPO'#DO",
+  stateData: "*W~OyOS~OZYOaUO{PO|`O}cO!ORO!PSO!QTO!RVO!SWO!TXO~O}cO|RXZRXaRX!ORX!PRX!QRX!RRX!SRX!TRX~OZYOaUOeeO|eO}cO!ORO!PSO!QTO!RVO!SWO!TXO~O`kO~P!lOZYOaUO|mO!ORO!PSO!QTO!RVO!SWO!TXO~OYsO~P#hOZYOaUO!PSO!QTO!RVO!SWO~OZTXaTXwTX|TX!OTX!PTX!QTX!RTX!STX!TTX`TXeTX~P$^OwwO!ORO!TXO|SX`SXeSX~P$^O||O~O!ORO!TXO~P$^OeeO|eO`cX~O`!UO~OY^XZ^Xa^X|^X!O^X!P^X!Q^X!R^X!S^X!T^X~P$^OY]X~P#hOY!^O~O|lX`lXelX~P$^OeeO|eO`ca~O}cO!ORO!TXO`sXesX|sX~P$^OY]a~P#hOeeO|eO`ci~OY]i~P#hOeeO|eO`cq~O}cO!ORO!TXO~P$^OY]q~P#hO!O!R}{!Q!S!T{~",
+  goto: "(Q{PP|!Q![!i!r#[#_#_PP#_$Q$T$gPP#_$j$mP$z#_#_%U%b%z&T&W&Z%w&^&d&o'T'h'rPPPP'|T_ObS_ObXiUg!R!jS_ObWhUg!R!jR!Qi_^OUbgi!R!j^[OUbgi!R!jdpYnr!W!Z!]!e!f!k!lRy^Rv[^ZOUbgi!R!jdoYnr!W!Z!]!e!f!k!lQu[Qx^Q!XpR!_yRtYQrYQ!WnW![r!W!]!fX!g!Z!e!k!lR!YpRlUYfUg!S!a!iX!Rj!P!T!bQjUQ!PgT!c!R!jeqYnr!W!Z!]!e!f!k!l^ZOUbgi!R!jdoYnr!W!Z!]!e!f!k!lRx^_]OUbgi!R!jR{^R!`yRz^QbOR}b[QOUbg!R!jRdQQnYY!Vn!Z!e!k!lQ!ZrS!e!W!]R!k!fQgUW!Og!S!a!iQ!SjS!a!P!TR!i!bQ!TjQ!b!PT!d!T!bQ!]rQ!f!WT!h!]!fTaOb",
+  nodeNames: "⚠ Document Comment DocComment Entry KeyExpr Tag KeyPayload QuotedScalar RawScalar ) ( Sequence SeqContent SeqItem SeqPayload } { Object ObjContent ObjSep , ObjItem Unit Attributes SeqAtom BareScalar KeyAtom ValueExpr ValuePayload ValueAtom Heredoc",
+  maxTerm: 51,
+  nodeProps: [
+    ["openedBy", 10,"(",16,"{"],
+    ["closedBy", 11,")",17,"}"]
+  ],
+  propSources: [styxHighlight],
+  skippedNodes: [0],
+  repeatNodeCount: 6,
+  tokenData: "B[~RmOX!|XY(UYZ(aZ]!|]^(f^p!|pq(Uqr!|rs(lsx!|xy)syz)xz|!||})}}!P!|!P!Q*S!Q!^!|!^!_$Q!a!b!|!b!c?b!c#f!|#f#g@U#g#o!|#o#pBQ#p#q!|#q#rBV#r;'S!|;'S;=`(O<%lO!|~#R_!T~OX!|Z]!|^p!|qr!|sx!|z|!|}!^!|!^!_$Q!_!`!|!`!a$|!a#o!|#p#q!|#r;'S!|;'S;=`(O<%lO!|~$T]OX$QZ]$Q^p$Qqr$Qsx$Qz|$Q}!`$Q!`!a$|!a#o$Q#p#q$Q#r;'S$Q;'S;=`'r<%lO$Q~%PZOX%rZ]%r^p%rqr%rsx%rz|%r}#o%r#p#q%r#r;'S%r;'S;=`'x<%lO%r~%w]!S~OX%rXY&pZ]%r^p%rpq&pqr%rsx%rz|%r}#o%r#p#q%r#r;'S%r;'S;=`'x<%lO%r~&s_OX$QXY&pZ]$Q^p$Qpq&pqr$Qsx$Qz|$Q}!_$Q!a!b$Q!c#o$Q#p#q$Q#r;'S$Q;'S;=`'r<%lO$Q~'uP;=`<%l$Q~'{P;=`<%l%r~(RP;=`<%l!|~(ZQy~XY(Upq(U~(fO|~~(iPYZ(a~(oXOY(lZ](l^r(lrs)[s#O(l#O#P)a#P;'S(l;'S;=`)m<%lO(l~)aO!P~~)dRO;'S(l;'S;=`)m<%lO(l~)pP;=`<%l(l~)xOZ~~)}OY~~*SOe~~*Xa!T~OX!|Z]!|^p!|qr!|sx!|z|!|}!P!|!P!Q+^!Q!^!|!^!_$Q!_!`!|!`!a$|!a#o!|#p#q!|#r;'S!|;'S;=`(O<%lO!|~+ch!T~OX,}XY.pZ],}^p,}pq.pqr,}rs.psx,}xz.pz|,}|}.p}!P,}!P!Q5u!Q!^,}!^!_/_!_!`,}!`!a0x!a#o,}#o#p.p#p#q,}#q#r.p#r;'S,};'S;=`5o<%lO,}~-Uh{~!T~OX,}XY.pZ],}^p,}pq.pqr,}rs.psx,}xz.pz|,}|}.p}!^,}!^!_/_!_!`,}!`!a0x!a#Q,}#Q#R!|#R#o,}#o#p.p#p#q,}#q#r.p#r;'S,};'S;=`5o<%lO,}~.uU{~OY.pZ].p^#Q.p#R;'S.p;'S;=`/X<%lO.p~/[P;=`<%l.p~/df{~OX/_XY.pZ]/_^p/_pq.pqr/_rs.psx/_xz.pz|/_|}.p}!`/_!`!a0x!a#Q/_#Q#R$Q#R#o/_#o#p.p#p#q/_#q#r.p#r;'S/_;'S;=`5c<%lO/_~0}d{~OX2]XY.pZ]2]^p2]pq.pqr2]rs.psx2]xz.pz|2]|}.p}#Q2]#Q#R%r#R#o2]#o#p.p#p#q2]#q#r.p#r;'S2];'S;=`5i<%lO2]~2dd{~!S~OX2]XY3rZ]2]^p2]pq3rqr2]rs.psx2]xz.pz|2]|}.p}#Q2]#Q#R%r#R#o2]#o#p.p#p#q2]#q#r.p#r;'S2];'S;=`5i<%lO2]~3wh{~OX/_XY3rZ]/_^p/_pq3rqr/_rs.psx/_xz.pz|/_|}.p}!_/_!_!a.p!a!b/_!b!c.p!c#Q/_#Q#R$Q#R#o/_#o#p.p#p#q/_#q#r.p#r;'S/_;'S;=`5c<%lO/_~5fP;=`<%l/_~5lP;=`<%l2]~5rP;=`<%l,}~5zj!T~OX5uXY7lYZ8XZ]5u]^8^^p5upq7lqr5urs7lsx5uxz7lz|5u|}7l}!^5u!^!_8j!_!`5u!`!a:X!a#Q5u#Q#R!|#R#o5u#o#p7l#p#q5u#q#r7l#r;'S5u;'S;=`?[<%lO5u~7oWOY7lYZ8XZ]7l]^8^^#Q7l#R;'S7l;'S;=`8d<%lO7l~8^O}~~8aPYZ8X~8gP;=`<%l7l~8mhOX8jXY7lYZ8XZ]8j]^8^^p8jpq7lqr8jrs7lsx8jxz7lz|8j|}7l}!`8j!`!a:X!a#Q8j#Q#R$Q#R#o8j#o#p7l#p#q8j#q#r7l#r;'S8j;'S;=`?O<%lO8j~:[fOX;pXY7lYZ8XZ];p]^8^^p;ppq7lqr;prs7lsx;pxz7lz|;p|}7l}#Q;p#Q#R%r#R#o;p#o#p7l#p#q;p#q#r7l#r;'S;p;'S;=`?U<%lO;p~;uf!S~OX;pXY=ZYZ8XZ];p]^8^^p;ppq=Zqr;prs7lsx;pxz7lz|;p|}7l}#Q;p#Q#R%r#R#o;p#o#p7l#p#q;p#q#r7l#r;'S;p;'S;=`?U<%lO;p~=^jOX8jXY=ZYZ8XZ]8j]^8^^p8jpq=Zqr8jrs7lsx8jxz7lz|8j|}7l}!_8j!_!a7l!a!b8j!b!c7l!c#Q8j#Q#R$Q#R#o8j#o#p7l#p#q8j#q#r7l#r;'S8j;'S;=`?O<%lO8j~?RP;=`<%l8j~?XP;=`<%l;p~?_P;=`<%l5u~?gR!R~!c!}?p#R#S?p#T#o?p~?uT!O~}!O?p!Q![?p!c!}?p#R#S?p#T#o?p~@Za!T~OX!|Z]!|^p!|qr!|rsA`st@Utx!|z|!|}!^!|!^!_$Q!_!`!|!`!a$|!a#o!|#p#q!|#r;'S!|;'S;=`(O<%lO!|~AcTOrA`rsArs;'SA`;'S;=`Az<%lOA`~AwP!Q~stAr~A}P;=`<%lA`~BVOa~~B[O`~",
+  tokenizers: [0, heredocTokenizer],
+  topRules: {"Document":[0,1]},
+  tokenPrec: 413
+})