npm - comment-parser - Versions diffs - 1.4.0 → 1.4.2 - Mend

comment-parser 1.4.0 → 1.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (70) hide show

package/CHANGELOG.md +54 -2
package/es6/parser/tokenizers/name.js +11 -3
package/es6/parser/tokenizers/tag.js +3 -0
package/es6/parser/tokenizers/type.d.ts +1 -1
package/es6/parser/tokenizers/type.js +15 -3
package/es6/primitives.js +1 -1
package/jest.config.cjs +5 -7
package/package.json +14 -10
package/src/parser/tokenizers/name.ts +13 -3
package/src/parser/tokenizers/tag.ts +4 -0
package/src/parser/tokenizers/type.ts +16 -3
package/tests/e2e/examples.js +41 -0
package/tests/unit/parser.spec.ts +234 -0
package/tests/unit/spec-tag-tokenizer.spec.ts +30 -0
package/tsconfig.node.json +0 -1
package/browser/index.js +0 -650
package/lib/index.cjs +0 -88
package/lib/index.cjs.map +0 -1
package/lib/index.d.ts +0 -32
package/lib/parser/block-parser.cjs +0 -44
package/lib/parser/block-parser.cjs.map +0 -1
package/lib/parser/block-parser.d.ts +0 -24
package/lib/parser/index.cjs +0 -65
package/lib/parser/index.cjs.map +0 -1
package/lib/parser/index.d.ts +0 -11
package/lib/parser/source-parser.cjs +0 -68
package/lib/parser/source-parser.cjs.map +0 -1
package/lib/parser/source-parser.d.ts +0 -7
package/lib/parser/spec-parser.cjs +0 -29
package/lib/parser/spec-parser.cjs.map +0 -1
package/lib/parser/spec-parser.d.ts +0 -7
package/lib/parser/tokenizers/description.cjs +0 -62
package/lib/parser/tokenizers/description.cjs.map +0 -1
package/lib/parser/tokenizers/description.d.ts +0 -20
package/lib/parser/tokenizers/index.cjs +0 -6
package/lib/parser/tokenizers/index.cjs.map +0 -1
package/lib/parser/tokenizers/index.d.ts +0 -7
package/lib/parser/tokenizers/name.cjs +0 -109
package/lib/parser/tokenizers/name.cjs.map +0 -1
package/lib/parser/tokenizers/name.d.ts +0 -6
package/lib/parser/tokenizers/tag.cjs +0 -37
package/lib/parser/tokenizers/tag.cjs.map +0 -1
package/lib/parser/tokenizers/tag.d.ts +0 -6
package/lib/parser/tokenizers/type.cjs +0 -79
package/lib/parser/tokenizers/type.cjs.map +0 -1
package/lib/parser/tokenizers/type.d.ts +0 -27
package/lib/primitives.cjs +0 -17
package/lib/primitives.cjs.map +0 -1
package/lib/primitives.d.ts +0 -54
package/lib/stringifier/index.cjs +0 -18
package/lib/stringifier/index.cjs.map +0 -1
package/lib/stringifier/index.d.ts +0 -3
package/lib/stringifier/inspect.cjs +0 -72
package/lib/stringifier/inspect.cjs.map +0 -1
package/lib/stringifier/inspect.d.ts +0 -2
package/lib/transforms/align.cjs +0 -127
package/lib/transforms/align.cjs.map +0 -1
package/lib/transforms/align.d.ts +0 -3
package/lib/transforms/crlf.cjs +0 -44
package/lib/transforms/crlf.cjs.map +0 -1
package/lib/transforms/crlf.d.ts +0 -3
package/lib/transforms/indent.cjs +0 -58
package/lib/transforms/indent.cjs.map +0 -1
package/lib/transforms/indent.d.ts +0 -2
package/lib/transforms/index.cjs +0 -13
package/lib/transforms/index.cjs.map +0 -1
package/lib/transforms/index.d.ts +0 -3
package/lib/util.cjs +0 -113
package/lib/util.cjs.map +0 -1
package/lib/util.d.ts +0 -21

package/tests/unit/parser.spec.ts CHANGED Viewed

@@ -167,6 +167,240 @@ test('block with tags', () => {
   ]);
 });
