comment-parser 1.4.1 → 1.4.3

package/src/parser/tokenizers/name.ts

@@ -13,9 +13,19 @@ export default function nameTokenizer(): Tokenizer {
     tokens.type === '' ? num : i;
 
   return (spec: Spec): Spec => {
-    // look for the name in the line where {type} ends
-    const { tokens } = spec.source[spec.source.reduce(typeEnd, 0)];
-    const source = tokens.description.trimLeft();
+    // look for the name starting in the line where {type} ends
+    let finalTypeLine = spec.source.reduce(typeEnd, 0);
+
+    let tokens;
+    do {
+      ({ tokens } = spec.source[finalTypeLine]);
+      if (tokens.description.trim()) {
+        break;
+      }
+      finalTypeLine++;
+    } while (spec.source[finalTypeLine]);
+
+    const source = tokens.description.trimStart();
 
     const quotedGroups = source.split('"');
 

package/src/parser/tokenizers/tag.ts

@@ -20,6 +20,10 @@ export default function tagTokenizer(): Tokenizer {
       return spec;
     }
 
+    if (match[1].includes('/')) {
+      return spec;
+    }
+
     tokens.tag = match[1];
     tokens.postTag = match[3];
     tokens.description = tokens.description.slice(match[0].length);

package/src/parser/tokenizers/type.ts

@@ -23,7 +23,7 @@ export type Joiner = (parts: string[]) => string;
 export type Spacing = 'compact' | 'preserve' | Joiner;
 
 /**
- * Sets splits remaining `Spec.lines[].tokes.description` into `type` and `description`
+ * Sets splits remaining `Spec.lines[].tokens.description` into `type` and `description`
  * tokens and populates Spec.type`
  *
  * @param {Spacing} spacing tells how to deal with a whitespace
@@ -35,9 +35,18 @@ export default function typeTokenizer(spacing: Spacing = 'compact'): Tokenizer {
     let curlies = 0;
     let lines: [Tokens, string][] = [];
 
-    for (const [i, { tokens }] of spec.source.entries()) {
+    let descriptionBegun = false;
+    let firstTypeIteration = true;
+    for (const { tokens } of spec.source.values()) {
       let type = '';
-      if (i === 0 && tokens.description[0] !== '{') return spec;
+      if (!descriptionBegun && tokens.description.trim()) {
+        descriptionBegun = true;
+      } else if (!descriptionBegun) {
+        continue;
+      }
+
+      if (firstTypeIteration && tokens.description[0] !== '{') return spec;
+      firstTypeIteration = false;
 
       for (const ch of tokens.description) {
         if (ch === '{') curlies++;
@@ -50,6 +59,10 @@ export default function typeTokenizer(spacing: Spacing = 'compact'): Tokenizer {
       if (curlies === 0) break;
     }
 
+    if (!descriptionBegun) {
+      return spec;
+    }
+
     if (curlies !== 0) {
       spec.problems.push({
         code: 'spec:type:unpaired-curlies',

package/tests/unit/parser.spec.ts

@@ -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

@@ -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

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