mason-parser 1.0.1 → 1.0.2

package/README.md

@@ -160,6 +160,7 @@ Document
 5. **Explicit Array Suffix (`[]`):** To define an array of complex objects, append `[]` to the heading name (e.g., `# Users[]`). Any nested heading under it (e.g. `## User` or `##`) pushes a new object into that array.
 6. **Top-Level Anonymous Arrays:** To make the entire document parse as a top-level array, define `[]` on the very first non-empty line of the file. Each subsequent item header (like `##`) directly pushes a new anonymous object into this array.
 7. **Anonymous & Descriptive Heading Labels:** When defining elements of an array (explicit or top-level), heading names are fully optional. You can use empty heading lines (e.g., `## ` or `##`) or descriptive notes (e.g., `## Alice (Admin)`) without affecting the structured JSON properties.
+8. **Multiline Values:** Wrap any multi-line text block or formatted string in backticks (`` ` ``). The parser will automatically preserve formatting and newlines within the block.
 
 ---
 
@@ -207,15 +208,21 @@ name: Bob
 ```
 * **Behavior:** Resolves to `{}`. Encountering a heading immediately instantiates an empty object placeholder in the parent node.
 
-### 5. Escaping Special Characters
-* To include colons or other special symbols in a string value, wrap the value in double quotes:
+### 5. Backtick Delimiters (Matching)
+MaSON handles backticks dynamically based on matching the count of opening and closing backticks:
+* **Matching Delimiters & Language Tags:** A block or string starts with any count of backticks `N` (e.g. `1` backtick or `3` backticks) and ends with exactly `N` backticks. The surrounding delimiters on both ends are completely stripped.
+  * **Language Tag Stripping:** If opening with 3 or more backticks (e.g. ```` ```javascript ````), a single alphanumeric language identifier following the backticks is automatically stripped to enable seamless Markdown copying.
   ```markdown
-  title: "Hello: World"
+  script: ```javascript
+  function calculateTotal() {}
   ```
-* To represent a literal markdown header symbol inside a string value, wrap it:
+  ```
+  * **Behavior:** Resolves to `"function calculateTotal() {}"`.
+* **Embedding Backticks:** By using `N` backticks as the delimiter, you can easily embed backticks of other lengths (such as code spans of length `1`) without them being treated as delimiters.
   ```markdown
-  banner: "# Welcome To My Server"
+  literalText: `` `code` ``
   ```
+  * **Behavior:** Resolves to `"`code`"`.
 
 ---
 

package/dist/index.d.mts

@@ -24,11 +24,21 @@ interface ParseResult {
         tokenSavingsPercent: number;
     };
 }
+interface ParseOptions {
+    noTrace?: boolean;
+}
 /**
  * Casts a string value to its implicit primitive type or returns the string.
- * Strips quotes if they enclose the string explicitly.
+ * Strips quotes if they enclose the string explicitly and restores escaped characters.
  */
 declare function parsePrimitiveValue(val: string): any;
+/**
+ * Parses a single-line or multiline value, advancing the line reader index if needed.
+ */
+declare function parseValueWithMultiline(initialValStr: string, lines: string[], currentLineIndex: number): {
+    value: any;
+    nextLineIndex: number;
+};
 /**
  * Formats a value for MSON stringification.
  * Wraps in quotes if it has special characters or looks like a keyword but is a string.
@@ -37,14 +47,18 @@ declare function stringifyPrimitiveValue(val: any): string;
 /**
  * Parses MSON text into a JavaScript Object / Array.
  */
-declare function parse(text: string): any;
+declare function parse(text: string, options?: ParseOptions): any;
+/**
+ * Ultra-performance, trace-free parser for MSON.
+ */
+declare function fastParseWithTrace(text: string): ParseResult;
 /**
  * Parses MSON text into a JavaScript Object / Array with step-by-step trace info.
  */
-declare function parseWithTrace(text: string): ParseResult;
+declare function parseWithTrace(text: string, options?: ParseOptions): ParseResult;
 /**
  * Stringifies a JavaScript object/array back into MSON text recursively.
  */
 declare function stringify(obj: any, level?: number, parentKey?: string): string;
 
-export { type ParseResult, type ParserTraceStep, parse, parse as parseMSON, parsePrimitiveValue, parseWithTrace, stringify, stringify as stringifyMSON, stringifyPrimitiveValue };
+export { type ParseOptions, type ParseResult, type ParserTraceStep, fastParseWithTrace, parse, parse as parseMSON, parseWithTrace as parseMaSON, parsePrimitiveValue, parseValueWithMultiline, parseWithTrace, stringify, stringify as stringifyMSON, stringify as stringifyMaSON, stringifyPrimitiveValue };

package/dist/index.d.ts

@@ -24,11 +24,21 @@ interface ParseResult {
         tokenSavingsPercent: number;
     };
 }
+interface ParseOptions {
+    noTrace?: boolean;
+}
 /**
  * Casts a string value to its implicit primitive type or returns the string.
- * Strips quotes if they enclose the string explicitly.
+ * Strips quotes if they enclose the string explicitly and restores escaped characters.
  */
 declare function parsePrimitiveValue(val: string): any;
+/**
+ * Parses a single-line or multiline value, advancing the line reader index if needed.
+ */
+declare function parseValueWithMultiline(initialValStr: string, lines: string[], currentLineIndex: number): {
+    value: any;
+    nextLineIndex: number;
+};
 /**
  * Formats a value for MSON stringification.
  * Wraps in quotes if it has special characters or looks like a keyword but is a string.
@@ -37,14 +47,18 @@ declare function stringifyPrimitiveValue(val: any): string;
 /**
  * Parses MSON text into a JavaScript Object / Array.
  */
-declare function parse(text: string): any;
+declare function parse(text: string, options?: ParseOptions): any;
+/**
+ * Ultra-performance, trace-free parser for MSON.
+ */
+declare function fastParseWithTrace(text: string): ParseResult;
 /**
  * Parses MSON text into a JavaScript Object / Array with step-by-step trace info.
  */
-declare function parseWithTrace(text: string): ParseResult;
+declare function parseWithTrace(text: string, options?: ParseOptions): ParseResult;
 /**
  * Stringifies a JavaScript object/array back into MSON text recursively.
  */
 declare function stringify(obj: any, level?: number, parentKey?: string): string;
 
-export { type ParseResult, type ParserTraceStep, parse, parse as parseMSON, parsePrimitiveValue, parseWithTrace, stringify, stringify as stringifyMSON, stringifyPrimitiveValue };
+export { type ParseOptions, type ParseResult, type ParserTraceStep, fastParseWithTrace, parse, parse as parseMSON, parseWithTrace as parseMaSON, parsePrimitiveValue, parseValueWithMultiline, parseWithTrace, stringify, stringify as stringifyMSON, stringify as stringifyMaSON, stringifyPrimitiveValue };