parseman 0.25.0 → 0.26.1

package/dist/language-service/index.d.ts

@@ -0,0 +1,94 @@
+/**
+ * `parseman/language-service` — the external, grammar-agnostic IDE layer.
+ *
+ * A grammar is pure structure (it carries no recovery/completion/lint config).
+ * `languageService(grammar, config)` layers editor behaviour ON TOP, keyed by rule
+ * name = node type, without ever modifying the grammar:
+ *
+ *   - `parse(src, { tolerant })` → CST + `ParseError[]` (recovers on the compiled
+ *     fast path when `grammar` is a `compile(g, { recovery: true })` grammar).
+ *   - `diagnostics(src)` → structural parse errors + your per-node-type lint rules.
+ *   - `completionsAt(src, offset)` → the grammar's expected-token set at the cursor,
+ *     mapped through your per-rule semantic completion handlers.
+ *
+ * The grammar can be the interpreter combinator OR a compiled grammar — the domain
+ * knowledge (what to suggest after `color:`, which nodes to lint) lives here, in the
+ * consumer's config, never in the grammar.
+ */
+import type { Combinator, ParseContext, ParseResult, Span, ParseError } from '../types.ts';
+import { type Walkable } from '../cst/walk.ts';
+import { type Registry } from '../functional/doc.ts';
+import type { NodeLike } from '../cst/types.ts';
+export type Severity = 'error' | 'warning' | 'info';
+export type Diagnostic = {
+    severity: Severity;
+    message: string;
+    span: Span;
+};
+export type CompletionItem = {
+    label: string;
+    detail?: string;
+};
+/** A CST node/leaf as a diagnostics handler sees it: the walk shape plus span/value. */
+export type LsNode = Walkable & {
+    readonly span: Span;
+    readonly value?: string;
+};
+/** Context handed to a completion handler: which rule the cursor sits in and the
+ * grammar's raw expected-token labels there. */
+export type CompletionContext = {
+    rule: string | null;
+    expected: string[];
+    offset: number;
+};
+export type LanguageServiceConfig = {
+    /** Lint/diagnostic rules keyed by node type (rule name). Return zero or more
+     * Diagnostics for each matching node. */
+    diagnostics?: Record<string, (node: LsNode) => Diagnostic | Diagnostic[] | null | undefined | void>;
+    /** Semantic completion handlers keyed by the rule the cursor is in. Turn the
+     * grammar's structural expectation into domain suggestions. */
+    complete?: Record<string, (ctx: CompletionContext) => CompletionItem[]>;
+};
+/** Grammar the service drives: an interpreter combinator or a compiled entry fn. */
+type Grammar = Combinator<unknown> | ((input: string, pos: number, ctx: ParseContext) => ParseResult<unknown>);
+/**
+ * What you hand `languageService`:
+ * - a single entry (combinator or `compile()`d fn) — stateless methods only, or
+ * - `{ rules, root }` (a `rules()` registry + its root rule name) — also unlocks
+ *   `openDocument`, the live incremental editor document.
+ */
+export type GrammarInput = Grammar | {
+    rules: Registry<NodeLike>;
+    root: string;
+};
+/**
+ * A live incremental document — the fused editor backend. Holds a tolerant
+ * `parseDoc` whose tree survives broken input (recovery) and re-parses only the
+ * edited span on `edit()`. Diagnostics walk the maintained tree (recovered errors
+ * ride inside it as `parseError` nodes), so they stay complete across edits without
+ * re-parsing the whole document.
+ */
+export type LsDocument = {
+    /** The current CST with ABSOLUTE spans (recovered errors embedded as parseError nodes). */
+    readonly tree: LsNode | null;
+    /** Apply an editor change (byte offsets in the CURRENT text); returns the next document. */
+    edit(from: number, to: number, replacement: string): LsDocument;
+    /** Structural parse errors (from the tree) + your per-node-type lint rules. */
+    diagnostics(): Diagnostic[];
+    /** Completions at a cursor offset in the current text. */
+    completionsAt(offset: number): CompletionItem[];
+};
+export type LanguageService = {
+    parse(src: string, opts?: {
+        tolerant?: boolean;
+    }): ParseResult<unknown> & {
+        errors: ParseError[];
+    };
+    diagnostics(src: string): Diagnostic[];
+    completionsAt(src: string, offset: number): CompletionItem[];
+    /** Open a live incremental document. Requires `languageService({ rules, root }, …)`. */
+    openDocument(src: string): LsDocument;
+};
+export declare function languageService(grammar: GrammarInput, config?: LanguageServiceConfig): LanguageService;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/language-service/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/language-service/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAI1F,OAAO,EAAQ,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAY,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAE9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE/C,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;AACnD,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAA;AAC5E,MAAM,MAAM,cAAc,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE/D,wFAAwF;AACxF,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAEhF;gDACgD;AAChD,MAAM,MAAM,iBAAiB,GAAG;IAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3F,MAAM,MAAM,qBAAqB,GAAG;IAClC;6CACyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAA;IACnG;mEAC+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,cAAc,EAAE,CAAC,CAAA;CACxE,CAAA;AAED,oFAAoF;AACpF,KAAK,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;AAE9G;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAEhF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2FAA2F;IAC3F,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,4FAA4F;IAC5F,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,UAAU,CAAA;IAC/D,+EAA+E;IAC/E,WAAW,IAAI,UAAU,EAAE,CAAA;IAC3B,0DAA0D;IAC1D,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,CAAA;CAChD,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG;QAAE,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE,CAAA;IAClG,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IACtC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,CAAA;IAC5D,wFAAwF;IACxF,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;CACtC,CAAA;AA8DD,wBAAgB,eAAe,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,GAAE,qBAA0B,GAAG,eAAe,CA0D1G"}