comment-parser 1.1.0 → 1.1.1

package/browser/index.js

@@ -225,8 +225,10 @@ var CommentParser = (function (exports) {
      * and populates the `spec.name`
      */
     function nameTokenizer() {
+        const typeEnd = (num, { tokens }, i) => tokens.type === '' ? num : i;
         return (spec) => {
-            const { tokens } = spec.source[0];
+            // look for the name in the line where {type} ends
+            const { tokens } = spec.source[spec.source.reduce(typeEnd, 0)];
             const source = tokens.description.trimLeft();
             const quotedGroups = source.split('"');
             // if it starts with quoted group, assume it is a literal

package/es6/parser/tokenizers/name.js

@@ -5,8 +5,10 @@ const isQuoted = (s) => s && s.startsWith('"') && s.endsWith('"');
  * and populates the `spec.name`
  */
 export default function nameTokenizer() {
+    const typeEnd = (num, { tokens }, i) => tokens.type === '' ? num : i;
     return (spec) => {
-        const { tokens } = spec.source[0];
+        // look for the name in the line where {type} ends
+        const { tokens } = spec.source[spec.source.reduce(typeEnd, 0)];
         const source = tokens.description.trimLeft();
         const quotedGroups = source.split('"');
         // if it starts with quoted group, assume it is a literal

package/es6/util.d.ts

@@ -12,7 +12,7 @@ export declare function seedTokens(tokens?: Partial<Tokens>): Tokens;
  */
 export declare function rewireSource(block: Block): Block;
 /**
- * Assures Block.tags[].source contains references to the Block.source items,
+ * 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
  */

package/es6/util.js

@@ -32,7 +32,7 @@ export function rewireSource(block) {
     return block;
 }
 /**
- * Assures Block.tags[].source contains references to the Block.source items,
+ * 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
  */

package/lib/parser/tokenizers/name.js

@@ -7,8 +7,10 @@ const isQuoted = (s) => s && s.startsWith('"') && s.endsWith('"');
  * and populates the `spec.name`
  */
 function nameTokenizer() {
+    const typeEnd = (num, { tokens }, i) => tokens.type === '' ? num : i;
     return (spec) => {
-        const { tokens } = spec.source[0];
+        // look for the name in the line where {type} ends
+        const { tokens } = spec.source[spec.source.reduce(typeEnd, 0)];
         const source = tokens.description.trimLeft();
         const quotedGroups = source.split('"');
         // if it starts with quoted group, assume it is a literal

package/lib/util.d.ts

@@ -12,7 +12,7 @@ export declare function seedTokens(tokens?: Partial<Tokens>): Tokens;
  */
 export declare function rewireSource(block: Block): Block;
 /**
- * Assures Block.tags[].source contains references to the Block.source items,
+ * 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
  */

package/lib/util.js

@@ -42,7 +42,7 @@ function rewireSource(block) {
 }
 exports.rewireSource = rewireSource;
 /**
- * Assures Block.tags[].source contains references to the Block.source items,
+ * 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
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comment-parser",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Generic JSDoc-like comment parser",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/parser/tokenizers/name.ts

@@ -1,4 +1,4 @@
-import { Spec } from '../../primitives';
+import { Spec, Line } from '../../primitives';
 import { splitSpace, isSpace, seedBlock } from '../../util';
 import { Tokenizer } from './index';
 
@@ -9,8 +9,12 @@ const isQuoted = (s: string) => s && s.startsWith('"') && s.endsWith('"');
  * and populates the `spec.name`
  */
 export default function nameTokenizer(): Tokenizer {
+  const typeEnd = (num: number, { tokens }: Line, i: number) =>
+    tokens.type === '' ? num : i;
+
   return (spec: Spec): Spec => {
-    const { tokens } = spec.source[0];
+    // look for the name in the line where {type} ends
+    const { tokens } = spec.source[spec.source.reduce(typeEnd, 0)];
     const source = tokens.description.trimLeft();
 
     const quotedGroups = source.split('"');

package/src/util.ts

@@ -72,7 +72,7 @@ export function rewireSource(block: Block): Block {
 }
 
 /**
- * Assures Block.tags[].source contains references to the Block.source items,
+ * 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
  */

package/tests/e2e/issue-109.spec.js

@@ -15,31 +15,35 @@ const source = `
 test('default', () => {
   const parsed = parse(source);
   // console.log(inspect(parsed[0]));
-  expect(parsed[0].problems).toEqual([]);
-  expect(parsed[0].tags[1].problems).toEqual([]);
-  expect(parsed[0].tags[1].type).toEqual('function(number,{x:string})');
+  expect(parsed[0].tags[1]).toMatchObject({
+    tag: 'property',
+    type: 'function(number,{x:string})',
+    name: 'numberEater',
+    description: 'Method which takes a number.',
+    problems: [],
+  });
 });
 
 test('preserve', () => {
   const parsed = parse(source, { spacing: 'preserve' });
   // console.log(inspect(parsed[0]));
-  expect(parsed[0].problems).toEqual([]);
-  expect(parsed[0].tags[1].problems).toEqual([]);
-  expect(parsed[0].tags[1].type).toEqual(
-    'function(\n  number,\n  {x:string}\n)'
-  );
-  expect(parsed[0].tags[1].description).toEqual(
-    'numberEater Method\n   which takes a number.'
-  );
+  expect(parsed[0].tags[1]).toMatchObject({
+    tag: 'property',
+    type: 'function(\n  number,\n  {x:string}\n)',
+    name: 'numberEater',
+    description: 'Method\n   which takes a number.',
+    problems: [],
+  });
 });
 
 test('compact', () => {
   const parsed = parse(source, { spacing: 'compact' });
   // console.log(inspect(parsed[0]));
-  expect(parsed[0].problems).toEqual([]);
-  expect(parsed[0].tags[1].problems).toEqual([]);
-  expect(parsed[0].tags[1].type).toEqual('function(number,{x:string})');
-  expect(parsed[0].tags[1].description).toEqual(
-    'numberEater Method which takes a number.'
-  );
+  expect(parsed[0].tags[1]).toMatchObject({
+    tag: 'property',
+    type: 'function(number,{x:string})',
+    name: 'numberEater',
+    description: 'Method which takes a number.',
+    problems: [],
+  });
 });

package/tests/e2e/issue-113.spec.js

@@ -0,0 +1,23 @@
+const { parse, inspect } = require('../../lib');
+
+const source = `
+  /** Multi-line typedef for an options object type.
+   *
+   * @typedef {{
+   *   prop: number
+   * }} MyOptions description text
+   */`;
+
+test('name after multiline tag', () => {
+  const parsed = parse(source);
+  // console.log(inspect(parsed[0]));
+
+  expect(parsed[0].problems).toEqual([]);
+  expect(parsed[0].tags[0]).toMatchObject({
+    tag: 'typedef',
+    name: 'MyOptions',
+    type: '{prop: number}',
+    description: 'description text',
+    problems: [],
+  });
+});

package/tests/unit/spec-name-tokenizer.spec.ts

@@ -692,3 +692,45 @@ test('default with arrow', () => {
     })
   );
 });
+
+test('after multiline {type}', () => {
+  const sourceIn = [
+    {
+      number: 0,
+      source: '...',
+      tokens: seedTokens({
+        tag: '@aram',
+        postTag: ' ',
+        type: '{function(',
+      }),
+    },
+    {
+      number: 1,
+      source: '...',
+      tokens: seedTokens({ type: '  number' }),
+    },
+    {
+      number: 2,
+      source: '...',
+      tokens: seedTokens({
+        type: ')}',
+        postType: ' ',
+        description: 'paramname description text',
+      }),
+    },
+  ];
+
+  const sourceOut = JSON.parse(JSON.stringify(sourceIn));
+  Object.assign(sourceOut[2].tokens, {
+    name: 'paramname',
+    postName: ' ',
+    description: 'description text',
+  });
+
+  expect(tokenize(seedSpec({ source: sourceIn }))).toEqual(
+    seedSpec({
+      name: 'paramname',
+      source: sourceOut,
+    })
+  );
+});