comment-parser 1.4.3 → 1.4.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # v1.4.1
 
+## 1.4.4
+
+### Patch Changes
+
+- fully exclude slash-containing strings like @npm/package from tag detection @brettz9
+
 ## 1.4.3
 
 ### Patch Changes

package/browser/index.js

@@ -60,7 +60,7 @@ var CommentParser = (function (exports) {
         return block;
     }
 
-    const reTag = /^@\S+/;
+    const reTag = /^@[^\s/]+(?=\s|$)/;
     /**
      * Creates configured `Parser`
      * @param {Partial<Options>} options

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

@@ -3,7 +3,7 @@ import { Line } from '../primitives.js';
  * 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/es6/parser/block-parser.js

@@ -1,4 +1,4 @@
-const reTag = /^@\S+/;
+const reTag = /^@[^\s/]+(?=\s|$)/;
 /**
  * Creates configured `Parser`
  * @param {Partial<Options>} options

package/lib/parser/block-parser.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = getParser;
-const reTag = /^@\S+/;
+const reTag = /^@[^\s/]+(?=\s|$)/;
 /**
  * Creates configured `Parser`
  * @param {Partial<Options>} options

package/lib/parser/block-parser.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"block-parser.cjs","names":["Object","defineProperty","exports","value","default","getParser","reTag","fence","fencer","getFencer","toggleFence","source","isFenced","parseBlock","sections","line","test","tokens","description","push","length","split"],"sources":["block-parser.js"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.default = getParser;\nconst reTag = /^@\\S+/;\n/**\n * Creates configured `Parser`\n * @param {Partial<Options>} options\n */\nfunction getParser({ fence = '```', } = {}) {\n    const fencer = getFencer(fence);\n    const toggleFence = (source, isFenced) => fencer(source) ? !isFenced : isFenced;\n    return function parseBlock(source) {\n        // start with description section\n        const sections = [[]];\n        let isFenced = false;\n        for (const line of source) {\n            if (reTag.test(line.tokens.description) && !isFenced) {\n                sections.push([line]);\n            }\n            else {\n                sections[sections.length - 1].push(line);\n            }\n            isFenced = toggleFence(line.tokens.description, isFenced);\n        }\n        return sections;\n    };\n}\nfunction getFencer(fence) {\n    if (typeof fence === 'string')\n        return (source) => source.split(fence).length % 2 === 0;\n    return fence;\n}\n"],"mappings":"AAAA,YAAY;;AACZA,MAAM,CAACC,cAAc,CAACC,OAAO,EAAE,YAAY,EAAE;EAAEC,KAAK,EAAE;AAAK,CAAC,CAAC;AAC7DD,OAAO,CAACE,OAAO,GAAGC,SAAS;AAC3B,MAAMC,KAAK,GAAG,OAAO;AACrB;AACA;AACA;AACA;AACA,SAASD,SAASA,CAAC;EAAEE,KAAK,GAAG;AAAO,CAAC,GAAG,CAAC,CAAC,EAAE;EACxC,MAAMC,MAAM,GAAGC,SAAS,CAACF,KAAK,CAAC;EAC/B,MAAMG,WAAW,GAAGA,CAACC,MAAM,EAAEC,QAAQ,KAAKJ,MAAM,CAACG,MAAM,CAAC,GAAG,CAACC,QAAQ,GAAGA,QAAQ;EAC/E,OAAO,SAASC,UAAUA,CAACF,MAAM,EAAE;IAC/B;IACA,MAAMG,QAAQ,GAAG,CAAC,EAAE,CAAC;IACrB,IAAIF,QAAQ,GAAG,KAAK;IACpB,KAAK,MAAMG,IAAI,IAAIJ,MAAM,EAAE;MACvB,IAAIL,KAAK,CAACU,IAAI,CAACD,IAAI,CAACE,MAAM,CAACC,WAAW,CAAC,IAAI,CAACN,QAAQ,EAAE;QAClDE,QAAQ,CAACK,IAAI,CAAC,CAACJ,IAAI,CAAC,CAAC;MACzB,CAAC,MACI;QACDD,QAAQ,CAACA,QAAQ,CAACM,MAAM,GAAG,CAAC,CAAC,CAACD,IAAI,CAACJ,IAAI,CAAC;MAC5C;MACAH,QAAQ,GAAGF,WAAW,CAACK,IAAI,CAACE,MAAM,CAACC,WAAW,EAAEN,QAAQ,CAAC;IAC7D;IACA,OAAOE,QAAQ;EACnB,CAAC;AACL;AACA,SAASL,SAASA,CAACF,KAAK,EAAE;EACtB,IAAI,OAAOA,KAAK,KAAK,QAAQ,EACzB,OAAQI,MAAM,IAAKA,MAAM,CAACU,KAAK,CAACd,KAAK,CAAC,CAACa,MAAM,GAAG,CAAC,KAAK,CAAC;EAC3D,OAAOb,KAAK;AAChB","ignoreList":[]}
+{"version":3,"file":"block-parser.cjs","names":["Object","defineProperty","exports","value","default","getParser","reTag","fence","fencer","getFencer","toggleFence","source","isFenced","parseBlock","sections","line","test","tokens","description","push","length","split"],"sources":["block-parser.js"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\nexports.default = getParser;\nconst reTag = /^@[^\\s/]+(?=\\s|$)/;\n/**\n * Creates configured `Parser`\n * @param {Partial<Options>} options\n */\nfunction getParser({ fence = '```', } = {}) {\n    const fencer = getFencer(fence);\n    const toggleFence = (source, isFenced) => fencer(source) ? !isFenced : isFenced;\n    return function parseBlock(source) {\n        // start with description section\n        const sections = [[]];\n        let isFenced = false;\n        for (const line of source) {\n            if (reTag.test(line.tokens.description) && !isFenced) {\n                sections.push([line]);\n            }\n            else {\n                sections[sections.length - 1].push(line);\n            }\n            isFenced = toggleFence(line.tokens.description, isFenced);\n        }\n        return sections;\n    };\n}\nfunction getFencer(fence) {\n    if (typeof fence === 'string')\n        return (source) => source.split(fence).length % 2 === 0;\n    return fence;\n}\n"],"mappings":"AAAA,YAAY;;AACZA,MAAM,CAACC,cAAc,CAACC,OAAO,EAAE,YAAY,EAAE;EAAEC,KAAK,EAAE;AAAK,CAAC,CAAC;AAC7DD,OAAO,CAACE,OAAO,GAAGC,SAAS;AAC3B,MAAMC,KAAK,GAAG,mBAAmB;AACjC;AACA;AACA;AACA;AACA,SAASD,SAASA,CAAC;EAAEE,KAAK,GAAG;AAAO,CAAC,GAAG,CAAC,CAAC,EAAE;EACxC,MAAMC,MAAM,GAAGC,SAAS,CAACF,KAAK,CAAC;EAC/B,MAAMG,WAAW,GAAGA,CAACC,MAAM,EAAEC,QAAQ,KAAKJ,MAAM,CAACG,MAAM,CAAC,GAAG,CAACC,QAAQ,GAAGA,QAAQ;EAC/E,OAAO,SAASC,UAAUA,CAACF,MAAM,EAAE;IAC/B;IACA,MAAMG,QAAQ,GAAG,CAAC,EAAE,CAAC;IACrB,IAAIF,QAAQ,GAAG,KAAK;IACpB,KAAK,MAAMG,IAAI,IAAIJ,MAAM,EAAE;MACvB,IAAIL,KAAK,CAACU,IAAI,CAACD,IAAI,CAACE,MAAM,CAACC,WAAW,CAAC,IAAI,CAACN,QAAQ,EAAE;QAClDE,QAAQ,CAACK,IAAI,CAAC,CAACJ,IAAI,CAAC,CAAC;MACzB,CAAC,MACI;QACDD,QAAQ,CAACA,QAAQ,CAACM,MAAM,GAAG,CAAC,CAAC,CAACD,IAAI,CAACJ,IAAI,CAAC;MAC5C;MACAH,QAAQ,GAAGF,WAAW,CAACK,IAAI,CAACE,MAAM,CAACC,WAAW,EAAEN,QAAQ,CAAC;IAC7D;IACA,OAAOE,QAAQ;EACnB,CAAC;AACL;AACA,SAASL,SAASA,CAACF,KAAK,EAAE;EACtB,IAAI,OAAOA,KAAK,KAAK,QAAQ,EACzB,OAAQI,MAAM,IAAKA,MAAM,CAACU,KAAK,CAACd,KAAK,CAAC,CAACa,MAAM,GAAG,CAAC,KAAK,CAAC;EAC3D,OAAOb,KAAK;AAChB","ignoreList":[]}

package/lib/parser/block-parser.d.ts

@@ -3,7 +3,7 @@ import { Line } from '../primitives.js';
  * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "description": "Generic JSDoc-like comment parser",
   "type": "module",
   "main": "lib/index.cjs",
@@ -57,8 +57,12 @@
     "pretest": "rimraf coverage; npm run build",
     "test": "prettier --check src tests && jest --verbose",
     "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"
+    "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]]);
+});