+test('tag with name and description on second line', () => {
+  const parsed = getParser()(`
+  /**
+   * @param {string}
+   *   foo The foo.
+   */`);
+  expect(parsed).toEqual([
+    {
+      description: '',
+      tags: [
+        {
+          tag: 'param',
+          name: 'foo',
+          type: 'string',
+          optional: false,
+          description: 'The foo.',
+          problems: [],
+          source: [
+            {
+              number: 2,
+              source: '   * @param {string}',
+              tokens: seedTokens({
+                start: '   ',
+                delimiter: '*',
+                postDelimiter: ' ',
+                tag: '@param',
+                postTag: ' ',
+                type: '{string}',
+              }),
+            },
+            {
+              number: 3,
+              source: '   *   foo The foo.',
+              tokens: seedTokens({
+                start: '   ',
+                delimiter: '*',
+                postDelimiter: '   ',
+                name: 'foo',
+                postName: ' ',
+                description: 'The foo.',
+              }),
+            },
+            {
+              number: 4,
+              source: '   */',
+              tokens: seedTokens({
+                start: '   ',
+                end: '*/',
+              }),
+            },
+          ],
+        },
+      ],
+      source: [
+        {
+          number: 1,
+          source: '  /**',
+          tokens: seedTokens({
+            delimiter: '/**',
+            start: '  ',
+          }),
+        },
+        {
+          number: 2,
+          source: '   * @param {string}',
+          tokens: seedTokens({
+            start: '   ',
+            delimiter: '*',
+            postDelimiter: ' ',
+            tag: '@param',
+            postTag: ' ',
+            type: '{string}',
+          }),
+        },
+        {
+          number: 3,
+          source: '   *   foo The foo.',
+          tokens: seedTokens({
+            start: '   ',
+            delimiter: '*',
+            postDelimiter: '   ',
+            name: 'foo',
+            postName: ' ',
+            description: 'The foo.',
+          }),
+        },
+        {
+          number: 4,
+          source: '   */',
+          tokens: seedTokens({
+            start: '   ',
+            end: '*/',
+          }),
+        },
+      ],
+      problems: [],
+    },
+  ]);
+});
+test('tag with type, name and description on subsequent lines', () => {
+  const parsed = getParser()(`
+  /**
+   * @param
+   * {string}
+   *   foo
+   * The foo.
+   */`);
+  expect(parsed).toEqual([
+    {
+      description: '',
+      tags: [
+        {
+          tag: 'param',
+          name: 'foo',
+          type: 'string',
+          optional: false,
+          description: 'The foo.',
+          problems: [],
+          source: [
+            {
+              number: 2,
+              source: '   * @param',
+              tokens: seedTokens({
+                start: '   ',
+                delimiter: '*',
+                postDelimiter: ' ',
+                tag: '@param',
+              }),
+            },
+            {
+              number: 3,
+              source: '   * {string}',
+              tokens: seedTokens({
+                start: '   ',
+                delimiter: '*',
+                postDelimiter: ' ',
+                type: '{string}',
+              }),
+            },
+            {
+              number: 4,
+              source: '   *   foo',
+              tokens: seedTokens({
+                start: '   ',
+                delimiter: '*',
+                postDelimiter: '   ',
+                name: 'foo',
+              }),
+            },
+            {
+              number: 5,
+              source: '   * The foo.',
+              tokens: seedTokens({
+                start: '   ',
+                delimiter: '*',
+                postDelimiter: ' ',
+                description: 'The foo.',
+              }),
+            },
+            {
+              number: 6,
+              source: '   */',
+              tokens: seedTokens({
+                start: '   ',
+                end: '*/',
+              }),
+            },
+          ],
+        },
+      ],
+      source: [
+        {
+          number: 1,
+          source: '  /**',
+          tokens: seedTokens({
+            delimiter: '/**',
+            start: '  ',
+          }),
+        },
+        {
+          number: 2,
+          source: '   * @param',
+          tokens: seedTokens({
+            start: '   ',
+            delimiter: '*',
+            postDelimiter: ' ',
+            tag: '@param',
+          }),
+        },
+        {
+          number: 3,
+          source: '   * {string}',
+          tokens: seedTokens({
+            start: '   ',
+            delimiter: '*',
+            postDelimiter: ' ',
+            type: '{string}',
+          }),
+        },
+        {
+          number: 4,
+          source: '   *   foo',
+          tokens: seedTokens({
+            start: '   ',
+            delimiter: '*',
+            postDelimiter: '   ',
+            name: 'foo',
+          }),
+        },
+        {
+          number: 5,
+          source: '   * The foo.',
+          tokens: seedTokens({
+            start: '   ',
+            delimiter: '*',
+            postDelimiter: ' ',
+            description: 'The foo.',
+          }),
+        },
+        {
+          number: 6,
+          source: '   */',
+          tokens: seedTokens({
+            start: '   ',
+            end: '*/',
+          }),
+        },
+      ],
+      problems: [],
+    },
+  ]);
+});
 test('no source cloning', () => {
   const parsed = getParser()(`
   /**

package/tests/unit/spec-tag-tokenizer.spec.ts CHANGED Viewed

@@ -74,6 +74,36 @@ test('require @', () => {
   );
 });
+test('disallow @npm/package format', () => {
+  expect(
+    tokenize(
+      seedSpec({
+        source: [
+          {
+            number: 42,
+            source: '...',
+            tokens: seedTokens({
+              description: '@npm/package',
+            }),
+          },
+        ],
+      })
+    )
+  ).toEqual(
+    seedSpec({
+      source: [
+        {
+          number: 42,
+          source: '...',
+          tokens: seedTokens({
+            description: '@npm/package',
+          }),
+        },
+      ],
+    })
+  );
+});
 test.each([
   ['@+tag', '+tag'],
   ['@-tag', '-tag'],

package/tsconfig.node.json CHANGED Viewed

@@ -2,7 +2,6 @@
   "compilerOptions": {
     "target": "es2015",
     "module": "commonjs",
-    "moduleResolution": "node16",
     "declaration": true,
     "outDir": "./lib",
     "lib": ["es2016", "es5"]