parser-combinators 1.1.3 → 1.2.0

package/dist/parsers/utilities.js

@@ -1,43 +1,96 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectErase = exports.expect = exports.ref = void 0;
-const types_1 = require("../types");
-/** Allows to make a condition on the result of the parsing function.
- * @returns A parser returning the same but also performing a given check on the result.
- */
-function ref(parser, check, expected) {
-    return (ctx) => {
-        const res = parser(ctx);
-        if (!(0, types_1.isFailure)(res) && !check(res.value)) {
-            return (0, types_1.failure)(res.ctx, expected !== null && expected !== void 0 ? expected : 'check', [`ref: ${expected !== null && expected !== void 0 ? expected : 'check'}`]);
-        }
-        return res;
-    };
-}
-exports.ref = ref;
-/** Changes the expected value for when the parser fails.
- * @returns A parser returning the same but with a different expected value.
- */
-function expect(parser, expected) {
-    return (ctx) => {
-        const res = parser(ctx);
-        if ((0, types_1.isFailure)(res)) {
-            return (0, types_1.failure)(res.ctx, expected, [expected, ...res.history]);
-        }
-        return res;
-    };
-}
-exports.expect = expect;
-/** Changes the expected value for when the parser fails. Erases the previous history.
- * @returns A parser returning the same but with a different expected value.
- */
-function expectErase(parser, expected) {
-    return (ctx) => {
-        const res = parser(ctx);
-        if ((0, types_1.isFailure)(res)) {
-            return (0, types_1.failure)(res.ctx, expected, [expected]);
-        }
-        return res;
-    };
-}
-exports.expectErase = expectErase;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toggleFusions = exports.shouldPerformFusions = void 0;
+exports.ref = ref;
+exports.expect = expect;
+exports.expectErase = expectErase;
+exports.surely = surely;
+exports.token = token;
+exports.lookaround = lookaround;
+const types_1 = require("../types");
+const shouldPerformFusions = () => performFusions;
+exports.shouldPerformFusions = shouldPerformFusions;
+let performFusions = true;
+/**
+ * Disables all parser combinator fusions.
+ *
+ * Should probably be used only for testing performance.
+ */
+const toggleFusions = (value) => {
+    performFusions = value;
+};
+exports.toggleFusions = toggleFusions;
+/** Allows to make a condition on the result of the parsing function.
+ * @returns A parser returning the same but also performing a given check on the result.
+ */
+function ref(parser, check, expected) {
+    return (ctx) => {
+        const res = parser(ctx);
+        if (!(0, types_1.isFailure)(res) && !check(res.value)) {
+            return (0, types_1.failure)(res.ctx, expected ?? 'check', [`ref: ${expected ?? 'check'}`]);
+        }
+        return res;
+    };
+}
+/** Changes the expected value for when the parser fails.
+ * @returns A parser returning the same but with a different expected value.
+ */
+function expect(parser, expected) {
+    return (ctx) => {
+        const res = parser(ctx);
+        if ((0, types_1.isFailure)(res)) {
+            return (0, types_1.failure)(res.ctx, expected, [expected, ...res.history]);
+        }
+        return res;
+    };
+}
+/** Changes the expected value for when the parser fails. Erases the previous history.
+ * @returns A parser returning the same but with a different expected value.
+ */
+function expectErase(parser, expected) {
+    return (ctx) => {
+        const res = parser(ctx);
+        if ((0, types_1.isFailure)(res)) {
+            return (0, types_1.failure)(res.ctx, expected, [expected]);
+        }
+        return res;
+    };
+}
+/**
+ * Marks a parser as a branch that has to be executed to the end by the {@link any} parser
+ */
+function surely(parser) {
+    return expect(parser, 'surely');
+}
+/**
+ * Wraps the value returned by the parser with the token information (the start and end index in the text)
+ * @returns A parser returning the value wrapped in token information.
+ */
+function token(parser) {
+    return (ctx) => {
+        const result = parser(ctx);
+        if (result.success) {
+            return {
+                ...result,
+                value: {
+                    value: result.value,
+                    start: ctx.index,
+                    end: result.ctx.index
+                }
+            };
+        }
+        return result;
+    };
+}
+/**
+ * Checks whether the parser parses successfully, but doesn't move the cursor forward
+ */
+function lookaround(parser) {
+    return (ctx) => {
+        const result = parser(ctx);
+        if (result.success) {
+            return (0, types_1.success)(ctx, void 0);
+        }
+        return (0, types_1.failure)(ctx, result.expected, ['lookaround', ...result.history]);
+    };
+}

