comment-parser 1.1.6-beta.3 → 1.2.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 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
+
+# v1.2.0
+- keep and handle appropriately CR line endings
+
 # v1.1.6-beta.3
 - process CRs as a separate .lineEnd toke
 

package/browser/index.js

@@ -19,6 +19,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 +40,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+/;
     /**
@@ -622,12 +635,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/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/package.json

@@ -1,9 +1,9 @@
 {
   "name": "comment-parser",
-  "version": "1.1.6-beta.3",
+  "version": "1.2.3",
   "description": "Generic JSDoc-like comment parser",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "lib/index.cjs",
   "exports": {
     ".": {
       "import": "./es6/index.js",
@@ -46,7 +46,7 @@
     "typescript": "^4.3.4"
   },
   "engines": {
-    "node": ">= 12.0.0"
+    "node": "^12.20 || ^14.14.0 || ^16"
   },
   "scripts": {
     "build": "rimraf lib es6 browser; tsc -p tsconfig.json && tsc -p tsconfig.node.json && rollup -o browser/index.js -f iife --context window -n CommentParser es6/index.js && convert-extension cjs lib/ && cd es6 && replace \"from '(\\.[^']*)'\" \"from '\\$1.js'\" * -r --include=\"*.js\"",

package/src/index.ts

@@ -8,6 +8,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';
 
@@ -31,3 +32,5 @@ export const tokenizers = {
   name: nameTokenizer,
   description: descriptionTokenizer,
 };
+
+export const util = { rewireSpecs, rewireSource, seedBlock, seedTokens };