tarsec 0.0.21 → 0.0.22

package/dist/trace.d.ts

@@ -4,7 +4,7 @@ import { ParserResult, Parser, PlainObject, CaptureParser } from "./types.js";
  * @param name - debug name for parser
  * @param result - parser result
  * @returns - A formatted string that describes the parser's result
- */
+*/
 export declare function resultToString<T>(name: string, result: ParserResult<T>): string;
 /**
  * This function is used internally with debug mode. Given a parser and a debug name for it,
@@ -63,6 +63,19 @@ export declare function resultToString<T>(name: string, result: ParserResult<T>)
  */
 export declare function trace<T, C extends PlainObject>(name: string, parser: CaptureParser<T, C>): CaptureParser<T, C>;
 export declare function trace<T>(name: string, parser: Parser<T>): Parser<T>;
+/**
+ * Useful for adding debugging messages to your parsers.
+ * Use `getDebugMessages` to get all the messages,
+ * or `getDebugMessage` to get the last message,
+ * if your parser fails.
+ *
+ * @param parser - a parser
+ * @param message - the message to show if the parser fails
+ */
+export declare function debug<T, C extends PlainObject>(parser: CaptureParser<T, C>, message: string): CaptureParser<T, C>;
+export declare function debug<T>(parser: Parser<T>, message: string): Parser<T>;
+export declare function getDebugMessages(): string[];
+export declare function getDebugMessage(): string;
 /**
  * Utility timing function. Given a callback, it times the callback
  * and returns its runtime in milliseconds. It uses `performance.now()` to do this.

package/dist/trace.js

@@ -4,24 +4,25 @@ const isNode = typeof process !== "undefined" &&
     process.versions != null &&
     process.versions.node != null;
 const STEP = 2;
+let level = 0;
+let counts = {};
+let times = {};
+let debugFlag = isNode ? !!process.env.DEBUG : false;
+let stepCount = 0;
+let stepLimit = -1;
+let debugMessages = [];
 /**
  * This function is used internally by the `trace` function to create the string for each step.
  * @param name - debug name for parser
  * @param result - parser result
  * @returns - A formatted string that describes the parser's result
- */
+*/
 export function resultToString(name, result) {
     if (result.success) {
         return `✅ ${name} -- match: ${escape(result.result)}, rest: ${escape(result.rest)}`;
     }
     return `❌ ${name} -- message: ${escape(result.message)}, rest: ${escape(result.rest)}`;
 }
-let level = 0;
-let counts = {};
-let times = {};
-let debugFlag = isNode ? !!process.env.DEBUG : false;
-let stepCount = 0;
-let stepLimit = -1;
 export function trace(name, parser) {
     if (stepLimit > 0 && stepCount > stepLimit) {
         throw new Error(`parser step limit of ${stepLimit} exceeded, parser may be in an infinite loop`);
@@ -52,6 +53,24 @@ export function trace(name, parser) {
         }
     };
 }
+export function debug(parser, message) {
+    return (input) => {
+        const result = parser(input);
+        if (result.success) {
+            return result;
+        }
+        else {
+            debugMessages.push(`${message} -- ${resultToString("", result)}`);
+            return result;
+        }
+    };
+}
+export function getDebugMessages() {
+    return debugMessages;
+}
+export function getDebugMessage() {
+    return debugMessages[debugMessages.length - 1];
+}
 /**
  * Utility timing function. Given a callback, it times the callback
  * and returns its runtime in milliseconds. It uses `performance.now()` to do this.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tarsec",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "A parser combinator library for TypeScript, inspired by Parsec.",
   "homepage": "https://github.com/egonSchiele/tarsec",
   "scripts": {