Merge pull request #324 from weirdan/make-link-params-always-present

Make LinkEntry.params to be string, always
psalm · Jan 15, 2021 · c66868a · c66868a
2 parents 246b204 + b6a65e7
commit c66868a
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 10 deletions.
diff --git a/src/CommentParser/index.ts b/src/CommentParser/index.ts
@@ -14,7 +14,7 @@ export class CommentParser {
       snippets.push({
         link: 'https://' + matches[0], 
         snippet: matches[1],
-        params: matches[3]
+        params: matches[3] || ''
       });
 
       seen.add(matches[0]);

diff --git a/test/CommentParser.test.ts b/test/CommentParser.test.ts
@@ -14,18 +14,17 @@ describe('CommentParser', () => {
   test('returns a link when there is one', () => {
     expect(
       parser.parseComment('One link: https://psalm.dev/r/0f9f06ebd6')
-    )
-      .toEqual([
-        { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6' }
-      ])
+    ).toEqual([
+      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6', params: '' }
+    ])
   })
 
   test('returns all links when there are many', () => {
     expect(
       parser.parseComment('psalm.dev/r/0f9f06ebd6 and psalm.dev/r/whatever are not the same')
     ).toEqual([
-      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6' },
-      { link: 'https://psalm.dev/r/whatever', snippet: 'whatever' }
+      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6', params: '' },
+      { link: 'https://psalm.dev/r/whatever', snippet: 'whatever', params: '' }
     ])
   })
 
@@ -37,16 +36,16 @@ describe('CommentParser', () => {
     expect(
       parser.parseComment(comment)
     ).toEqual([
-      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6' },
-      { link: 'https://psalm.dev/r/whatever', snippet: 'whatever' }
+      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6', params: '' },
+      { link: 'https://psalm.dev/r/whatever', snippet: 'whatever', params: '' }
     ])
   })
 
   test('returns unique links', () => {
     expect(
       parser.parseComment('https://psalm.dev/r/0f9f06ebd6 and https://psalm.dev/r/0f9f06ebd6 are the same link')
     ).toEqual([
-      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6' }
+      { link: 'https://psalm.dev/r/0f9f06ebd6', snippet: '0f9f06ebd6', params: '' }
     ])
   })
 
@@ -61,4 +60,10 @@ describe('CommentParser', () => {
       }
     ])
   })
+
+  test('returns empty string as params for links without params', () => {
+    expect(
+      parser.parseComment('One link: https://psalm.dev/r/0f9f06ebd6')[0].params
+    ).toEqual('')
+  })
 })