chore: update to eslint 7

In process, also: 1. Adds `output` missing in various tests. 2. Fixes `require-example` indent 3. Updates `require-file-overview` to work with ESLint 7 4. Fixes `require-description-complete-sentence` to avoid capitalizing idential string found not at beginning of sentence
gajus · May 9, 2020 · 30835cd · 30835cd
1 parent a516865
commit 30835cd
Show file tree

Hide file tree

Showing 13 changed files with 843 additions and 23 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -24,12 +24,16 @@ script:
   - npm run build
 env:
   matrix:
+    - ESLINT=7
     - ESLINT=6
 matrix:
   fast_finish: true
   include:
     - node_js: 'lts/*'
       env: LINT=true
+  exclude:
+    - node_js: 8
+      env: ESLINT=7
 after_success:
   - export NODE_ENV=production
   - npm run build

diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
     "babel-plugin-istanbul": "^6.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
-    "eslint": "6.8.0",
+    "eslint": "7.0.0",
     "eslint-config-canonical": "^19.0.4",
     "gitdown": "^3.1.3",
     "glob": "^7.1.6",
@@ -55,7 +55,7 @@
   "main": "./dist/index.js",
   "name": "eslint-plugin-jsdoc",
   "peerDependencies": {
-    "eslint": "^6.0.0"
+    "eslint": "^6.0.0 || ^7.0.0"
   },
   "repository": {
     "type": "git",

diff --git a/src/rules/requireDescriptionCompleteSentence.js b/src/rules/requireDescriptionCompleteSentence.js
@@ -102,7 +102,7 @@ const validateDescription = (description, reportOrig, jsdocNode, abbreviationsRe
             return $1 + capitalize(beginning);
           });
         } else {
-          text = text.replace(beginning, capitalize(beginning));
+          text = text.replace(new RegExp('((?:[.!?]|\\*|\\})\\s*)' + _.escapeRegExp(beginning), 'u'), '$1' + capitalize(beginning));
         }
       }
 

diff --git a/src/rules/requireExample.js b/src/rules/requireExample.js
@@ -4,6 +4,7 @@ import warnRemovedSettings from '../warnRemovedSettings';
 
 export default iterateJsdoc(({
   jsdoc,
+  node,
   report,
   utils,
   context,
@@ -34,7 +35,7 @@ export default iterateJsdoc(({
         tag: targetTagName,
         type: '',
       });
-    });
+    }, node);
 
     return;
   }

diff --git a/src/rules/requireFileOverview.js b/src/rules/requireFileOverview.js
@@ -47,7 +47,7 @@ export default iterateJsdoc(({
       //   from `undefined` to `false` so can detect next time
       state.hasDuplicates[tagName] = false;
       state.hasNonCommentBeforeTag[tagName] = state.hasNonComment &&
-        state.hasNonComment < jsdocNode.start;
+        state.hasNonComment < jsdocNode.range[0];
     }
   }
 }, {
@@ -122,7 +122,7 @@ export default iterateJsdoc(({
   },
   nonComment ({state, node}) {
     if (!state.hasNonComment) {
-      state.hasNonComment = node.start;
+      state.hasNonComment = node.range[0];
     }
   },
 });
diff --git a/test/rules/assertions/checkAlignment.js b/test/rules/assertions/checkAlignment.js
@@ -204,6 +204,11 @@ function quux (foo) {
           message: 'Expected JSDoc block to be aligned.',
         },
       ],
+      output: `
+        /**
+         * A jsdoc not attached to any node.
+         */
+      `,
     },
     {
       code: `
@@ -221,6 +226,15 @@ function quux (foo) {
           message: 'Expected JSDoc block to be aligned.',
         },
       ],
+      output: `
+        class Foo {
+          /**
+           *  Some method
+           * @param a
+           */
+          quux(a) {}
+        }
+      `,
     },
   ],
   valid: [

diff --git a/test/rules/assertions/checkPropertyNames.js b/test/rules/assertions/checkPropertyNames.js
@@ -66,6 +66,13 @@ export default {
           message: 'Duplicate @property "employees[].name"',
         },
       ],
+      output: `
+          /**
+           * Assign the project to a list of employees.
+           * @typedef (SomeType) SomeTypedef
+           * @property {string} employees[].name - The name of an employee.
+           */
+      `,
     },
     {
       code: `
@@ -106,6 +113,16 @@ export default {
           message: 'Duplicate @property "cfg.foo"',
         },
       ],
+      output: `
+          /**
+           * @typedef (SomeType) SomeTypedef
+           * @property cfg
+           * @property cfg.foo
+           */
+          function quux ({foo, bar}) {
+
+          }
+      `,
     },
     {
       code: `
@@ -126,6 +143,17 @@ export default {
           message: 'Duplicate @property "cfg.foo"',
         },
       ],
+      output: `
+          /**
+           * @typedef (SomeType) SomeTypedef
+           * @property cfg
+           * @property cfg.foo
+           * @property baz
+           */
+          function quux ({foo, bar}, baz) {
+
+          }
+      `,
     },
     {
       code: `
@@ -146,6 +174,17 @@ export default {
           message: 'Duplicate @property "cfg.foo"',
         },
       ],
