comment-parser 1.4.2 → 1.4.4

package/lib/util.cjs

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isSpace = isSpace;
+exports.hasCR = hasCR;
+exports.splitCR = splitCR;
+exports.splitSpace = splitSpace;
+exports.splitLines = splitLines;
+exports.seedBlock = seedBlock;
+exports.seedSpec = seedSpec;
+exports.seedTokens = seedTokens;
+exports.rewireSource = rewireSource;
+exports.rewireSpecs = rewireSpecs;
+function isSpace(source) {
+  return /^\s+$/.test(source);
+}
+function hasCR(source) {
+  return /\r$/.test(source);
+}
+function splitCR(source) {
+  const matches = source.match(/\r+$/);
+  return matches == null ? ['', source] : [source.slice(-matches[0].length), source.slice(0, -matches[0].length)];
+}
+function splitSpace(source) {
+  const matches = source.match(/^\s+/);
+  return matches == null ? ['', source] : [source.slice(0, matches[0].length), source.slice(matches[0].length)];
+}
+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);
+}
+function seedTokens(tokens = {}) {
+  return Object.assign({
+    start: '',
+    delimiter: '',
+    postDelimiter: '',
+    tag: '',
+    postTag: '',
+    name: '',
+    postName: '',
+    type: '',
+    postType: '',
+    description: '',
+    end: '',
+    lineEnd: ''
+  }, tokens);
+}
+/**
+ * Assures Block.tags[].source contains references to the Block.source items,
+ * using Block.source as a source of truth. This is a counterpart of rewireSpecs
+ * @param block parsed coments block
+ */
+function rewireSource(block) {
+  const source = block.source.reduce((acc, line) => acc.set(line.number, line), new Map());
+  for (const spec of block.tags) {
+    spec.source = spec.source.map(line => source.get(line.number));
+  }
+  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;
+}
+//# sourceMappingURL=util.cjs.map