package/dist/parsers/values.d.ts

@@ -1,28 +1,31 @@
-import { Parser } from '../types';
-/** Parses 0 or more spaces
- */
-export declare const spaces: Parser<string>;
-/** Parses 1 or more spaces
- */
-export declare const spacesPlus: Parser<string>;
-/** Parses 0 or more whitespace characters
- */
-export declare const wspaces: Parser<string | null>;
-/** Parses a boolean (true or false) and returns a string
- */
-export declare const bool: Parser<'true' | 'false'>;
-/** Parses a boolean (true or false) and returns a boolean
- */
-export declare const boolP: Parser<boolean>;
-/** Parses an integer and returns a string
- */
-export declare const int: Parser<string>;
-/** Parses an integer and returns a number
- */
-export declare const intP: Parser<number>;
-/** Parses a standard real number (X.X) and returns a string
- */
-export declare const real: Parser<`${number}.${number}`>;
-/** Parses a standard real number (X.X) and returns a number
- */
-export declare const realP: Parser<number>;
+import { Parser } from '../types';
+/** Parses 0 or more spaces
+ */
+export declare const spaces: Parser<string>;
+/** Parses 1 or more spaces
+ */
+export declare const spacesPlus: Parser<string>;
+/** Parses 0 or more whitespace characters
+ */
+export declare const wspaces: Parser<string | null>;
+/** Parses a boolean (true or false) and returns a string
+ */
+export declare const bool: Parser<'true' | 'false'>;
+/** Parses a boolean (true or false) and returns a boolean
+ */
+export declare const boolP: Parser<boolean>;
+/** Parses an integer and returns a string
+ */
+export declare const int: Parser<string>;
+/** Parses an integer and returns a number
+ */
+export declare const intP: Parser<number>;
+/** Parses a standard real number (X.X) and returns a string
+ */
+export declare const real: Parser<`${number}.${number}`>;
+/** Parses a standard real number (X.X) and returns a number
+ */
+export declare const realP: Parser<number>;
+/** Parses an end of text/file. Fails if the parser is not at the end.
+ */
+export declare const eof: Parser<void>;

package/dist/parsers/values.js

@@ -1,36 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.realP = exports.real = exports.intP = exports.int = exports.boolP = exports.bool = exports.wspaces = exports.spacesPlus = exports.spaces = void 0;
-const map_1 = require("./map");
-const opt_1 = require("./opt");
-const regex_1 = require("./regex");
-const seq_1 = require("./seq");
-const str_1 = require("./str");
-const utilities_1 = require("./utilities");
-/** Parses 0 or more spaces
- */
-exports.spaces = (0, regex_1.regex)(/ */, 'spaces');
-/** Parses 1 or more spaces
- */
-exports.spacesPlus = (0, regex_1.regex)(/ +/, 'spaces');
-/** Parses 0 or more whitespace characters
- */
-exports.wspaces = (0, opt_1.opt)((0, regex_1.regex)(/(?:\s|\t|\n|\r)+/, 'whitespace characters'));
-/** Parses a boolean (true or false) and returns a string
- */
-exports.bool = (0, regex_1.regex)(/true|false/, 'boolean');
-/** Parses a boolean (true or false) and returns a boolean
- */
-exports.boolP = (0, map_1.map)(exports.bool, val => val === 'true');
-/** Parses an integer and returns a string
- */
-exports.int = (0, regex_1.regex)(/\d+/, 'integer');
-/** Parses an integer and returns a number
- */
-exports.intP = (0, map_1.map)(exports.int, seq => parseInt(seq, 10));
-/** Parses a standard real number (X.X) and returns a string
- */
-exports.real = (0, utilities_1.expect)((0, map_1.map)((0, seq_1.seq)(exports.int, (0, str_1.str)('.'), exports.int), ([intPart, , decimalPart]) => `${intPart}.${decimalPart}`), 'real');
-/** Parses a standard real number (X.X) and returns a number
- */
-exports.realP = (0, map_1.map)(exports.real, (seq) => parseFloat(seq));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eof = exports.realP = exports.real = exports.intP = exports.int = exports.boolP = exports.bool = exports.wspaces = exports.spacesPlus = exports.spaces = void 0;
+const types_1 = require("../types");
+const map_1 = require("./map");
+const opt_1 = require("./opt");
+const regex_1 = require("./regex");
+const seq_1 = require("./seq");
+const str_1 = require("./str");
+const utilities_1 = require("./utilities");
+/** Parses 0 or more spaces
+ */
+exports.spaces = (0, regex_1.regex)(/ */, 'spaces');
+/** Parses 1 or more spaces
+ */
+exports.spacesPlus = (0, regex_1.regex)(/ +/, 'spaces');
+/** Parses 0 or more whitespace characters
+ */
+exports.wspaces = (0, opt_1.opt)((0, regex_1.regex)(/(?:\s|\t|\n|\r)+/, 'whitespace characters'));
+/** Parses a boolean (true or false) and returns a string
+ */
+exports.bool = (0, regex_1.regex)(/true|false/, 'boolean');
+/** Parses a boolean (true or false) and returns a boolean
+ */
+exports.boolP = (0, map_1.map)(exports.bool, val => val === 'true');
+/** Parses an integer and returns a string
+ */
+exports.int = (0, regex_1.regex)(/\d+/, 'integer');
+/** Parses an integer and returns a number
+ */
+exports.intP = (0, map_1.map)(exports.int, seq => parseInt(seq, 10));
+/** Parses a standard real number (X.X) and returns a string
+ */
+exports.real = (0, utilities_1.expect)((0, map_1.map)((0, seq_1.seq)(exports.int, (0, str_1.str)('.'), exports.int), ([intPart, , decimalPart]) => `${intPart}.${decimalPart}`), 'real');
+/** Parses a standard real number (X.X) and returns a number
+ */
+exports.realP = (0, map_1.map)(exports.real, (seq) => parseFloat(seq));
+/** Parses an end of text/file. Fails if the parser is not at the end.
+ */
+const eof = (ctx) => {
+    if (ctx.index === ctx.text.length) {
+        return (0, types_1.success)(ctx, void 0);
+    }
+    else {
+        return (0, types_1.failure)(ctx, "End Of File", ["EOF"]);
+    }
+};
+exports.eof = eof;

