chore: update jsdoccomment, comment-parser and update API accordingly

Also updates lint-staged devDep.
gajus · Jul 25, 2021 · 2ab93a6 · 2ab93a6
1 parent 1059e9e
commit 2ab93a6
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 9 deletions.
diff --git a/package.json b/package.json
@@ -5,8 +5,8 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "0.9.0-alpha.5",
-    "comment-parser": "1.1.6-beta.2",
+    "@es-joy/jsdoccomment": "0.9.0-alpha.6",
+    "comment-parser": "1.1.6-beta.3",
     "debug": "^4.3.2",
     "esquery": "^1.4.0",
     "jsdoc-type-pratt-parser": "^1.0.4",
@@ -36,7 +36,7 @@
     "gitdown": "^3.1.4",
     "glob": "^7.1.7",
     "husky": "^7.0.1",
-    "lint-staged": "^11.1.0",
+    "lint-staged": "^11.1.1",
     "mocha": "^9.0.2",
     "nyc": "^15.1.0",
     "open-editor": "^3.0.0",

diff --git a/src/alignTransform.js b/src/alignTransform.js
@@ -169,7 +169,7 @@ const alignTransform = ({
 
     if (!intoTags) {
       if (tokens.description === '') {
-        tokens.postDelimiter = tokens.postDelimiter === '\r' ? '\r' : '';
+        tokens.postDelimiter = '';
       } else if (!preserveMainDescriptionPostDelimiter) {
         tokens.postDelimiter = ' ';
       }

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -116,15 +116,15 @@ const getUtils = (
   utils.getTagDescription = (tg) => {
     const descriptions = [];
     tg.source.some(({
-      tokens: {end, postDelimiter, tag, postTag, name, type, description},
+      tokens: {end, lineEnd, postDelimiter, tag, postTag, name, type, description},
     }) => {
       const desc = (
         tag && postTag ||
         !tag && !name && !type && postDelimiter || ''
 
       // Remove space
       ).slice(1) +
-        (description || '');
+        (description || '') + (lineEnd || '');
 
       if (end) {
         if (desc) {
@@ -258,6 +258,7 @@ const getUtils = (
       'postName',
       'description',
       'end',
+      'lineEnd',
     ].forEach((prop) => {
       tokens[prop] = '';
     });
@@ -319,7 +320,7 @@ const getUtils = (
 
   utils.makeMultiline = () => {
     const {source: [{tokens}]} = jsdoc;
-    const {postDelimiter, description, tag, name, type} = tokens;
+    const {postDelimiter, description, lineEnd, tag, name, type} = tokens;
 
     let {tokens: {
       postName, postTag, postType,
@@ -345,6 +346,7 @@ const getUtils = (
       // If a description were present, it may have whitespace attached
       //   due to being at the end of the single line
       description: description.trimEnd(),
+      lineEnd,
       name,
       postDelimiter,
       postName,

diff --git a/src/rules/checkLineAlignment.js b/src/rules/checkLineAlignment.js
@@ -20,7 +20,8 @@ const checkNotAlignedPerTag = (utils, tag, customSpacings) => {
   name +
   postName +
   description +
-  end
+  end +
+  lineEnd
    */
   let spacerProps;
   let contentProps;

diff --git a/src/rules/multilineBlocks.js b/src/rules/multilineBlocks.js
@@ -79,6 +79,7 @@ export default iterateJsdoc(({
           'postDelimiter',
           'tag',
           'type',
+          'lineEnd',
           'postType',
           'postTag',
           'name',
@@ -155,7 +156,7 @@ export default iterateJsdoc(({
           tokens: jsdoc.source.reduce((obj, {
             tokens: {
               description: desc, tag: tg, type: typ, name: nme,
-              postType, postName, postTag,
+              lineEnd, postType, postName, postTag,
             },
           }) => {
             if (typ) {
@@ -178,6 +179,7 @@ export default iterateJsdoc(({
             ) {
               obj.description += ' ';
             }
+            obj.lineEnd = lineEnd;
 
             // Already filtered for multiple tags
             obj.tag += tg;

diff --git a/src/rules/requireParam.js b/src/rules/requireParam.js
@@ -252,6 +252,7 @@ export default iterateJsdoc(({
           delimiter: '*',
           description: '',
           end: '',
+          lineEnd: '',
           name: functionParameterName,
           newAdd: true,
           postDelimiter: ' ',

diff --git a/test/iterateJsdoc.js b/test/iterateJsdoc.js
@@ -69,6 +69,7 @@ describe('iterateJsdoc', () => {
               delimiter: '',
               description: 'desc',
               end: '',
+              lineEnd: '',
               name: 'name',
               postDelimiter: '',
               postName: ' ',
@@ -86,6 +87,7 @@ describe('iterateJsdoc', () => {
               delimiter: '',
               description: '',
               end: '*/',
+              lineEnd: '',
               name: '',
               postDelimiter: '',
               postName: '',
@@ -110,6 +112,7 @@ describe('iterateJsdoc', () => {
                 delimiter: '/**',
                 description: 'SomeDescription',
                 end: '',
+                lineEnd: '',
                 name: '',
                 postDelimiter: ' ',
                 postName: '',