package/lib/util.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.cjs","names":["Object","defineProperty","exports","value","isSpace","hasCR","splitCR","splitSpace","splitLines","seedBlock","seedSpec","seedTokens","rewireSource","rewireSpecs","source","test","matches","match","slice","length","split","block","assign","description","tags","problems","spec","tag","name","type","optional","tokens","start","delimiter","postDelimiter","postTag","postName","postType","end","lineEnd","reduce","acc","line","set","number","Map","map","get"],"sources":["util.js"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.isSpace = isSpace;\nexports.hasCR = hasCR;\nexports.splitCR = splitCR;\nexports.splitSpace = splitSpace;\nexports.splitLines = splitLines;\nexports.seedBlock = seedBlock;\nexports.seedSpec = seedSpec;\nexports.seedTokens = seedTokens;\nexports.rewireSource = rewireSource;\nexports.rewireSpecs = rewireSpecs;\nfunction isSpace(source) {\n    return /^\\s+$/.test(source);\n}\nfunction hasCR(source) {\n    return /\\r$/.test(source);\n}\nfunction splitCR(source) {\n    const matches = source.match(/\\r+$/);\n    return matches == null\n        ? ['', source]\n        : [source.slice(-matches[0].length), source.slice(0, -matches[0].length)];\n}\nfunction splitSpace(source) {\n    const matches = source.match(/^\\s+/);\n    return matches == null\n        ? ['', source]\n        : [source.slice(0, matches[0].length), source.slice(matches[0].length)];\n}\nfunction splitLines(source) {\n    return source.split(/\\n/);\n}\nfunction seedBlock(block = {}) {\n    return Object.assign({ description: '', tags: [], source: [], problems: [] }, block);\n}\nfunction seedSpec(spec = {}) {\n    return Object.assign({ tag: '', name: '', type: '', optional: false, description: '', problems: [], source: [] }, spec);\n}\nfunction seedTokens(tokens = {}) {\n    return Object.assign({ start: '', delimiter: '', postDelimiter: '', tag: '', postTag: '', name: '', postName: '', type: '', postType: '', description: '', end: '', lineEnd: '' }, tokens);\n}\n/**\n * Assures Block.tags[].source contains references to the Block.source items,\n * using Block.source as a source of truth. This is a counterpart of rewireSpecs\n * @param block parsed coments block\n */\nfunction rewireSource(block) {\n    const source = block.source.reduce((acc, line) => acc.set(line.number, line), new Map());\n    for (const spec of block.tags) {\n        spec.source = spec.source.map((line) => source.get(line.number));\n    }\n    return block;\n}\n/**\n * Assures Block.source contains references to the Block.tags[].source items,\n * using Block.tags[].source as a source of truth. This is a counterpart of rewireSource\n * @param block parsed coments block\n */\nfunction rewireSpecs(block) {\n    const source = block.tags.reduce((acc, spec) => spec.source.reduce((acc, line) => acc.set(line.number, line), acc), new Map());\n    block.source = block.source.map((line) => source.get(line.number) || line);\n    return block;\n}\n"],"mappings":"AAAA,YAAY;;AACZA,MAAM,CAACC,cAAc,CAACC,OAAO,EAAE,YAAY,EAAE;EAAEC,KAAK,EAAE;AAAK,CAAC,CAAC;AAC7DD,OAAO,CAACE,OAAO,GAAGA,OAAO;AACzBF,OAAO,CAACG,KAAK,GAAGA,KAAK;AACrBH,OAAO,CAACI,OAAO,GAAGA,OAAO;AACzBJ,OAAO,CAACK,UAAU,GAAGA,UAAU;AAC/BL,OAAO,CAACM,UAAU,GAAGA,UAAU;AAC/BN,OAAO,CAACO,SAAS,GAAGA,SAAS;AAC7BP,OAAO,CAACQ,QAAQ,GAAGA,QAAQ;AAC3BR,OAAO,CAACS,UAAU,GAAGA,UAAU;AAC/BT,OAAO,CAACU,YAAY,GAAGA,YAAY;AACnCV,OAAO,CAACW,WAAW,GAAGA,WAAW;AACjC,SAAST,OAAOA,CAACU,MAAM,EAAE;EACrB,OAAO,OAAO,CAACC,IAAI,CAACD,MAAM,CAAC;AAC/B;AACA,SAAST,KAAKA,CAACS,MAAM,EAAE;EACnB,OAAO,KAAK,CAACC,IAAI,CAACD,MAAM,CAAC;AAC7B;AACA,SAASR,OAAOA,CAACQ,MAAM,EAAE;EACrB,MAAME,OAAO,GAAGF,MAAM,CAACG,KAAK,CAAC,MAAM,CAAC;EACpC,OAAOD,OAAO,IAAI,IAAI,GAChB,CAAC,EAAE,EAAEF,MAAM,CAAC,GACZ,CAACA,MAAM,CAACI,KAAK,CAAC,CAACF,OAAO,CAAC,CAAC,CAAC,CAACG,MAAM,CAAC,EAAEL,MAAM,CAACI,KAAK,CAAC,CAAC,EAAE,CAACF,OAAO,CAAC,CAAC,CAAC,CAACG,MAAM,CAAC,CAAC;AACjF;AACA,SAASZ,UAAUA,CAACO,MAAM,EAAE;EACxB,MAAME,OAAO,GAAGF,MAAM,CAACG,KAAK,CAAC,MAAM,CAAC;EACpC,OAAOD,OAAO,IAAI,IAAI,GAChB,CAAC,EAAE,EAAEF,MAAM,CAAC,GACZ,CAACA,MAAM,CAACI,KAAK,CAAC,CAAC,EAAEF,OAAO,CAAC,CAAC,CAAC,CAACG,MAAM,CAAC,EAAEL,MAAM,CAACI,KAAK,CAACF,OAAO,CAAC,CAAC,CAAC,CAACG,MAAM,CAAC,CAAC;AAC/E;AACA,SAASX,UAAUA,CAACM,MAAM,EAAE;EACxB,OAAOA,MAAM,CAACM,KAAK,CAAC,IAAI,CAAC;AAC7B;AACA,SAASX,SAASA,CAACY,KAAK,GAAG,CAAC,CAAC,EAAE;EAC3B,OAAOrB,MAAM,CAACsB,MAAM,CAAC;IAAEC,WAAW,EAAE,EAAE;IAAEC,IAAI,EAAE,EAAE;IAAEV,MAAM,EAAE,EAAE;IAAEW,QAAQ,EAAE;EAAG,CAAC,EAAEJ,KAAK,CAAC;AACxF;AACA,SAASX,QAAQA,CAACgB,IAAI,GAAG,CAAC,CAAC,EAAE;EACzB,OAAO1B,MAAM,CAACsB,MAAM,CAAC;IAAEK,GAAG,EAAE,EAAE;IAAEC,IAAI,EAAE,EAAE;IAAEC,IAAI,EAAE,EAAE;IAAEC,QAAQ,EAAE,KAAK;IAAEP,WAAW,EAAE,EAAE;IAAEE,QAAQ,EAAE,EAAE;IAAEX,MAAM,EAAE;EAAG,CAAC,EAAEY,IAAI,CAAC;AAC3H;AACA,SAASf,UAAUA,CAACoB,MAAM,GAAG,CAAC,CAAC,EAAE;EAC7B,OAAO/B,MAAM,CAACsB,MAAM,CAAC;IAAEU,KAAK,EAAE,EAAE;IAAEC,SAAS,EAAE,EAAE;IAAEC,aAAa,EAAE,EAAE;IAAEP,GAAG,EAAE,EAAE;IAAEQ,OAAO,EAAE,EAAE;IAAEP,IAAI,EAAE,EAAE;IAAEQ,QAAQ,EAAE,EAAE;IAAEP,IAAI,EAAE,EAAE;IAAEQ,QAAQ,EAAE,EAAE;IAAEd,WAAW,EAAE,EAAE;IAAEe,GAAG,EAAE,EAAE;IAAEC,OAAO,EAAE;EAAG,CAAC,EAAER,MAAM,CAAC;AAC9L;AACA;AACA;AACA;AACA;AACA;AACA,SAASnB,YAAYA,CAACS,KAAK,EAAE;EACzB,MAAMP,MAAM,GAAGO,KAAK,CAACP,MAAM,CAAC0B,MAAM,CAAC,CAACC,GAAG,EAAEC,IAAI,KAAKD,GAAG,CAACE,GAAG,CAACD,IAAI,CAACE,MAAM,EAAEF,IAAI,CAAC,EAAE,IAAIG,GAAG,CAAC,CAAC,CAAC;EACxF,KAAK,MAAMnB,IAAI,IAAIL,KAAK,CAACG,IAAI,EAAE;IAC3BE,IAAI,CAACZ,MAAM,GAAGY,IAAI,CAACZ,MAAM,CAACgC,GAAG,CAAEJ,IAAI,IAAK5B,MAAM,CAACiC,GAAG,CAACL,IAAI,CAACE,MAAM,CAAC,CAAC;EACpE;EACA,OAAOvB,KAAK;AAChB;AACA;AACA;AACA;AACA;AACA;AACA,SAASR,WAAWA,CAACQ,KAAK,EAAE;EACxB,MAAMP,MAAM,GAAGO,KAAK,CAACG,IAAI,CAACgB,MAAM,CAAC,CAACC,GAAG,EAAEf,IAAI,KAAKA,IAAI,CAACZ,MAAM,CAAC0B,MAAM,CAAC,CAACC,GAAG,EAAEC,IAAI,KAAKD,GAAG,CAACE,GAAG,CAACD,IAAI,CAACE,MAAM,EAAEF,IAAI,CAAC,EAAED,GAAG,CAAC,EAAE,IAAII,GAAG,CAAC,CAAC,CAAC;EAC9HxB,KAAK,CAACP,MAAM,GAAGO,KAAK,CAACP,MAAM,CAACgC,GAAG,CAAEJ,IAAI,IAAK5B,MAAM,CAACiC,GAAG,CAACL,IAAI,CAACE,MAAM,CAAC,IAAIF,IAAI,CAAC;EAC1E,OAAOrB,KAAK;AAChB","ignoreList":[]}

