@tabnas/parser 0.2.0

package/dist/defaults.js

@@ -0,0 +1,301 @@
+"use strict";
+/* Copyright (c) 2013-2026 Richard Rodger, MIT License */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaults = void 0;
+// Functions that create token matching lexers.
+// The `make*Matcher` functions may optionally initialise
+// and validate Config properties specific to their lexing.
+const lexer_1 = require("./lexer");
+const defaults = {
+    // Prevent prototype pollution
+    safe: {
+        key: true,
+    },
+    // Default tag - set your own!
+    tag: '-',
+    // Fixed token lexing.
+    fixed: {
+        // Recognize fixed tokens in the Lexer.
+        lex: true,
+        // Token names.
+        token: {
+            '#OB': '{',
+            '#CB': '}',
+            '#OS': '[',
+            '#CS': ']',
+            '#CL': ':',
+            '#CA': ',',
+        },
+    },
+    match: {
+        lex: true,
+        token: {},
+    },
+    // Token sets.
+    tokenSet: {
+        IGNORE: ['#SP', '#LN', '#CM'],
+        VAL: ['#TX', '#NR', '#ST', '#VL'],
+        KEY: ['#TX', '#NR', '#ST', '#VL'],
+    },
+    // Recognize space characters in the lexer.
+    space: {
+        // Recognize space in the Lexer.
+        lex: true,
+        // Space characters are kept to a minimal set.
+        // Add more from https://en.wikipedia.org/wiki/Whitespace_character as needed.
+        chars: ' \t',
+    },
+    // Line lexing.
+    line: {
+        // Recognize lines in the Lexer.
+        lex: true,
+        // Line characters.
+        chars: '\r\n',
+        // Increments row (aka line) counter.
+        rowChars: '\n',
+        // Generate separate lexer tokens for each newline.
+        // Note: '\r\n' counts as one newline.
+        single: false,
+    },
+    // Text formats.
+    text: {
+        // Recognize text (non-quoted strings) in the Lexer.
+        lex: true,
+    },
+    // Control number formats.
+    number: {
+        // Recognize numbers in the Lexer.
+        lex: true,
+        // Recognize hex numbers (eg. 10 === 0x0a).
+        hex: true,
+        // Recognize octal numbers (eg. 10 === 0o12).
+        oct: true,
+        // Recognize binary numbers (eg. 10 === 0b1010).
+        bin: true,
+        // All possible number chars. |+-|0|xob|0-9a-fA-F|.e|+-|0-9a-fA-F|
+        // digital: '-1023456789._xoeEaAbBcCdDfF+',
+        // Allow embedded separator. `null` to disable.
+        sep: '_',
+        // Exclude number strings matching this RegExp
+        exclude: undefined,
+    },
+    // Comment markers.
+    // <mark-char>: true -> single line comments
+    // <mark-start>: <mark-end> -> multiline comments
+    comment: {
+        // Recognize comments in the Lexer.
+        lex: true,
+        // TODO: plugin
+        // Balance multiline comments.
+        // balance: true,
+        // Comment markers.
+        def: {
+            hash: { line: true, start: '#', lex: true, eatline: false },
+            slash: { line: true, start: '//', lex: true, eatline: false },
+            multi: {
+                line: false,
+                start: '/' + '*',
+                end: '*' + '/',
+                lex: true,
+                eatline: false,
+            },
+        },
+    },
+    // String formats.
+    string: {
+        // Recognize strings in the Lexer.
+        lex: true,
+        // Quote characters
+        chars: '\'"`',
+        // Multiline quote chars.
+        multiChars: '`',
+        // Escape character.
+        escapeChar: '\\',
+        // String escape chars.
+        // Denoting char (follows escape char) => actual char.
+        escape: {
+            b: '\b',
+            f: '\f',
+            n: '\n',
+            r: '\r',
+            t: '\t',
+            v: '\v',
+            // These preserve standard escapes when allowUnknown=false.
+            '"': '"',
+            "'": "'",
+            '`': '`',
+            '\\': '\\',
+            '/': '/',
+        },
+        // Allow unknown escape characters - they are copied to output: '\w' -> 'w'.
+        allowUnknown: true,
+        // Restrict escapes to the standard set: disable the non-standard
+        // structural escapes \xHH and \u{...} (plain \uXXXX stays).
+        escapeStrict: false,
+        // If string lexing fails, instead of error, allow other matchers to try.
+        abandon: false,
+    },
+    // Object formats.
+    map: {
+        // TODO: or trigger error?
+        // Later duplicates extend earlier ones, rather than replacing them.
+        extend: true,
+        // Custom merge function for duplicates (optional).
+        // TODO: needs function signature
+        merge: undefined,
+        // Allow bare colon `:value` in maps, stored as `child$` property.
+        child: false,
+    },
+    // Array formats.
+    list: {
+        // Allow arrays to have properties: `[a:9,0,1]`
+        property: true,
+        // Parse pairs as object elements: `[a:1]` -> `[{"a":1}]`
+        // Takes precedence over list.property when true.
+        pair: false,
+        // Parse bare colon as child$ property: `[:1]` -> [] with child$=1
+        // Multiple child values merge.
+        child: false,
+    },
+    // Metadata info markers. When enabled, a non-enumerable marker property
+    // is attached to parsed nodes with metadata (implicit flag, meta bag, etc.).
+    info: {
+        // Attach marker to map nodes.
+        map: false,
+        // Attach marker to list nodes.
+        list: false,
+        // Wrap string values as String objects with marker (quote info).
+        text: false,
+        // Property name for the marker.
+        marker: '__info__',
+    },
+    // Keyword values.
+    value: {
+        lex: true,
+        def: {
+            true: { val: true },
+            false: { val: false },
+            null: { val: null },
+        },
+    },
+    // Additional text ending characters
+    ender: [],
+    // Plugin custom options, (namespace by plugin name).
+    plugin: {},
+    // Debug settings
+    debug: {
+        // Default console for logging.
+        get_console: () => console,
+        // Max length of parse value to print.
+        maxlen: 99,
+        // Print internal structures
+        print: {
+            // Print config built from options.
+            config: false,
+            // Custom string formatter for src and node values.
+            src: undefined,
+        },
+    },
+    // Error messages.
+    error: {
+        unknown: 'unknown error: {code}',
+        unexpected: 'unexpected character(s): {src}',
+        invalid_unicode: 'invalid unicode escape: {src}',
+        invalid_ascii: 'invalid ascii escape: {src}',
+        unprintable: 'unprintable character: {src}',
+        unterminated_string: 'unterminated string: {src}',
+        unterminated_comment: 'unterminated comment: {src}',
+        unknown_rule: 'unknown rule: {rulename}',
+        end_of_source: 'unexpected end of source',
+    },
+    errmsg: {
+        name: 'tabnas',
+        suffix: true
+    },
+    // Error hints: {error-code: hint-text}.
+    hint: {
+        unknown: `
+Unknown error code: {code}
+Details:
+{details}`,
+        unexpected: `
+The character(s) {src} do not match any rule alternative active at
+this position.`,
+        invalid_unicode: `
+The escape sequence {src} does not encode a valid unicode code point.`,
+        invalid_ascii: `
+The escape sequence {src} does not encode a valid ASCII character.`,
+        unprintable: `
+The character {src} (code point below 32) is not allowed inside a
+string literal.`,
+        unterminated_string: `
+This string has no end quote.`,
+        unterminated_comment: `
+This comment is never closed.`,
+        unknown_rule: `
+No rule named $rulename is defined.`,
+        end_of_source: `
+Unexpected end of source.`,
+    },
+    // Lexer
+    lex: {
+        match: {
+            match: { order: 1e6, make: lexer_1.makeMatchMatcher },
+            fixed: { order: 2e6, make: lexer_1.makeFixedMatcher },
+            space: { order: 3e6, make: lexer_1.makeSpaceMatcher },
+            line: { order: 4e6, make: lexer_1.makeLineMatcher },
+            string: { order: 5e6, make: lexer_1.makeStringMatcher },
+            comment: { order: 6e6, make: lexer_1.makeCommentMatcher },
+            number: { order: 7e6, make: lexer_1.makeNumberMatcher },
+            text: { order: 8e6, make: lexer_1.makeTextMatcher },
+        },
+        // Empty string is allowed and returns undefined
+        empty: true,
+        emptyResult: undefined,
+    },
+    // Parser
+    parse: {
+        // Plugin custom functions to prepare parser context.
+        prepare: {},
+    },
+    // Parser rule options.
+    rule: {
+        // Name of the starting rule.
+        start: 'val',
+        // Automatically close remaining structures at EOF.
+        finish: true,
+        // Multiplier to increase the maximum number of rule occurrences.
+        maxmul: 3,
+        // Include only those alts with matching group tags (comma sep).
+        // NOTE: applies universally, thus also for subsequent rules.
+        include: '',
+        // Exclude alts with matching group tags (comma sep).
+        // NOTE: applies universally, thus also for subsequent rules.
+        exclude: '',
+    },
+    // Result value options.
+    result: {
+        // Fail if result matches any of these.
+        fail: [],
+    },
+    // Token-rewind options. `history` bounds how many consumed tokens
+    // are retained on ctx.v for ctx.rewind(). The default of 64 keeps
+    // parse-time memory bounded for large inputs; raise it if a
+    // grammar needs to rewind further, or set to Infinity to retain
+    // every consumed token. ctx.rewind(mark) throws if `mark` falls
+    // outside the retained window.
+    rewind: {
+        history: 64,
+    },
+    // Configuration options.
+    config: {
+        // Configuration modifiers.
+        modify: {},
+    },
+    // Provide a custom parser.
+    parser: {
+        start: undefined,
+    },
+};
+exports.defaults = defaults;
+//# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../src/defaults.ts"],"names":[],"mappings":";AAAA,yDAAyD;;;AAQzD,+CAA+C;AAC/C,yDAAyD;AACzD,2DAA2D;AAC3D,mCASgB;AAGhB,MAAM,QAAQ,GAAkB;IAC9B,8BAA8B;IAC9B,IAAI,EAAE;QACJ,GAAG,EAAE,IAAI;KACV;IAED,8BAA8B;IAC9B,GAAG,EAAE,GAAG;IAER,sBAAsB;IACtB,KAAK,EAAE;QACL,uCAAuC;QACvC,GAAG,EAAE,IAAI;QAET,eAAe;QACf,KAAK,EAAE;YACL,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,GAAG;SACX;KACF;IAED,KAAK,EAAE;QACL,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,EAAE;KACV;IAED,cAAc;IACd,QAAQ,EAAE;QACR,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7B,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACjC,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KAClC;IAED,2CAA2C;IAC3C,KAAK,EAAE;QACL,gCAAgC;QAChC,GAAG,EAAE,IAAI;QAET,8CAA8C;QAC9C,8EAA8E;QAC9E,KAAK,EAAE,KAAK;KACb;IAED,eAAe;IACf,IAAI,EAAE;QACJ,gCAAgC;QAChC,GAAG,EAAE,IAAI;QAET,mBAAmB;QACnB,KAAK,EAAE,MAAM;QAEb,qCAAqC;QACrC,QAAQ,EAAE,IAAI;QAEd,mDAAmD;QACnD,sCAAsC;QACtC,MAAM,EAAE,KAAK;KACd;IAED,gBAAgB;IAChB,IAAI,EAAE;QACJ,oDAAoD;QACpD,GAAG,EAAE,IAAI;KACV;IAED,0BAA0B;IAC1B,MAAM,EAAE;QACN,kCAAkC;QAClC,GAAG,EAAE,IAAI;QAET,2CAA2C;QAC3C,GAAG,EAAE,IAAI;QAET,6CAA6C;QAC7C,GAAG,EAAE,IAAI;QAET,gDAAgD;QAChD,GAAG,EAAE,IAAI;QAET,kEAAkE;QAClE,2CAA2C;QAE3C,+CAA+C;QAC/C,GAAG,EAAE,GAAG;QAER,8CAA8C;QAC9C,OAAO,EAAE,SAAS;KACnB;IAED,mBAAmB;IACnB,4CAA4C;IAC5C,iDAAiD;IACjD,OAAO,EAAE;QACP,mCAAmC;QACnC,GAAG,EAAE,IAAI;QAET,eAAe;QACf,8BAA8B;QAC9B,iBAAiB;QAEjB,mBAAmB;QACnB,GAAG,EAAE;YACH,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE;YAC3D,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE;YAC7D,KAAK,EAAE;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,GAAG,GAAG,GAAG;gBAChB,GAAG,EAAE,GAAG,GAAG,GAAG;gBACd,GAAG,EAAE,IAAI;gBACT,OAAO,EAAE,KAAK;aACf;SACF;KACF;IAED,kBAAkB;IAClB,MAAM,EAAE;QACN,kCAAkC;QAClC,GAAG,EAAE,IAAI;QAET,mBAAmB;QACnB,KAAK,EAAE,MAAM;QAEb,yBAAyB;QACzB,UAAU,EAAE,GAAG;QAEf,oBAAoB;QACpB,UAAU,EAAE,IAAI;QAEhB,uBAAuB;QACvB,sDAAsD;QACtD,MAAM,EAAE;YACN,CAAC,EAAE,IAAI;YACP,CAAC,EAAE,IAAI;YACP,CAAC,EAAE,IAAI;YACP,CAAC,EAAE,IAAI;YACP,CAAC,EAAE,IAAI;YACP,CAAC,EAAE,IAAI;YAEP,2DAA2D;YAC3D,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,GAAG;YACR,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,GAAG;SACT;QAED,4EAA4E;QAC5E,YAAY,EAAE,IAAI;QAElB,iEAAiE;QACjE,4DAA4D;QAC5D,YAAY,EAAE,KAAK;QAEnB,yEAAyE;QACzE,OAAO,EAAE,KAAK;KACf;IAED,kBAAkB;IAClB,GAAG,EAAE;QACH,0BAA0B;QAC1B,oEAAoE;QACpE,MAAM,EAAE,IAAI;QAEZ,mDAAmD;QACnD,iCAAiC;QACjC,KAAK,EAAE,SAAS;QAEhB,kEAAkE;QAClE,KAAK,EAAE,KAAK;KACb;IAED,iBAAiB;IACjB,IAAI,EAAE;QACJ,+CAA+C;QAC/C,QAAQ,EAAE,IAAI;QAEd,yDAAyD;QACzD,iDAAiD;QACjD,IAAI,EAAE,KAAK;QAEX,kEAAkE;QAClE,+BAA+B;QAC/B,KAAK,EAAE,KAAK;KACb;IAED,wEAAwE;IACxE,6EAA6E;IAC7E,IAAI,EAAE;QACJ,8BAA8B;QAC9B,GAAG,EAAE,KAAK;QACV,+BAA+B;QAC/B,IAAI,EAAE,KAAK;QACX,iEAAiE;QACjE,IAAI,EAAE,KAAK;QACX,gCAAgC;QAChC,MAAM,EAAE,UAAU;KACnB;IAED,kBAAkB;IAClB,KAAK,EAAE;QACL,GAAG,EAAE,IAAI;QACT,GAAG,EAAE;YACH,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;YACnB,KAAK,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;YACrB,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;SACpB;KACF;IAED,oCAAoC;IACpC,KAAK,EAAE,EAAE;IAET,qDAAqD;IACrD,MAAM,EAAE,EAAE;IAEV,iBAAiB;IACjB,KAAK,EAAE;QACL,+BAA+B;QAC/B,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO;QAE1B,sCAAsC;QACtC,MAAM,EAAE,EAAE;QAEV,4BAA4B;QAC5B,KAAK,EAAE;YACL,mCAAmC;YACnC,MAAM,EAAE,KAAK;YAEb,mDAAmD;YACnD,GAAG,EAAE,SAAS;SACf;KACF;IAED,kBAAkB;IAClB,KAAK,EAAE;QACL,OAAO,EAAE,uBAAuB;QAChC,UAAU,EAAE,gCAAgC;QAC5C,eAAe,EAAE,+BAA+B;QAChD,aAAa,EAAE,6BAA6B;QAC5C,WAAW,EAAE,8BAA8B;QAC3C,mBAAmB,EAAE,4BAA4B;QACjD,oBAAoB,EAAE,6BAA6B;QACnD,YAAY,EAAE,0BAA0B;QACxC,aAAa,EAAE,0BAA0B;KAC1C;IAED,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,IAAI;KACb;IAED,wCAAwC;IACxC,IAAI,EAAE;QACJ,OAAO,EAAE;;;UAGH;QAEN,UAAU,EAAE;;eAED;QAEX,eAAe,EAAE;sEACiD;QAElE,aAAa,EAAE;mEACgD;QAE/D,WAAW,EAAE;;gBAED;QAEZ,mBAAmB,EAAE;8BACK;QAE1B,oBAAoB,EAAE;8BACI;QAE1B,YAAY,EAAE;oCACkB;QAEhC,aAAa,EAAE;0BACO;KACvB;IAED,QAAQ;IACR,GAAG,EAAE;QACH,KAAK,EAAE;YACL,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAgB,EAAE;YAC7C,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAgB,EAAE;YAC7C,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAgB,EAAE;YAC7C,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,uBAAe,EAAE;YAC3C,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,yBAAiB,EAAE;YAC/C,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,0BAAkB,EAAE;YACjD,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,yBAAiB,EAAE;YAC/C,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,uBAAe,EAAE;SAC5C;QAED,gDAAgD;QAChD,KAAK,EAAE,IAAI;QACX,WAAW,EAAE,SAAS;KACvB;IAED,SAAS;IACT,KAAK,EAAE;QACL,qDAAqD;QACrD,OAAO,EAAE,EAAE;KACZ;IAED,uBAAuB;IACvB,IAAI,EAAE;QACJ,6BAA6B;QAC7B,KAAK,EAAE,KAAK;QAEZ,mDAAmD;QACnD,MAAM,EAAE,IAAI;QAEZ,iEAAiE;QACjE,MAAM,EAAE,CAAC;QAET,gEAAgE;QAChE,6DAA6D;QAC7D,OAAO,EAAE,EAAE;QAEX,qDAAqD;QACrD,6DAA6D;QAC7D,OAAO,EAAE,EAAE;KACZ;IAED,wBAAwB;IACxB,MAAM,EAAE;QACN,uCAAuC;QACvC,IAAI,EAAE,EAAE;KACT;IAED,kEAAkE;IAClE,kEAAkE;IAClE,4DAA4D;IAC5D,gEAAgE;IAChE,gEAAgE;IAChE,+BAA+B;IAC/B,MAAM,EAAE;QACN,OAAO,EAAE,EAAE;KACZ;IAED,yBAAyB;IACzB,MAAM,EAAE;QACN,2BAA2B;QAC3B,MAAM,EAAE,EAAE;KACX;IAED,2BAA2B;IAC3B,MAAM,EAAE;QACN,KAAK,EAAE,SAAS;KACjB;CACF,CAAA;AAEQ,4BAAQ"}