package/dist/types.d.ts

@@ -1,33 +1,40 @@
-export declare type Parser<T> = (ctx: Context) => Result<T>;
-export declare type Context = Readonly<{
-    text: string;
-    path: string;
-    index: number;
-}>;
-export declare type Result<T> = Success<T> | Failure;
-export declare type Success<T> = Readonly<{
-    success: true;
-    value: T;
-    ctx: Context;
-}>;
-export declare type Failure = Readonly<{
-    success: false;
-    expected: string;
-    ctx: Context;
-    history: string[];
-}>;
-export declare function isFailure(input: unknown): input is Failure;
-export declare function success<T>(ctx: Context, value: T): Success<T>;
-export declare function failure(ctx: Context, expected: string, history: string[]): Failure;
-export declare function result<T>(value: T): Parser<T>;
-export declare function fail<T>(reason: string): Parser<T>;
-export declare class ParseError extends Error {
-    readonly index: number;
-    readonly history: string[];
-    readonly line: string;
-    readonly column: number;
-    readonly row: number;
-    constructor(message: string, input: string, index: number, history: string[]);
-    private getInputData;
-    getPrettyErrorMessage(): string;
-}
+export type Parser<T> = (ctx: Context) => Result<T>;
+export type Context = Readonly<{
+    text: string;
+    path: string;
+    index: number;
+}>;
+export type Result<T> = Success<T> | Failure;
+export type Success<T> = Readonly<{
+    success: true;
+    value: T;
+    ctx: Context;
+}>;
+export type Failure = Readonly<{
+    success: false;
+    expected: string;
+    ctx: Context;
+    history: string[];
+}>;
+export type TokenRange = {
+    start: number;
+    end: number;
+};
+export type Token<T> = TokenRange & {
+    value: T;
+};
+export declare function isFailure(input: unknown): input is Failure;
+export declare function success<T>(ctx: Context, value: T): Success<T>;
+export declare function failure(ctx: Context, expected: string, history: string[]): Failure;
+export declare function result<T>(value: T): Parser<T>;
+export declare function fail<T>(reason: string): Parser<T>;
+export declare class ParseError extends Error {
+    readonly index: number;
+    readonly history: string[];
+    readonly line: string;
+    readonly column: number;
+    readonly row: number;
+    constructor(message: string, input: string, index: number, history: string[]);
+    private getInputData;
+    getPrettyErrorMessage(): string;
+}

package/dist/types.js