+      output: `
+          /**
+           * @typedef (SomeType) SomeTypedef
+           * @property cfg
+           * @property cfg.foo
+           * @property baz
+           */
+          function quux ({foo, bar}, baz) {
+
+          }
+      `,
     },
     {
       code: `

diff --git a/test/rules/assertions/checkTagNames.js b/test/rules/assertions/checkTagNames.js
@@ -72,6 +72,14 @@ export default {
           message: 'Invalid JSDoc tag (preference). Replace "arg" JSDoc tag with "param".',
         },
       ],
+      output: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `,
     },
     {
       code: `
@@ -88,6 +96,14 @@ export default {
           message: 'Invalid JSDoc tag (preference). Replace "param" JSDoc tag with "arg".',
         },
       ],
+      output: `
+          /**
+           * @arg foo
+           */
+          function quux (foo) {
+
+          }
+      `,
       settings: {
         jsdoc: {
           tagNamePreference: {
@@ -111,6 +127,14 @@ export default {
           message: 'Invalid JSDoc tag (preference). Replace "arg" JSDoc tag with "somethingDifferent".',
         },
       ],
+      output: `
+          /**
+           * @somethingDifferent foo
+           */
+          function quux (foo) {
+
+          }
+      `,
       settings: {
         jsdoc: {
           tagNamePreference: {
@@ -134,6 +158,14 @@ export default {
           message: 'Invalid JSDoc tag (preference). Replace "param" JSDoc tag with "parameter".',
         },
       ],
+      output: `
+          /**
+           * @parameter foo
+           */
+          function quux (foo) {
+
+          }
+      `,
       settings: {
         jsdoc: {
           tagNamePreference: {
@@ -257,6 +289,14 @@ export default {
           message: 'Please use x-todo instead of todo',
         },
       ],
+      output: `
+          /**
+           * @x-todo
+           */
+          function quux () {
+
+          }
+      `,
       settings: {
         jsdoc: {
           tagNamePreference: {
@@ -282,6 +322,14 @@ export default {
           message: 'Please use x-todo instead of todo',
         },
       ],
+      output: `
+          /**
+           * @x-todo
+           */
+          function quux () {
+
+          }
+      `,
       settings: {
         jsdoc: {
           tagNamePreference: {
@@ -311,6 +359,14 @@ export default {
           message: 'Invalid JSDoc tag (preference). Replace "todo" JSDoc tag with "55".',
         },
       ],
+      output: `
+          /**
+           * @55
+           */
+          function quux () {
+
+          }
+      `,
       settings: {
         jsdoc: {
           tagNamePreference: {

diff --git a/test/rules/assertions/checkTypes.js b/test/rules/assertions/checkTypes.js
@@ -91,6 +91,15 @@ export default {
           message: 'Invalid JSDoc @throws type "Number"; prefer: "number".',
         },
       ],
+      output: `
+          /**
+           * @returns {number} foo
+           * @throws {Number} foo
+           */
+          function quux () {
+
+          }
+      `,
     },
     {
       code: `
@@ -295,6 +304,15 @@ export default {
           message: 'Invalid JSDoc @param "baz" type "object"; prefer: "Object".',
         },
       ],
+      output: `
+          /**
+           * @param {Abc} foo
+           * @param {cde} bar
+           * @param {object} baz
+           */
+          function qux(foo, bar, baz) {
+          }
+      `,
       settings: {
         jsdoc: {
           preferredTypes: {
@@ -416,6 +434,14 @@ export default {
           message: 'Invalid JSDoc @param "bar" type "Number"; prefer: "number".',
         },
       ],
+      output: `
+          /**
+           * @param {Abc} foo
+           * @param {Number} bar
+           */
+          function qux(foo, bar) {
+          }
+      `,
       settings: {
         jsdoc: {
           preferredTypes: {
@@ -1714,6 +1740,12 @@ export default {
         line: 3,
         message: 'Invalid JSDoc @this type "array"; prefer: "Array".',
       }],
+      output: `
+      /**
+       * @this {Array}
+       */
+      function quux () {}
+      `,
       settings: {
         jsdoc: {
           mode: 'closure',
@@ -1731,6 +1763,12 @@ export default {
         line: 3,
         message: 'Invalid JSDoc @export type "array"; prefer: "Array".',
       }],
+      output: `
+      /**
+       * @export {Array}
+       */
+      function quux () {}
+      `,
       settings: {
         jsdoc: {
           mode: 'closure',
@@ -1758,6 +1796,12 @@ export default {
           }],
         },
       ],
+      output: `
+      /**
+       * @typedef {Object} foo
+       * @property {object} bar
+       */
+      `,
       settings: {
         jsdoc: {
           preferredTypes: {
@@ -1782,6 +1826,7 @@ export default {
           }],
         },
       ],
+      output: '/** @typedef {Object} foo */',
       settings: {
         jsdoc: {
           preferredTypes: {
@@ -1811,6 +1856,12 @@ export default {
           }],
         },
       ],
+      output: `
+      /**
+       * @typedef {Object} foo
+       * @property {object} bar
+       */
+      `,
       settings: {
         jsdoc: {
           preferredTypes: {
@@ -1833,6 +1884,7 @@ export default {
           }],
         },
       ],
+      output: '/** @typedef {Object<string, string>} foo */',
       settings: {
         jsdoc: {
           preferredTypes: {