package/dist/error.d.ts

@@ -0,0 +1,51 @@
+import type { Context, Rule, Token } from './types';
+declare class TabnasError extends SyntaxError {
+    constructor(code: string, details: Record<string, any>, token: Token, rule: Rule, ctx: Context);
+}
+declare function errinject<T extends string | string[] | {
+    [key: string]: string;
+}>(s: T, code: string, details: Record<string, any>, token: Token, rule: Rule, ctx: Context): T;
+declare function trimstk(err: Error): void;
+declare function errsite(spec: {
+    src: string;
+    sub?: string;
+    msg?: string;
+    row?: number;
+    col?: number;
+    pos?: number;
+    cline?: string;
+}): string;
+declare function errmsg(spec: {
+    code?: string;
+    name?: string;
+    txts?: {
+        msg?: string;
+        hint?: string;
+        site?: string;
+    };
+    smsg?: string;
+    src?: string;
+    file?: string;
+    row?: number;
+    col?: number;
+    pos?: number;
+    site?: string;
+    sub?: string;
+    prefix?: string | Function;
+    suffix?: string | Function;
+    color?: {
+        active?: boolean;
+        reset?: string;
+        hi?: string;
+        lo?: string;
+        line?: string;
+    };
+}): string;
+declare function errdesc(code: string, details: Record<string, any>, token: Token, rule: Rule, ctx: Context): Record<string, any>;
+declare function strinject<T extends string | string[] | {
+    [key: string]: string;
+}>(s: T, m: Record<string, any>, f?: {
+    indent?: string;
+}): T;
+declare function prop(obj: any, path: string, val?: any): any;
+export { TabnasError, errdesc, errinject, errsite, errmsg, trimstk, strinject, prop, };