@@ -1,47 +1,47 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParseError = exports.fail = exports.result = exports.failure = exports.success = exports.isFailure = void 0;
-function isFailure(input) {
-    return !input.success;
-}
-exports.isFailure = isFailure;
-function success(ctx, value) {
-    return { success: true, value, ctx };
-}
-exports.success = success;
-function failure(ctx, expected, history) {
-    return { success: false, expected, ctx, history };
-}
-exports.failure = failure;
-function result(value) {
-    return (ctx) => success(ctx, value);
-}
-exports.result = result;
-function fail(reason) {
-    return (ctx) => failure(ctx, reason, [reason]);
-}
-exports.fail = fail;
-class ParseError extends Error {
-    constructor(message, input, index, history) {
-        super(message);
-        this.index = index;
-        this.history = history;
-        [this.line, this.column, this.row] = this.getInputData(input, index);
-    }
-    getInputData(input, index) {
-        const lines = input.split('\n');
-        let row = 0;
-        while (index > 0) {
-            if (lines[row].length > index) {
-                return [lines[row], index + 1, row + 1];
-            }
-            index -= lines[row].length + 1;
-            row += 1;
-        }
-        return [lines[row], index + 1, row + 1];
-    }
-    getPrettyErrorMessage() {
-        return `${this.message} (line ${this.row}, col ${this.column})\n${this.line}\n${(this.column ? ' '.repeat(this.column - 1) : '') + '^'}`;
-    }
-}
-exports.ParseError = ParseError;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseError = void 0;
+exports.isFailure = isFailure;
+exports.success = success;
+exports.failure = failure;
+exports.result = result;
+exports.fail = fail;
+function isFailure(input) {
+    return !input.success;
+}
+function success(ctx, value) {
+    return { success: true, value, ctx };
+}
+function failure(ctx, expected, history) {
+    return { success: false, expected, ctx, history };
+}
+function result(value) {
+    return (ctx) => success(ctx, value);
+}
+function fail(reason) {
+    return (ctx) => failure(ctx, reason, [reason]);
+}
+class ParseError extends Error {
+    constructor(message, input, index, history) {
+        super(message);
+        this.index = index;
+        this.history = history;
+        [this.line, this.column, this.row] = this.getInputData(input, index);
+    }
+    getInputData(input, index) {
+        const lines = input.split('\n');
+        let row = 0;
+        while (index > 0) {
+            if (lines[row].length > index) {
+                return [lines[row], index + 1, row + 1];
+            }
+            index -= lines[row].length + 1;
+            row += 1;
+        }
+        return [lines[row], index + 1, row + 1];
+    }
+    getPrettyErrorMessage() {
+        return `${this.message} (line ${this.row}, col ${this.column}):\n${this.line}\n${(this.column > 0 ? '-'.repeat(this.column - 1) : '') + '^'}`;
+    }
+}
+exports.ParseError = ParseError;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "parser-combinators",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "license": "ISC",
   "maintainers": [
     "Micha_i"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/michalusio/Parser.git"
+    "url": "git+https://github.com/michalusio/Parser.git"
   },
   "bugs": {
     "url": "https://github.com/michalusio/Parser/issues"
@@ -18,24 +18,29 @@
     "build": "tsc",
     "start": "tsc && node .",
     "lint": "eslint . --ext .ts",
-    "test:unit": "cross-env TS_NODE_PROJECT=tsconfig.spec.json mocha tests/**/*.ts",
-    "test": "nyc -e '.ts' --r html -r lcov -r text npm run test:unit",
-    "test:report": "nyc report --reporter=json > coverage/coverage.json"
+    "test:mutate": "stryker run",
+    "test:unit": "mocha",
+    "test": "nyc -e '.ts' --r html -r lcov -r text npm run test:unit"
   },
   "author": "Micha_i <isalski.michal@gmail.com> (https://github.com/michalusio)",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "engines": {
+    "node": ">=18"
+  },
   "devDependencies": {
-    "@types/mocha": "10.0.0",
-    "@types/node": "18.11.3",
-    "@typescript-eslint/eslint-plugin": "5.40.1",
-    "@typescript-eslint/parser": "5.40.1",
-    "cross-env": "7.0.3",
-    "eslint": "8.25.0",
-    "mocha": "10.1.0",
-    "nyc": "15.1.0",
-    "ts-node": "10.9.1",
-    "typescript": "4.8.4"
+    "@stryker-mutator/core": "^9.4.0",
+    "@stryker-mutator/mocha-runner": "^9.4.0",
+    "@stryker-mutator/typescript-checker": "^9.4.0",
+    "@types/mocha": "10.0.10",
+    "@types/node": "25.0.6",
+    "cross-env": "10.1.0",
+    "eslint": "9.39.2",
+    "mocha": "11.7.5",
+    "nyc": "17.1.0",
+    "ts-node": "10.9.2",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.52.0"
   },
   "keywords": [
     "parser",