comment-parser 1.2.1 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v1.3.0
+- add support for custom block markers
+
+# v1.2.4
+- reverting engine constraint back to ^12.0.0
+
+# v1.2.3
+- publishing missing fix: point package's main to .cjs file
+
+# v1.2.2
+- re-export ./util on the top-level for compatibility with older Node
+- point package's main to .cjs file
+
 # v1.2.1
 - bump `engines` per `exports` issues in earlier Node versions
 

package/browser/index.js

@@ -1,6 +1,15 @@
 var CommentParser = (function (exports) {
     'use strict';
 
+    /** @deprecated */
+    exports.Markers = void 0;
+    (function (Markers) {
+        Markers["start"] = "/**";
+        Markers["nostart"] = "/***";
+        Markers["delim"] = "*";
+        Markers["end"] = "*/";
+    })(exports.Markers || (exports.Markers = {}));
+
     function isSpace(source) {
         return /^\s+$/.test(source);
     }
@@ -19,6 +28,9 @@ var CommentParser = (function (exports) {
     function splitLines(source) {
         return source.split(/\n/);
     }
+    function seedBlock(block = {}) {
+        return Object.assign({ description: '', tags: [], source: [], problems: [] }, block);
+    }
     function seedSpec(spec = {}) {
         return Object.assign({ tag: '', name: '', type: '', optional: false, description: '', problems: [], source: [] }, spec);
     }
@@ -37,6 +49,16 @@ var CommentParser = (function (exports) {
         }
         return block;
     }
+    /**
+     * Assures Block.source contains references to the Block.tags[].source items,
+     * using Block.tags[].source as a source of truth. This is a counterpart of rewireSource
+     * @param block parsed coments block
+     */
+    function rewireSpecs(block) {
+        const source = block.tags.reduce((acc, spec) => spec.source.reduce((acc, line) => acc.set(line.number, line), acc), new Map());
+        block.source = block.source.map((line) => source.get(line.number) || line);
+        return block;
+    }
 
     const reTag = /^@\S+/;
     /**
@@ -68,15 +90,7 @@ var CommentParser = (function (exports) {
         return fence;
     }
 
-    exports.Markers = void 0;
-    (function (Markers) {
-        Markers["start"] = "/**";
-        Markers["nostart"] = "/***";
-        Markers["delim"] = "*";
-        Markers["end"] = "*/";
-    })(exports.Markers || (exports.Markers = {}));
-
-    function getParser$2({ startLine = 0, } = {}) {
+    function getParser$2({ startLine = 0, markers = exports.Markers, } = {}) {
         let block = null;
         let num = startLine;
         return function parseSource(source) {
@@ -85,29 +99,29 @@ var CommentParser = (function (exports) {
             [tokens.lineEnd, rest] = splitCR(rest);
             [tokens.start, rest] = splitSpace(rest);
             if (block === null &&
-                rest.startsWith(exports.Markers.start) &&
-                !rest.startsWith(exports.Markers.nostart)) {
+                rest.startsWith(markers.start) &&
+                !rest.startsWith(markers.nostart)) {
                 block = [];
-                tokens.delimiter = rest.slice(0, exports.Markers.start.length);
-                rest = rest.slice(exports.Markers.start.length);
+                tokens.delimiter = rest.slice(0, markers.start.length);
+                rest = rest.slice(markers.start.length);
                 [tokens.postDelimiter, rest] = splitSpace(rest);
             }
             if (block === null) {
                 num++;
                 return null;
             }
-            const isClosed = rest.trimRight().endsWith(exports.Markers.end);
+            const isClosed = rest.trimRight().endsWith(markers.end);
             if (tokens.delimiter === '' &&
-                rest.startsWith(exports.Markers.delim) &&
-                !rest.startsWith(exports.Markers.end)) {
-                tokens.delimiter = exports.Markers.delim;
-                rest = rest.slice(exports.Markers.delim.length);
+                rest.startsWith(markers.delim) &&
+                !rest.startsWith(markers.end)) {
+                tokens.delimiter = markers.delim;
+                rest = rest.slice(markers.delim.length);
                 [tokens.postDelimiter, rest] = splitSpace(rest);
             }
             if (isClosed) {
                 const trimmed = rest.trimRight();
-                tokens.end = rest.slice(trimmed.length - exports.Markers.end.length);
-                rest = trimmed.slice(0, -exports.Markers.end.length);
+                tokens.end = rest.slice(trimmed.length - markers.end.length);
+                rest = trimmed.slice(0, -markers.end.length);
             }
             tokens.description = rest;
             block.push({ number: num, source, tokens });
@@ -319,11 +333,12 @@ var CommentParser = (function (exports) {
      * Makes no changes to `spec.lines[].tokens` but joins them into `spec.description`
      * following given spacing srtategy
      * @param {Spacing} spacing tells how to handle the whitespace
+     * @param {BlockMarkers} markers tells how to handle comment block delimitation
      */
-    function descriptionTokenizer(spacing = 'compact') {
+    function descriptionTokenizer(spacing = 'compact', markers = exports.Markers) {
         const join = getJoiner(spacing);
         return (spec) => {
-            spec.description = join(spec.source);
+            spec.description = join(spec.source, markers);
             return spec;
         };
     }
@@ -334,7 +349,7 @@ var CommentParser = (function (exports) {
             return preserveJoiner;
         return spacing;
     }
-    function compactJoiner(lines) {
+    function compactJoiner(lines, markers = exports.Markers) {
         return lines
             .map(({ tokens: { description } }) => description.trim())
             .filter((description) => description !== '')
@@ -343,25 +358,25 @@ var CommentParser = (function (exports) {
     const lineNo = (num, { tokens }, i) => tokens.type === '' ? num : i;
     const getDescription = ({ tokens }) => (tokens.delimiter === '' ? tokens.start : tokens.postDelimiter.slice(1)) +
         tokens.description;
-    function preserveJoiner(lines) {
+    function preserveJoiner(lines, markers = exports.Markers) {
         if (lines.length === 0)
             return '';
         // skip the opening line with no description
         if (lines[0].tokens.description === '' &&
-            lines[0].tokens.delimiter === exports.Markers.start)
+            lines[0].tokens.delimiter === markers.start)
             lines = lines.slice(1);
         // skip the closing line with no description
         const lastLine = lines[lines.length - 1];
         if (lastLine !== undefined &&
             lastLine.tokens.description === '' &&
-            lastLine.tokens.end.endsWith(exports.Markers.end))
+            lastLine.tokens.end.endsWith(markers.end))
             lines = lines.slice(0, -1);
         // description starts at the last line of type definition
         lines = lines.slice(lines.reduce(lineNo, 0));
         return lines.map(getDescription).join('\n');
     }
 
-    function getParser({ startLine = 0, fence = '```', spacing = 'compact', tokenizers = [
+    function getParser({ startLine = 0, fence = '```', spacing = 'compact', markers = exports.Markers, tokenizers = [
         tagTokenizer(),
         typeTokenizer(spacing),
         nameTokenizer(),
@@ -369,7 +384,7 @@ var CommentParser = (function (exports) {
     ], } = {}) {
         if (startLine < 0 || startLine % 1 > 0)
             throw new Error('Invalid startLine');
-        const parseSource = getParser$2({ startLine });
+        const parseSource = getParser$2({ startLine, markers });
         const parseBlock = getParser$3({ fence });
         const parseSpec = getParser$1({ tokenizers });
         const joinDescription = getJoiner(spacing);
@@ -385,7 +400,7 @@ var CommentParser = (function (exports) {
                 const sections = parseBlock(lines);
                 const specs = sections.slice(1).map(parseSpec);
                 blocks.push({
-                    description: joinDescription(sections[0]),
+                    description: joinDescription(sections[0], markers),
                     tags: specs,
                     source: lines,
                     problems: specs.reduce((acc, spec) => acc.concat(spec.problems), []),
@@ -430,14 +445,14 @@ var CommentParser = (function (exports) {
         type: 0,
         name: 0,
     };
-    const getWidth = (w, { tokens: t }) => ({
-        start: t.delimiter === exports.Markers.start ? t.start.length : w.start,
+    const getWidth = (markers = exports.Markers) => (w, { tokens: t }) => ({
+        start: t.delimiter === markers.start ? t.start.length : w.start,
         tag: Math.max(w.tag, t.tag.length),
         type: Math.max(w.type, t.type.length),
         name: Math.max(w.name, t.name.length),
     });
     const space = (len) => ''.padStart(len, ' ');
-    function align$1() {
+    function align$1(markers = exports.Markers) {
         let intoTags = false;
         let w;
         function update(line) {
@@ -449,15 +464,15 @@ var CommentParser = (function (exports) {
                 tokens.type === '' &&
                 tokens.description === '';
             // dangling '*/'
-            if (tokens.end === exports.Markers.end && isEmpty) {
+            if (tokens.end === markers.end && isEmpty) {
                 tokens.start = space(w.start + 1);
                 return Object.assign(Object.assign({}, line), { tokens });
             }
             switch (tokens.delimiter) {
-                case exports.Markers.start:
+                case markers.start:
                     tokens.start = space(w.start);
                     break;
-                case exports.Markers.delim:
+                case markers.delim:
                     tokens.start = space(w.start + 1);
                     break;
                 default:
@@ -500,7 +515,7 @@ var CommentParser = (function (exports) {
         }
         return (_a) => {
             var { source } = _a, fields = __rest$2(_a, ["source"]);
-            w = source.reduce(getWidth, Object.assign({}, zeroWidth$1));
+            w = source.reduce(getWidth(markers), Object.assign({}, zeroWidth$1));
             return rewireSource(Object.assign(Object.assign({}, fields), { source: source.map(update) }));
         };
     }
@@ -622,12 +637,14 @@ var CommentParser = (function (exports) {
         name: nameTokenizer,
         description: descriptionTokenizer,
     };
+    const util = { rewireSpecs, rewireSource, seedBlock, seedTokens };
 
     exports.inspect = inspect;
     exports.parse = parse;
     exports.stringify = stringify;
     exports.tokenizers = tokenizers;
     exports.transforms = transforms;
+    exports.util = util;
 
     Object.defineProperty(exports, '__esModule', { value: true });
 

package/es6/index.d.ts

@@ -7,6 +7,7 @@ import alignTransform from './transforms/align';
 import indentTransform from './transforms/indent';
 import crlfTransform from './transforms/crlf';
 import { flow as flowTransform } from './transforms/index';
+import { rewireSpecs, rewireSource, seedBlock, seedTokens } from './util';
 export * from './primitives';
 export declare function parse(source: string, options?: Partial<ParserOptions>): import("./primitives").Block[];
 export declare const stringify: import("./stringifier/index").Stringifier;
@@ -23,3 +24,9 @@ export declare const tokenizers: {
     name: typeof nameTokenizer;
     description: typeof descriptionTokenizer;
 };
+export declare const util: {
+    rewireSpecs: typeof rewireSpecs;
+    rewireSource: typeof rewireSource;
+    seedBlock: typeof seedBlock;
+    seedTokens: typeof seedTokens;
+};

package/es6/index.js

@@ -8,6 +8,7 @@ import alignTransform from './transforms/align.js';
 import indentTransform from './transforms/indent.js';
 import crlfTransform from './transforms/crlf.js';
 import { flow as flowTransform } from './transforms/index.js';
+import { rewireSpecs, rewireSource, seedBlock, seedTokens } from './util.js';
 export * from './primitives.js';
 export function parse(source, options = {}) {
     return getParser(options)(source);
@@ -26,3 +27,4 @@ export const tokenizers = {
     name: nameTokenizer,
     description: descriptionTokenizer,
 };
+export const util = { rewireSpecs, rewireSource, seedBlock, seedTokens };

package/es6/parser/index.d.ts

@@ -1,10 +1,11 @@
-import { Block } from '../primitives';
+import { Block, BlockMarkers } from '../primitives';
 import { Tokenizer } from './tokenizers/index';
 export interface Options {
     startLine: number;
     fence: string;
     spacing: 'compact' | 'preserve';
+    markers: BlockMarkers;
     tokenizers: Tokenizer[];
 }
 export declare type Parser = (source: string) => Block[];
-export default function getParser({ startLine, fence, spacing, tokenizers, }?: Partial<Options>): Parser;
+export default function getParser({ startLine, fence, spacing, markers, tokenizers, }?: Partial<Options>): Parser;

package/es6/parser/index.js

@@ -1,3 +1,4 @@
+import { Markers } from '../primitives.js';
 import { splitLines } from '../util.js';
 import blockParser from './block-parser.js';
 import sourceParser from './source-parser.js';
@@ -6,7 +7,7 @@ import tokenizeTag from './tokenizers/tag.js';
 import tokenizeType from './tokenizers/type.js';
 import tokenizeName from './tokenizers/name.js';
 import tokenizeDescription, { getJoiner as getDescriptionJoiner, } from './tokenizers/description.js';
-export default function getParser({ startLine = 0, fence = '```', spacing = 'compact', tokenizers = [
+export default function getParser({ startLine = 0, fence = '```', spacing = 'compact', markers = Markers, tokenizers = [
     tokenizeTag(),
     tokenizeType(spacing),
     tokenizeName(),
@@ -14,7 +15,7 @@ export default function getParser({ startLine = 0, fence = '```', spacing = 'com
 ], } = {}) {
     if (startLine < 0 || startLine % 1 > 0)
         throw new Error('Invalid startLine');
-    const parseSource = sourceParser({ startLine });
+    const parseSource = sourceParser({ startLine, markers });
     const parseBlock = blockParser({ fence });
     const parseSpec = specParser({ tokenizers });
     const joinDescription = getDescriptionJoiner(spacing);
@@ -30,7 +31,7 @@ export default function getParser({ startLine = 0, fence = '```', spacing = 'com
             const sections = parseBlock(lines);
             const specs = sections.slice(1).map(parseSpec);
             blocks.push({
-                description: joinDescription(sections[0]),
+                description: joinDescription(sections[0], markers),
                 tags: specs,
                 source: lines,
                 problems: specs.reduce((acc, spec) => acc.concat(spec.problems), []),

package/es6/parser/source-parser.d.ts

@@ -1,6 +1,7 @@
-import { Line } from '../primitives';
+import { Line, BlockMarkers } from '../primitives';
 export interface Options {
     startLine: number;
+    markers: BlockMarkers;
 }
 export declare type Parser = (source: string) => Line[] | null;
-export default function getParser({ startLine, }?: Partial<Options>): Parser;
+export default function getParser({ startLine, markers, }?: Partial<Options>): Parser;

package/es6/parser/source-parser.js

@@ -1,6 +1,6 @@
 import { Markers } from '../primitives.js';
 import { seedTokens, splitSpace, splitCR } from '../util.js';
-export default function getParser({ startLine = 0, } = {}) {
+export default function getParser({ startLine = 0, markers = Markers, } = {}) {
     let block = null;
     let num = startLine;
     return function parseSource(source) {
@@ -9,29 +9,29 @@ export default function getParser({ startLine = 0, } = {}) {
         [tokens.lineEnd, rest] = splitCR(rest);
         [tokens.start, rest] = splitSpace(rest);
         if (block === null &&
-            rest.startsWith(Markers.start) &&
-            !rest.startsWith(Markers.nostart)) {
+            rest.startsWith(markers.start) &&
+            !rest.startsWith(markers.nostart)) {
             block = [];
-            tokens.delimiter = rest.slice(0, Markers.start.length);
-            rest = rest.slice(Markers.start.length);
+            tokens.delimiter = rest.slice(0, markers.start.length);
+            rest = rest.slice(markers.start.length);
             [tokens.postDelimiter, rest] = splitSpace(rest);
         }
         if (block === null) {
             num++;
             return null;
         }
-        const isClosed = rest.trimRight().endsWith(Markers.end);
+        const isClosed = rest.trimRight().endsWith(markers.end);
         if (tokens.delimiter === '' &&
-            rest.startsWith(Markers.delim) &&
-            !rest.startsWith(Markers.end)) {
-            tokens.delimiter = Markers.delim;
-            rest = rest.slice(Markers.delim.length);
+            rest.startsWith(markers.delim) &&
+            !rest.startsWith(markers.end)) {
+            tokens.delimiter = markers.delim;
+            rest = rest.slice(markers.delim.length);
             [tokens.postDelimiter, rest] = splitSpace(rest);
         }
         if (isClosed) {
             const trimmed = rest.trimRight();
-            tokens.end = rest.slice(trimmed.length - Markers.end.length);
-            rest = trimmed.slice(0, -Markers.end.length);
+            tokens.end = rest.slice(trimmed.length - markers.end.length);
+            rest = trimmed.slice(0, -markers.end.length);
         }
         tokens.description = rest;
         block.push({ number: num, source, tokens });

package/es6/parser/tokenizers/description.d.ts

@@ -1,9 +1,9 @@
-import { Line } from '../../primitives';
+import { Line, BlockMarkers, Markers } from '../../primitives';
 import { Tokenizer } from './index';
 /**
  * Walks over provided lines joining description token into a single string.
  * */
-export declare type Joiner = (lines: Line[]) => string;
+export declare type Joiner = (lines: Line[], markers?: BlockMarkers) => string;
 /**
  * Shortcut for standard Joiners
  * compact - strip surrounding whitespace and concat lines using a single string
@@ -14,6 +14,7 @@ export declare type Spacing = 'compact' | 'preserve' | Joiner;
  * Makes no changes to `spec.lines[].tokens` but joins them into `spec.description`
  * following given spacing srtategy
  * @param {Spacing} spacing tells how to handle the whitespace
+ * @param {BlockMarkers} markers tells how to handle comment block delimitation
  */
-export default function descriptionTokenizer(spacing?: Spacing): Tokenizer;
+export default function descriptionTokenizer(spacing?: Spacing, markers?: typeof Markers): Tokenizer;
 export declare function getJoiner(spacing: Spacing): Joiner;

package/es6/parser/tokenizers/description.js

@@ -3,11 +3,12 @@ import { Markers } from '../../primitives.js';
  * Makes no changes to `spec.lines[].tokens` but joins them into `spec.description`
  * following given spacing srtategy
  * @param {Spacing} spacing tells how to handle the whitespace
+ * @param {BlockMarkers} markers tells how to handle comment block delimitation
  */
-export default function descriptionTokenizer(spacing = 'compact') {
+export default function descriptionTokenizer(spacing = 'compact', markers = Markers) {
     const join = getJoiner(spacing);
     return (spec) => {
-        spec.description = join(spec.source);
+        spec.description = join(spec.source, markers);
         return spec;
     };
 }
@@ -18,7 +19,7 @@ export function getJoiner(spacing) {
         return preserveJoiner;
     return spacing;
 }
-function compactJoiner(lines) {
+function compactJoiner(lines, markers = Markers) {
     return lines
         .map(({ tokens: { description } }) => description.trim())
         .filter((description) => description !== '')
@@ -27,18 +28,18 @@ function compactJoiner(lines) {
 const lineNo = (num, { tokens }, i) => tokens.type === '' ? num : i;
 const getDescription = ({ tokens }) => (tokens.delimiter === '' ? tokens.start : tokens.postDelimiter.slice(1)) +
     tokens.description;
-function preserveJoiner(lines) {
+function preserveJoiner(lines, markers = Markers) {
     if (lines.length === 0)
         return '';
     // skip the opening line with no description
     if (lines[0].tokens.description === '' &&
-        lines[0].tokens.delimiter === Markers.start)
+        lines[0].tokens.delimiter === markers.start)
         lines = lines.slice(1);
     // skip the closing line with no description
     const lastLine = lines[lines.length - 1];
     if (lastLine !== undefined &&
         lastLine.tokens.description === '' &&
-        lastLine.tokens.end.endsWith(Markers.end))
+        lastLine.tokens.end.endsWith(markers.end))
         lines = lines.slice(0, -1);
     // description starts at the last line of type definition
     lines = lines.slice(lines.reduce(lineNo, 0));

package/es6/primitives.d.ts

@@ -1,9 +1,16 @@
+/** @deprecated */
 export declare enum Markers {
     start = "/**",
     nostart = "/***",
     delim = "*",
     end = "*/"
 }
+export interface BlockMarkers {
+    start: string;
+    nostart: string;
+    delim: string;
+    end: string;
+}
 export interface Block {
     description: string;
     tags: Spec[];

package/es6/primitives.js

@@ -1,3 +1,4 @@
+/** @deprecated */
 export var Markers;
 (function (Markers) {
     Markers["start"] = "/**";

package/es6/transforms/align.d.ts

@@ -1,2 +1,3 @@
 import { Transform } from './index';
-export default function align(): Transform;
+import { Markers } from '../primitives';
+export default function align(markers?: typeof Markers): Transform;

package/es6/transforms/align.js

@@ -17,14 +17,14 @@ const zeroWidth = {
     type: 0,
     name: 0,
 };
-const getWidth = (w, { tokens: t }) => ({
-    start: t.delimiter === Markers.start ? t.start.length : w.start,
+const getWidth = (markers = Markers) => (w, { tokens: t }) => ({
+    start: t.delimiter === markers.start ? t.start.length : w.start,
     tag: Math.max(w.tag, t.tag.length),
     type: Math.max(w.type, t.type.length),
     name: Math.max(w.name, t.name.length),
 });
 const space = (len) => ''.padStart(len, ' ');
-export default function align() {
+export default function align(markers = Markers) {
     let intoTags = false;
     let w;
     function update(line) {
@@ -36,15 +36,15 @@ export default function align() {
             tokens.type === '' &&
             tokens.description === '';
         // dangling '*/'
-        if (tokens.end === Markers.end && isEmpty) {
+        if (tokens.end === markers.end && isEmpty) {
             tokens.start = space(w.start + 1);
             return Object.assign(Object.assign({}, line), { tokens });
         }
         switch (tokens.delimiter) {
-            case Markers.start:
+            case markers.start:
                 tokens.start = space(w.start);
                 break;
-            case Markers.delim:
+            case markers.delim:
                 tokens.start = space(w.start + 1);
                 break;
             default:
@@ -87,7 +87,7 @@ export default function align() {
     }
     return (_a) => {
         var { source } = _a, fields = __rest(_a, ["source"]);
-        w = source.reduce(getWidth, Object.assign({}, zeroWidth));
+        w = source.reduce(getWidth(markers), Object.assign({}, zeroWidth));
         return rewireSource(Object.assign(Object.assign({}, fields), { source: source.map(update) }));
     };
 }

package/lib/index.cjs

@@ -20,7 +20,7 @@ var __exportStar = this && this.__exportStar || function (m, exports) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.tokenizers = exports.transforms = exports.inspect = exports.stringify = exports.parse = void 0;
+exports.util = exports.tokenizers = exports.transforms = exports.inspect = exports.stringify = exports.parse = void 0;
 
 const index_1 = require("./parser/index.cjs");
 
@@ -42,6 +42,8 @@ const crlf_1 = require("./transforms/crlf.cjs");
 
 const index_3 = require("./transforms/index.cjs");
 
+const util_1 = require("./util.cjs");
+
 __exportStar(require("./primitives.cjs"), exports);
 
 function parse(source, options = {}) {
@@ -71,4 +73,10 @@ exports.tokenizers = {
   name: name_1.default,
   description: description_1.default
 };
+exports.util = {
+  rewireSpecs: util_1.rewireSpecs,
+  rewireSource: util_1.rewireSource,
+  seedBlock: util_1.seedBlock,
+  seedTokens: util_1.seedTokens
+};
 //# sourceMappingURL=index.cjs.map

package/lib/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["index.js"],"names":["__createBinding","Object","create","o","m","k","k2","undefined","defineProperty","enumerable","get","__exportStar","exports","p","prototype","hasOwnProperty","call","value","tokenizers","transforms","inspect","stringify","parse","index_1","require","description_1","name_1","tag_1","type_1","index_2","align_1","indent_1","crlf_1","index_3","source","options","default","inspect_1","flow","align","indent","crlf","tag","type","name","description"],"mappings":"AAAA;;AACA,IAAIA,eAAe,GAAI,QAAQ,KAAKA,eAAd,KAAmCC,MAAM,CAACC,MAAP,GAAiB,UAASC,CAAT,EAAYC,CAAZ,EAAeC,CAAf,EAAkBC,EAAlB,EAAsB;AAC5F,MAAIA,EAAE,KAAKC,SAAX,EAAsBD,EAAE,GAAGD,CAAL;AACtBJ,EAAAA,MAAM,CAACO,cAAP,CAAsBL,CAAtB,EAAyBG,EAAzB,EAA6B;AAAEG,IAAAA,UAAU,EAAE,IAAd;AAAoBC,IAAAA,GAAG,EAAE,YAAW;AAAE,aAAON,CAAC,CAACC,CAAD,CAAR;AAAc;AAApD,GAA7B;AACH,CAHwD,GAGnD,UAASF,CAAT,EAAYC,CAAZ,EAAeC,CAAf,EAAkBC,EAAlB,EAAsB;AACxB,MAAIA,EAAE,KAAKC,SAAX,EAAsBD,EAAE,GAAGD,CAAL;AACtBF,EAAAA,CAAC,CAACG,EAAD,CAAD,GAAQF,CAAC,CAACC,CAAD,CAAT;AACH,CANqB,CAAtB;;AAOA,IAAIM,YAAY,GAAI,QAAQ,KAAKA,YAAd,IAA+B,UAASP,CAAT,EAAYQ,OAAZ,EAAqB;AACnE,OAAK,IAAIC,CAAT,IAAcT,CAAd,EAAiB,IAAIS,CAAC,KAAK,SAAN,IAAmB,CAACZ,MAAM,CAACa,SAAP,CAAiBC,cAAjB,CAAgCC,IAAhC,CAAqCJ,OAArC,EAA8CC,CAA9C,CAAxB,EAA0Eb,eAAe,CAACY,OAAD,EAAUR,CAAV,EAAaS,CAAb,CAAf;AAC9F,CAFD;;AAGAZ,MAAM,CAACO,cAAP,CAAsBI,OAAtB,EAA+B,YAA/B,EAA6C;AAAEK,EAAAA,KAAK,EAAE;AAAT,CAA7C;AACAL,OAAO,CAACM,UAAR,GAAqBN,OAAO,CAACO,UAAR,GAAqBP,OAAO,CAACQ,OAAR,GAAkBR,OAAO,CAACS,SAAR,GAAoBT,OAAO,CAACU,KAAR,GAAgB,KAAK,CAArG;;AACA,MAAMC,OAAO,GAAGC,OAAH,sBAAb;;AACA,MAAMC,aAAa,GAAGD,OAAH,uCAAnB;;AACA,MAAME,MAAM,GAAGF,OAAH,gCAAZ;;AACA,MAAMG,KAAK,GAAGH,OAAH,+BAAX;;AACA,MAAMI,MAAM,GAAGJ,OAAH,gCAAZ;;AACA,MAAMK,OAAO,GAAGL,OAAH,2BAAb;;AACA,MAAMM,OAAO,GAAGN,OAAH,0BAAb;;AACA,MAAMO,QAAQ,GAAGP,OAAH,2BAAd;;AACA,MAAMQ,MAAM,GAAGR,OAAH,yBAAZ;;AACA,MAAMS,OAAO,GAAGT,OAAH,0BAAb;;AACAb,YAAY,CAACa,OAAD,sBAA0BZ,OAA1B,CAAZ;;AACA,SAASU,KAAT,CAAeY,MAAf,EAAuBC,OAAO,GAAG,EAAjC,EAAqC;AACjC,SAAOZ,OAAO,CAACa,OAAR,CAAgBD,OAAhB,EAAyBD,MAAzB,CAAP;AACH;;AACDtB,OAAO,CAACU,KAAR,GAAgBA,KAAhB;AACAV,OAAO,CAACS,SAAR,GAAoBQ,OAAO,CAACO,OAAR,EAApB;;AACA,IAAIC,SAAS,GAAGb,OAAH,6BAAb;;AACAvB,MAAM,CAACO,cAAP,CAAsBI,OAAtB,EAA+B,SAA/B,EAA0C;AAAEH,EAAAA,UAAU,EAAE,IAAd;AAAoBC,EAAAA,GAAG,EAAE,YAAY;AAAE,WAAO2B,SAAS,CAACD,OAAjB;AAA2B;AAAlE,CAA1C;AACAxB,OAAO,CAACO,UAAR,GAAqB;AACjBmB,EAAAA,IAAI,EAAEL,OAAO,CAACK,IADG;AAEjBC,EAAAA,KAAK,EAAET,OAAO,CAACM,OAFE;AAGjBI,EAAAA,MAAM,EAAET,QAAQ,CAACK,OAHA;AAIjBK,EAAAA,IAAI,EAAET,MAAM,CAACI;AAJI,CAArB;AAMAxB,OAAO,CAACM,UAAR,GAAqB;AACjBwB,EAAAA,GAAG,EAAEf,KAAK,CAACS,OADM;AAEjBO,EAAAA,IAAI,EAAEf,MAAM,CAACQ,OAFI;AAGjBQ,EAAAA,IAAI,EAAElB,MAAM,CAACU,OAHI;AAIjBS,EAAAA,WAAW,EAAEpB,aAAa,CAACW;AAJV,CAArB","sourcesContent":["\"use strict\";\nvar __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {\n    if (k2 === undefined) k2 = k;\n    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\n}) : (function(o, m, k, k2) {\n    if (k2 === undefined) k2 = k;\n    o[k2] = m[k];\n}));\nvar __exportStar = (this && this.__exportStar) || function(m, exports) {\n    for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);\n};\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.tokenizers = exports.transforms = exports.inspect = exports.stringify = exports.parse = void 0;\nconst index_1 = require(\"./parser/index\");\nconst description_1 = require(\"./parser/tokenizers/description\");\nconst name_1 = require(\"./parser/tokenizers/name\");\nconst tag_1 = require(\"./parser/tokenizers/tag\");\nconst type_1 = require(\"./parser/tokenizers/type\");\nconst index_2 = require(\"./stringifier/index\");\nconst align_1 = require(\"./transforms/align\");\nconst indent_1 = require(\"./transforms/indent\");\nconst crlf_1 = require(\"./transforms/crlf\");\nconst index_3 = require(\"./transforms/index\");\n__exportStar(require(\"./primitives\"), exports);\nfunction parse(source, options = {}) {\n    return index_1.default(options)(source);\n}\nexports.parse = parse;\nexports.stringify = index_2.default();\nvar inspect_1 = require(\"./stringifier/inspect\");\nObject.defineProperty(exports, \"inspect\", { enumerable: true, get: function () { return inspect_1.default; } });\nexports.transforms = {\n    flow: index_3.flow,\n    align: align_1.default,\n    indent: indent_1.default,\n    crlf: crlf_1.default,\n};\nexports.tokenizers = {\n    tag: tag_1.default,\n    type: type_1.default,\n    name: name_1.default,\n    description: description_1.default,\n};\n"],"file":"index.cjs"}
+{"version":3,"sources":["index.js"],"names":["__createBinding","Object","create","o","m","k","k2","undefined","defineProperty","enumerable","get","__exportStar","exports","p","prototype","hasOwnProperty","call","value","util","tokenizers","transforms","inspect","stringify","parse","index_1","require","description_1","name_1","tag_1","type_1","index_2","align_1","indent_1","crlf_1","index_3","util_1","source","options","default","inspect_1","flow","align","indent","crlf","tag","type","name","description","rewireSpecs","rewireSource","seedBlock","seedTokens"],"mappings":"AAAA;;AACA,IAAIA,eAAe,GAAI,QAAQ,KAAKA,eAAd,KAAmCC,MAAM,CAACC,MAAP,GAAiB,UAASC,CAAT,EAAYC,CAAZ,EAAeC,CAAf,EAAkBC,EAAlB,EAAsB;AAC5F,MAAIA,EAAE,KAAKC,SAAX,EAAsBD,EAAE,GAAGD,CAAL;AACtBJ,EAAAA,MAAM,CAACO,cAAP,CAAsBL,CAAtB,EAAyBG,EAAzB,EAA6B;AAAEG,IAAAA,UAAU,EAAE,IAAd;AAAoBC,IAAAA,GAAG,EAAE,YAAW;AAAE,aAAON,CAAC,CAACC,CAAD,CAAR;AAAc;AAApD,GAA7B;AACH,CAHwD,GAGnD,UAASF,CAAT,EAAYC,CAAZ,EAAeC,CAAf,EAAkBC,EAAlB,EAAsB;AACxB,MAAIA,EAAE,KAAKC,SAAX,EAAsBD,EAAE,GAAGD,CAAL;AACtBF,EAAAA,CAAC,CAACG,EAAD,CAAD,GAAQF,CAAC,CAACC,CAAD,CAAT;AACH,CANqB,CAAtB;;AAOA,IAAIM,YAAY,GAAI,QAAQ,KAAKA,YAAd,IAA+B,UAASP,CAAT,EAAYQ,OAAZ,EAAqB;AACnE,OAAK,IAAIC,CAAT,IAAcT,CAAd,EAAiB,IAAIS,CAAC,KAAK,SAAN,IAAmB,CAACZ,MAAM,CAACa,SAAP,CAAiBC,cAAjB,CAAgCC,IAAhC,CAAqCJ,OAArC,EAA8CC,CAA9C,CAAxB,EAA0Eb,eAAe,CAACY,OAAD,EAAUR,CAAV,EAAaS,CAAb,CAAf;AAC9F,CAFD;;AAGAZ,MAAM,CAACO,cAAP,CAAsBI,OAAtB,EAA+B,YAA/B,EAA6C;AAAEK,EAAAA,KAAK,EAAE;AAAT,CAA7C;AACAL,OAAO,CAACM,IAAR,GAAeN,OAAO,CAACO,UAAR,GAAqBP,OAAO,CAACQ,UAAR,GAAqBR,OAAO,CAACS,OAAR,GAAkBT,OAAO,CAACU,SAAR,GAAoBV,OAAO,CAACW,KAAR,GAAgB,KAAK,CAApH;;AACA,MAAMC,OAAO,GAAGC,OAAH,sBAAb;;AACA,MAAMC,aAAa,GAAGD,OAAH,uCAAnB;;AACA,MAAME,MAAM,GAAGF,OAAH,gCAAZ;;AACA,MAAMG,KAAK,GAAGH,OAAH,+BAAX;;AACA,MAAMI,MAAM,GAAGJ,OAAH,gCAAZ;;AACA,MAAMK,OAAO,GAAGL,OAAH,2BAAb;;AACA,MAAMM,OAAO,GAAGN,OAAH,0BAAb;;AACA,MAAMO,QAAQ,GAAGP,OAAH,2BAAd;;AACA,MAAMQ,MAAM,GAAGR,OAAH,yBAAZ;;AACA,MAAMS,OAAO,GAAGT,OAAH,0BAAb;;AACA,MAAMU,MAAM,GAAGV,OAAH,cAAZ;;AACAd,YAAY,CAACc,OAAD,sBAA0Bb,OAA1B,CAAZ;;AACA,SAASW,KAAT,CAAea,MAAf,EAAuBC,OAAO,GAAG,EAAjC,EAAqC;AACjC,SAAOb,OAAO,CAACc,OAAR,CAAgBD,OAAhB,EAAyBD,MAAzB,CAAP;AACH;;AACDxB,OAAO,CAACW,KAAR,GAAgBA,KAAhB;AACAX,OAAO,CAACU,SAAR,GAAoBQ,OAAO,CAACQ,OAAR,EAApB;;AACA,IAAIC,SAAS,GAAGd,OAAH,6BAAb;;AACAxB,MAAM,CAACO,cAAP,CAAsBI,OAAtB,EAA+B,SAA/B,EAA0C;AAAEH,EAAAA,UAAU,EAAE,IAAd;AAAoBC,EAAAA,GAAG,EAAE,YAAY;AAAE,WAAO6B,SAAS,CAACD,OAAjB;AAA2B;AAAlE,CAA1C;AACA1B,OAAO,CAACQ,UAAR,GAAqB;AACjBoB,EAAAA,IAAI,EAAEN,OAAO,CAACM,IADG;AAEjBC,EAAAA,KAAK,EAAEV,OAAO,CAACO,OAFE;AAGjBI,EAAAA,MAAM,EAAEV,QAAQ,CAACM,OAHA;AAIjBK,EAAAA,IAAI,EAAEV,MAAM,CAACK;AAJI,CAArB;AAMA1B,OAAO,CAACO,UAAR,GAAqB;AACjByB,EAAAA,GAAG,EAAEhB,KAAK,CAACU,OADM;AAEjBO,EAAAA,IAAI,EAAEhB,MAAM,CAACS,OAFI;AAGjBQ,EAAAA,IAAI,EAAEnB,MAAM,CAACW,OAHI;AAIjBS,EAAAA,WAAW,EAAErB,aAAa,CAACY;AAJV,CAArB;AAMA1B,OAAO,CAACM,IAAR,GAAe;AAAE8B,EAAAA,WAAW,EAAEb,MAAM,CAACa,WAAtB;AAAmCC,EAAAA,YAAY,EAAEd,MAAM,CAACc,YAAxD;AAAsEC,EAAAA,SAAS,EAAEf,MAAM,CAACe,SAAxF;AAAmGC,EAAAA,UAAU,EAAEhB,MAAM,CAACgB;AAAtH,CAAf","sourcesContent":["\"use strict\";\nvar __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {\n    if (k2 === undefined) k2 = k;\n    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\n}) : (function(o, m, k, k2) {\n    if (k2 === undefined) k2 = k;\n    o[k2] = m[k];\n}));\nvar __exportStar = (this && this.__exportStar) || function(m, exports) {\n    for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);\n};\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.util = exports.tokenizers = exports.transforms = exports.inspect = exports.stringify = exports.parse = void 0;\nconst index_1 = require(\"./parser/index\");\nconst description_1 = require(\"./parser/tokenizers/description\");\nconst name_1 = require(\"./parser/tokenizers/name\");\nconst tag_1 = require(\"./parser/tokenizers/tag\");\nconst type_1 = require(\"./parser/tokenizers/type\");\nconst index_2 = require(\"./stringifier/index\");\nconst align_1 = require(\"./transforms/align\");\nconst indent_1 = require(\"./transforms/indent\");\nconst crlf_1 = require(\"./transforms/crlf\");\nconst index_3 = require(\"./transforms/index\");\nconst util_1 = require(\"./util\");\n__exportStar(require(\"./primitives\"), exports);\nfunction parse(source, options = {}) {\n    return index_1.default(options)(source);\n}\nexports.parse = parse;\nexports.stringify = index_2.default();\nvar inspect_1 = require(\"./stringifier/inspect\");\nObject.defineProperty(exports, \"inspect\", { enumerable: true, get: function () { return inspect_1.default; } });\nexports.transforms = {\n    flow: index_3.flow,\n    align: align_1.default,\n    indent: indent_1.default,\n    crlf: crlf_1.default,\n};\nexports.tokenizers = {\n    tag: tag_1.default,\n    type: type_1.default,\n    name: name_1.default,\n    description: description_1.default,\n};\nexports.util = { rewireSpecs: util_1.rewireSpecs, rewireSource: util_1.rewireSource, seedBlock: util_1.seedBlock, seedTokens: util_1.seedTokens };\n"],"file":"index.cjs"}

package/lib/index.d.ts

@@ -7,6 +7,7 @@ import alignTransform from './transforms/align';
 import indentTransform from './transforms/indent';
 import crlfTransform from './transforms/crlf';
 import { flow as flowTransform } from './transforms/index';
+import { rewireSpecs, rewireSource, seedBlock, seedTokens } from './util';
 export * from './primitives';
 export declare function parse(source: string, options?: Partial<ParserOptions>): import("./primitives").Block[];
 export declare const stringify: import("./stringifier/index").Stringifier;
@@ -23,3 +24,9 @@ export declare const tokenizers: {
     name: typeof nameTokenizer;
     description: typeof descriptionTokenizer;
 };
+export declare const util: {
+    rewireSpecs: typeof rewireSpecs;
+    rewireSource: typeof rewireSource;
+    seedBlock: typeof seedBlock;
+    seedTokens: typeof seedTokens;
+};

package/lib/parser/index.cjs

@@ -4,6 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+const primitives_1 = require("../primitives.cjs");
+
 const util_1 = require("../util.cjs");
 
 const block_parser_1 = require("./block-parser.cjs");
@@ -24,11 +26,13 @@ function getParser({
   startLine = 0,
   fence = '```',
   spacing = 'compact',
+  markers = primitives_1.Markers,
   tokenizers = [tag_1.default(), type_1.default(spacing), name_1.default(), description_1.default(spacing)]
 } = {}) {
   if (startLine < 0 || startLine % 1 > 0) throw new Error('Invalid startLine');
   const parseSource = source_parser_1.default({
-    startLine
+    startLine,
+    markers
   });
   const parseBlock = block_parser_1.default({
     fence
@@ -50,7 +54,7 @@ function getParser({
       const sections = parseBlock(lines);
       const specs = sections.slice(1).map(parseSpec);
       blocks.push({
-        description: joinDescription(sections[0]),
+        description: joinDescription(sections[0], markers),
         tags: specs,
         source: lines,
         problems: specs.reduce((acc, spec) => acc.concat(spec.problems), [])