package/lib/util.d.ts

@@ -0,0 +1,21 @@
+import { Block, Tokens, Spec } from './primitives.js';
+export declare function isSpace(source: string): boolean;
+export declare function hasCR(source: string): boolean;
+export declare function splitCR(source: string): [string, string];
+export declare function splitSpace(source: string): [string, string];
+export declare function splitLines(source: string): string[];
+export declare function seedBlock(block?: Partial<Block>): Block;
+export declare function seedSpec(spec?: Partial<Spec>): Spec;
+export declare function seedTokens(tokens?: Partial<Tokens>): Tokens;
+/**
+ * Assures Block.tags[].source contains references to the Block.source items,
+ * using Block.source as a source of truth. This is a counterpart of rewireSpecs
+ * @param block parsed coments block
+ */
+export declare function rewireSource(block: Block): 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
+ */
+export declare function rewireSpecs(block: Block): Block;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "Generic JSDoc-like comment parser",
   "type": "module",
   "main": "lib/index.cjs",
@@ -56,7 +56,13 @@
     "format": "prettier --write src tests",
     "pretest": "rimraf coverage; npm run build",
     "test": "prettier --check src tests && jest --verbose",
-    "preversion": "npm run build"
+    "preversion": "npm run build",
+    "postversion": "git add . && git commit -m \"chore: release v$(node -p \"require('./package.json').version\")\"",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build",
+    "release:add": "git pull origin master && changeset",
+    "release:version": "git pull origin master && changeset version && npm install",
+    "release:publish": "git pull origin master && npm run build && changeset publish && git push --follow-tags"
   },
   "repository": {
     "type": "git",

package/src/parser/block-parser.ts

@@ -1,12 +1,12 @@
 import { Line } from '../primitives.js';
 
-const reTag = /^@\S+/;
+const reTag = /^@[^\s/]+(?=\s|$)/;
 
 /**
  * Groups source lines in sections representing tags.
  * First section is a block description if present. Last section captures lines starting with
  * the last tag to the end of the block, including dangling closing marker.
- * @param {Line[]} block souce lines making a single comment block
+ * @param {Line[]} block source lines making a single comment block
  */
 export type Parser = (block: Line[]) => Line[][];
 

package/tests/unit/block-parser.spec.ts

@@ -167,3 +167,83 @@ test('fence function', () => {
   expect(groups.length).toBe(2);
   expect(groups).toEqual([source.slice(0, 5), source.slice(5)]);
 });
+
+test('should not treat @npm/package or @ember/debug as tags', () => {
+  const parser = getParser();
+  const lines: Line[] = [
+    {
+      number: 1,
+      source: '/**',
+      tokens: seedTokens({
+        start: '',
+        delimiter: '/**',
+        postDelimiter: '',
+        description: '',
+        end: '',
+      }),
+    },
+    {
+      number: 2,
+      source: ' * Description line',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        description: 'Description line',
+        end: '',
+      }),
+    },
+    {
+      number: 3,
+      source: ' * @ember/debug should not be treated as tag',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        description: '@ember/debug should not be treated as tag',
+        end: '',
+      }),
+    },
+    {
+      number: 4,
+      source: ' * @npm/package should not be treated as tag either',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        description: '@npm/package should not be treated as tag either',
+        end: '',
+      }),
+    },
+    {
+      number: 5,
+      source: ' * @param {string} value',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '*',
+        postDelimiter: ' ',
+        description: '@param {string} value',
+        end: '',
+      }),
+    },
+    {
+      number: 6,
+      source: ' */',
+      tokens: seedTokens({
+        start: ' ',
+        delimiter: '',
+        postDelimiter: '',
+        description: '',
+        end: '*/',
+      }),
+    },
+  ];
+
+  const groups: Line[][] = parser(lines);
+
+  // Should have 2 sections: description (lines 0-3) and @param tag (lines 4-5)
+  // @ember/debug and @npm/package should stay in description, not create new sections
+  expect(groups.length).toBe(2);
+  expect(groups[0]).toEqual([lines[0], lines[1], lines[2], lines[3]]);
+  expect(groups[1]).toEqual([lines[4], lines[5]]);
+});