comment-parser 1.2.3 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
+# v1.3.1
+- allow for valid empty jsdoc; fixes #128
+
+# 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

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);
     }
@@ -81,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) {
@@ -98,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 });
@@ -148,7 +149,7 @@ var CommentParser = (function (exports) {
     }
 
     /**
-     * Splits the `@prefix` from remaining `Spec.lines[].token.descrioption` into the `tag` token,
+     * Splits the `@prefix` from remaining `Spec.lines[].token.description` into the `tag` token,
      * and populates `spec.tag`
      */
     function tagTokenizer() {
@@ -332,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;
         };
     }
@@ -347,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 !== '')
@@ -356,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(),
@@ -382,23 +384,20 @@ 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);
-        const notEmpty = (line) => line.tokens.description.trim() != '';
         return function (source) {
             const blocks = [];
             for (const line of splitLines(source)) {
                 const lines = parseSource(line);
                 if (lines === null)
                     continue;
-                if (lines.find(notEmpty) === undefined)
-                    continue;
                 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), []),
@@ -443,14 +442,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) {
@@ -462,15 +461,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:
@@ -513,7 +512,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) }));
         };
     }

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,23 +15,20 @@ 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);
-    const notEmpty = (line) => line.tokens.description.trim() != '';
     return function (source) {
         const blocks = [];
         for (const line of splitLines(source)) {
             const lines = parseSource(line);
             if (lines === null)
                 continue;
-            if (lines.find(notEmpty) === undefined)
-                continue;
             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/parser/tokenizers/tag.d.ts

@@ -1,6 +1,6 @@
 import { Tokenizer } from './index';
 /**
- * Splits the `@prefix` from remaining `Spec.lines[].token.descrioption` into the `tag` token,
+ * Splits the `@prefix` from remaining `Spec.lines[].token.description` into the `tag` token,
  * and populates `spec.tag`
  */
 export default function tagTokenizer(): Tokenizer;

package/es6/parser/tokenizers/tag.js

@@ -1,5 +1,5 @@
 /**
- * Splits the `@prefix` from remaining `Spec.lines[].token.descrioption` into the `tag` token,
+ * Splits the `@prefix` from remaining `Spec.lines[].token.description` into the `tag` token,
  * and populates `spec.tag`
  */
 export default function tagTokenizer() {

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/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
@@ -37,20 +41,16 @@ function getParser({
     tokenizers
   });
   const joinDescription = description_1.getJoiner(spacing);
-
-  const notEmpty = line => line.tokens.description.trim() != '';
-
   return function (source) {
     const blocks = [];
 
     for (const line of util_1.splitLines(source)) {
       const lines = parseSource(line);
       if (lines === null) continue;
-      if (lines.find(notEmpty) === undefined) continue;
       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/lib/parser/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["index.js"],"names":["Object","defineProperty","exports","value","util_1","require","block_parser_1","source_parser_1","spec_parser_1","tag_1","type_1","name_1","description_1","getParser","startLine","fence","spacing","tokenizers","default","Error","parseSource","parseBlock","parseSpec","joinDescription","getJoiner","notEmpty","line","tokens","description","trim","source","blocks","splitLines","lines","find","undefined","sections","specs","slice","map","push","tags","problems","reduce","acc","spec","concat"],"mappings":"AAAA;;AACAA,MAAM,CAACC,cAAP,CAAsBC,OAAtB,EAA+B,YAA/B,EAA6C;AAAEC,EAAAA,KAAK,EAAE;AAAT,CAA7C;;AACA,MAAMC,MAAM,GAAGC,OAAH,eAAZ;;AACA,MAAMC,cAAc,GAAGD,OAAH,sBAApB;;AACA,MAAME,eAAe,GAAGF,OAAH,uBAArB;;AACA,MAAMG,aAAa,GAAGH,OAAH,qBAAnB;;AACA,MAAMI,KAAK,GAAGJ,OAAH,wBAAX;;AACA,MAAMK,MAAM,GAAGL,OAAH,yBAAZ;;AACA,MAAMM,MAAM,GAAGN,OAAH,yBAAZ;;AACA,MAAMO,aAAa,GAAGP,OAAH,gCAAnB;;AACA,SAASQ,SAAT,CAAmB;AAAEC,EAAAA,SAAS,GAAG,CAAd;AAAiBC,EAAAA,KAAK,GAAG,KAAzB;AAAgCC,EAAAA,OAAO,GAAG,SAA1C;AAAqDC,EAAAA,UAAU,GAAG,CACjFR,KAAK,CAACS,OAAN,EADiF,EAEjFR,MAAM,CAACQ,OAAP,CAAeF,OAAf,CAFiF,EAGjFL,MAAM,CAACO,OAAP,EAHiF,EAIjFN,aAAa,CAACM,OAAd,CAAsBF,OAAtB,CAJiF;AAAlE,IAKZ,EALP,EAKW;AACP,MAAIF,SAAS,GAAG,CAAZ,IAAiBA,SAAS,GAAG,CAAZ,GAAgB,CAArC,EACI,MAAM,IAAIK,KAAJ,CAAU,mBAAV,CAAN;AACJ,QAAMC,WAAW,GAAGb,eAAe,CAACW,OAAhB,CAAwB;AAAEJ,IAAAA;AAAF,GAAxB,CAApB;AACA,QAAMO,UAAU,GAAGf,cAAc,CAACY,OAAf,CAAuB;AAAEH,IAAAA;AAAF,GAAvB,CAAnB;AACA,QAAMO,SAAS,GAAGd,aAAa,CAACU,OAAd,CAAsB;AAAED,IAAAA;AAAF,GAAtB,CAAlB;AACA,QAAMM,eAAe,GAAGX,aAAa,CAACY,SAAd,CAAwBR,OAAxB,CAAxB;;AACA,QAAMS,QAAQ,GAAIC,IAAD,IAAUA,IAAI,CAACC,MAAL,CAAYC,WAAZ,CAAwBC,IAAxB,MAAkC,EAA7D;;AACA,SAAO,UAAUC,MAAV,EAAkB;AACrB,UAAMC,MAAM,GAAG,EAAf;;AACA,SAAK,MAAML,IAAX,IAAmBtB,MAAM,CAAC4B,UAAP,CAAkBF,MAAlB,CAAnB,EAA8C;AAC1C,YAAMG,KAAK,GAAGb,WAAW,CAACM,IAAD,CAAzB;AACA,UAAIO,KAAK,KAAK,IAAd,EACI;AACJ,UAAIA,KAAK,CAACC,IAAN,CAAWT,QAAX,MAAyBU,SAA7B,EACI;AACJ,YAAMC,QAAQ,GAAGf,UAAU,CAACY,KAAD,CAA3B;AACA,YAAMI,KAAK,GAAGD,QAAQ,CAACE,KAAT,CAAe,CAAf,EAAkBC,GAAlB,CAAsBjB,SAAtB,CAAd;AACAS,MAAAA,MAAM,CAACS,IAAP,CAAY;AACRZ,QAAAA,WAAW,EAAEL,eAAe,CAACa,QAAQ,CAAC,CAAD,CAAT,CADpB;AAERK,QAAAA,IAAI,EAAEJ,KAFE;AAGRP,QAAAA,MAAM,EAAEG,KAHA;AAIRS,QAAAA,QAAQ,EAAEL,KAAK,CAACM,MAAN,CAAa,CAACC,GAAD,EAAMC,IAAN,KAAeD,GAAG,CAACE,MAAJ,CAAWD,IAAI,CAACH,QAAhB,CAA5B,EAAuD,EAAvD;AAJF,OAAZ;AAMH;;AACD,WAAOX,MAAP;AACH,GAlBD;AAmBH;;AACD7B,OAAO,CAACgB,OAAR,GAAkBL,SAAlB","sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nconst util_1 = require(\"../util\");\nconst block_parser_1 = require(\"./block-parser\");\nconst source_parser_1 = require(\"./source-parser\");\nconst spec_parser_1 = require(\"./spec-parser\");\nconst tag_1 = require(\"./tokenizers/tag\");\nconst type_1 = require(\"./tokenizers/type\");\nconst name_1 = require(\"./tokenizers/name\");\nconst description_1 = require(\"./tokenizers/description\");\nfunction getParser({ startLine = 0, fence = '```', spacing = 'compact', tokenizers = [\n    tag_1.default(),\n    type_1.default(spacing),\n    name_1.default(),\n    description_1.default(spacing),\n], } = {}) {\n    if (startLine < 0 || startLine % 1 > 0)\n        throw new Error('Invalid startLine');\n    const parseSource = source_parser_1.default({ startLine });\n    const parseBlock = block_parser_1.default({ fence });\n    const parseSpec = spec_parser_1.default({ tokenizers });\n    const joinDescription = description_1.getJoiner(spacing);\n    const notEmpty = (line) => line.tokens.description.trim() != '';\n    return function (source) {\n        const blocks = [];\n        for (const line of util_1.splitLines(source)) {\n            const lines = parseSource(line);\n            if (lines === null)\n                continue;\n            if (lines.find(notEmpty) === undefined)\n                continue;\n            const sections = parseBlock(lines);\n            const specs = sections.slice(1).map(parseSpec);\n            blocks.push({\n                description: joinDescription(sections[0]),\n                tags: specs,\n                source: lines,\n                problems: specs.reduce((acc, spec) => acc.concat(spec.problems), []),\n            });\n        }\n        return blocks;\n    };\n}\nexports.default = getParser;\n"],"file":"index.cjs"}
+{"version":3,"sources":["index.js"],"names":["Object","defineProperty","exports","value","primitives_1","require","util_1","block_parser_1","source_parser_1","spec_parser_1","tag_1","type_1","name_1","description_1","getParser","startLine","fence","spacing","markers","Markers","tokenizers","default","Error","parseSource","parseBlock","parseSpec","joinDescription","getJoiner","source","blocks","line","splitLines","lines","sections","specs","slice","map","push","description","tags","problems","reduce","acc","spec","concat"],"mappings":"AAAA;;AACAA,MAAM,CAACC,cAAP,CAAsBC,OAAtB,EAA+B,YAA/B,EAA6C;AAAEC,EAAAA,KAAK,EAAE;AAAT,CAA7C;;AACA,MAAMC,YAAY,GAAGC,OAAH,qBAAlB;;AACA,MAAMC,MAAM,GAAGD,OAAH,eAAZ;;AACA,MAAME,cAAc,GAAGF,OAAH,sBAApB;;AACA,MAAMG,eAAe,GAAGH,OAAH,uBAArB;;AACA,MAAMI,aAAa,GAAGJ,OAAH,qBAAnB;;AACA,MAAMK,KAAK,GAAGL,OAAH,wBAAX;;AACA,MAAMM,MAAM,GAAGN,OAAH,yBAAZ;;AACA,MAAMO,MAAM,GAAGP,OAAH,yBAAZ;;AACA,MAAMQ,aAAa,GAAGR,OAAH,gCAAnB;;AACA,SAASS,SAAT,CAAmB;AAAEC,EAAAA,SAAS,GAAG,CAAd;AAAiBC,EAAAA,KAAK,GAAG,KAAzB;AAAgCC,EAAAA,OAAO,GAAG,SAA1C;AAAqDC,EAAAA,OAAO,GAAGd,YAAY,CAACe,OAA5E;AAAqFC,EAAAA,UAAU,GAAG,CACjHV,KAAK,CAACW,OAAN,EADiH,EAEjHV,MAAM,CAACU,OAAP,CAAeJ,OAAf,CAFiH,EAGjHL,MAAM,CAACS,OAAP,EAHiH,EAIjHR,aAAa,CAACQ,OAAd,CAAsBJ,OAAtB,CAJiH;AAAlG,IAKZ,EALP,EAKW;AACP,MAAIF,SAAS,GAAG,CAAZ,IAAiBA,SAAS,GAAG,CAAZ,GAAgB,CAArC,EACI,MAAM,IAAIO,KAAJ,CAAU,mBAAV,CAAN;AACJ,QAAMC,WAAW,GAAGf,eAAe,CAACa,OAAhB,CAAwB;AAAEN,IAAAA,SAAF;AAAaG,IAAAA;AAAb,GAAxB,CAApB;AACA,QAAMM,UAAU,GAAGjB,cAAc,CAACc,OAAf,CAAuB;AAAEL,IAAAA;AAAF,GAAvB,CAAnB;AACA,QAAMS,SAAS,GAAGhB,aAAa,CAACY,OAAd,CAAsB;AAAED,IAAAA;AAAF,GAAtB,CAAlB;AACA,QAAMM,eAAe,GAAGb,aAAa,CAACc,SAAd,CAAwBV,OAAxB,CAAxB;AACA,SAAO,UAAUW,MAAV,EAAkB;AACrB,UAAMC,MAAM,GAAG,EAAf;;AACA,SAAK,MAAMC,IAAX,IAAmBxB,MAAM,CAACyB,UAAP,CAAkBH,MAAlB,CAAnB,EAA8C;AAC1C,YAAMI,KAAK,GAAGT,WAAW,CAACO,IAAD,CAAzB;AACA,UAAIE,KAAK,KAAK,IAAd,EACI;AACJ,YAAMC,QAAQ,GAAGT,UAAU,CAACQ,KAAD,CAA3B;AACA,YAAME,KAAK,GAAGD,QAAQ,CAACE,KAAT,CAAe,CAAf,EAAkBC,GAAlB,CAAsBX,SAAtB,CAAd;AACAI,MAAAA,MAAM,CAACQ,IAAP,CAAY;AACRC,QAAAA,WAAW,EAAEZ,eAAe,CAACO,QAAQ,CAAC,CAAD,CAAT,EAAcf,OAAd,CADpB;AAERqB,QAAAA,IAAI,EAAEL,KAFE;AAGRN,QAAAA,MAAM,EAAEI,KAHA;AAIRQ,QAAAA,QAAQ,EAAEN,KAAK,CAACO,MAAN,CAAa,CAACC,GAAD,EAAMC,IAAN,KAAeD,GAAG,CAACE,MAAJ,CAAWD,IAAI,CAACH,QAAhB,CAA5B,EAAuD,EAAvD;AAJF,OAAZ;AAMH;;AACD,WAAOX,MAAP;AACH,GAhBD;AAiBH;;AACD3B,OAAO,CAACmB,OAAR,GAAkBP,SAAlB","sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nconst primitives_1 = require(\"../primitives\");\nconst util_1 = require(\"../util\");\nconst block_parser_1 = require(\"./block-parser\");\nconst source_parser_1 = require(\"./source-parser\");\nconst spec_parser_1 = require(\"./spec-parser\");\nconst tag_1 = require(\"./tokenizers/tag\");\nconst type_1 = require(\"./tokenizers/type\");\nconst name_1 = require(\"./tokenizers/name\");\nconst description_1 = require(\"./tokenizers/description\");\nfunction getParser({ startLine = 0, fence = '```', spacing = 'compact', markers = primitives_1.Markers, tokenizers = [\n    tag_1.default(),\n    type_1.default(spacing),\n    name_1.default(),\n    description_1.default(spacing),\n], } = {}) {\n    if (startLine < 0 || startLine % 1 > 0)\n        throw new Error('Invalid startLine');\n    const parseSource = source_parser_1.default({ startLine, markers });\n    const parseBlock = block_parser_1.default({ fence });\n    const parseSpec = spec_parser_1.default({ tokenizers });\n    const joinDescription = description_1.getJoiner(spacing);\n    return function (source) {\n        const blocks = [];\n        for (const line of util_1.splitLines(source)) {\n            const lines = parseSource(line);\n            if (lines === null)\n                continue;\n            const sections = parseBlock(lines);\n            const specs = sections.slice(1).map(parseSpec);\n            blocks.push({\n                description: joinDescription(sections[0], markers),\n                tags: specs,\n                source: lines,\n                problems: specs.reduce((acc, spec) => acc.concat(spec.problems), []),\n            });\n        }\n        return blocks;\n    };\n}\nexports.default = getParser;\n"],"file":"index.cjs"}

package/lib/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/lib/parser/source-parser.cjs

@@ -9,7 +9,8 @@ const primitives_1 = require("../primitives.cjs");
 const util_1 = require("../util.cjs");
 
 function getParser({
-  startLine = 0
+  startLine = 0,
+  markers = primitives_1.Markers
 } = {}) {
   let block = null;
   let num = startLine;
@@ -19,10 +20,10 @@ function getParser({
     [tokens.lineEnd, rest] = util_1.splitCR(rest);
     [tokens.start, rest] = util_1.splitSpace(rest);
 
-    if (block === null && rest.startsWith(primitives_1.Markers.start) && !rest.startsWith(primitives_1.Markers.nostart)) {
+    if (block === null && rest.startsWith(markers.start) && !rest.startsWith(markers.nostart)) {
       block = [];
-      tokens.delimiter = rest.slice(0, primitives_1.Markers.start.length);
-      rest = rest.slice(primitives_1.Markers.start.length);
+      tokens.delimiter = rest.slice(0, markers.start.length);
+      rest = rest.slice(markers.start.length);
       [tokens.postDelimiter, rest] = util_1.splitSpace(rest);
     }
 
@@ -31,18 +32,18 @@ function getParser({
       return null;
     }
 
-    const isClosed = rest.trimRight().endsWith(primitives_1.Markers.end);
+    const isClosed = rest.trimRight().endsWith(markers.end);
 
-    if (tokens.delimiter === '' && rest.startsWith(primitives_1.Markers.delim) && !rest.startsWith(primitives_1.Markers.end)) {
-      tokens.delimiter = primitives_1.Markers.delim;
-      rest = rest.slice(primitives_1.Markers.delim.length);
+    if (tokens.delimiter === '' && rest.startsWith(markers.delim) && !rest.startsWith(markers.end)) {
+      tokens.delimiter = markers.delim;
+      rest = rest.slice(markers.delim.length);
       [tokens.postDelimiter, rest] = util_1.splitSpace(rest);
     }
 
     if (isClosed) {
       const trimmed = rest.trimRight();
-      tokens.end = rest.slice(trimmed.length - primitives_1.Markers.end.length);
-      rest = trimmed.slice(0, -primitives_1.Markers.end.length);
+      tokens.end = rest.slice(trimmed.length - markers.end.length);
+      rest = trimmed.slice(0, -markers.end.length);
     }
 
     tokens.description = rest;