chore: linting

Author: brettz9

eslint.config.js

@@ -4,9 +4,9 @@ import {
 import {
   recommended as canonical,
 } from 'eslint-config-canonical/canonical';
-import {
-  recommended as canonicalJsdoc,
-} from 'eslint-config-canonical/jsdoc';
+// import {
+//   recommended as canonicalJsdoc,
+// } from 'eslint-config-canonical/jsdoc';
 import globals from 'globals';
 
 const common = {
@@ -18,7 +18,10 @@ const common = {
 
 export default [
   ...canonical,
-  ...canonicalJsdoc,
+  // ...canonicalJsdoc,
+  jsdoc({
+    config: 'flat/recommended',
+  }),
   ...jsdoc({
     config: 'examples-and-default-expressions',
   }),
@@ -43,6 +46,9 @@ export default [
       'filenames/match-regex': 0,
       'import/extensions': 0,
       'import/no-useless-path-segments': 0,
+      'jsdoc/require-param-description': 0,
+      'jsdoc/require-returns': 0,
+      'jsdoc/require-returns-description': 0,
       'linebreak-style': 0,
       'no-inline-comments': 0,
       'prefer-named-capture-group': 0,

src/getJsdocProcessorPlugin.js

@@ -83,7 +83,6 @@ const getLinesCols = (text) => {
 /**
  * @typedef {number} Integer
  */
-
 /**
  * @typedef {object} JsdocProcessorOptions
  * @property {boolean} [captionRequired] Require captions for example tags
@@ -110,6 +109,13 @@ const getLinesCols = (text) => {
  * @returns {ESLint.Plugin}
  */
 export const getJsdocProcessorPlugin = (options = {}) => {
+  /**
+   * @typedef {{
+   *   text: string,
+   *   filename: string|null|undefined
+   * }} TextAndFileName
+   */
+
   const {
     allowedLanguagesToProcess = [
       'js', 'ts', 'javascript', 'typescript',
@@ -169,10 +175,7 @@ export const getJsdocProcessorPlugin = (options = {}) => {
    */
   const getTextsAndFileNames = (jsdoc, jsFileName, commentLineCols) => {
     /**
-     * @type {{
-     *   text: string,
-     *   filename: string|null|undefined
-     * }[]}
+     * @type {TextAndFileName[]}
      */
     const textsAndFileNames = [];
 
@@ -666,6 +669,7 @@ export const getJsdocProcessorPlugin = (options = {}) => {
                 );
               }).filter(
                 /**
+                 * @param {TextAndFileName} file
                  * @returns {file is Linter.ProcessorFile}
                  */
                 (file) => {

test/iterateJsdoc.js

@@ -7,9 +7,11 @@ import {
   expect,
 } from 'chai';
 
+/* eslint-disable jsdoc/reject-any-type -- Deliberate error */
 /**
  * @typedef {any} BadArgument
  */
+/* eslint-enable jsdoc/reject-any-type -- Deliberate error */
 
 describe('iterateJsdoc', () => {
   describe('constructor', () => {

test/jsdocUtils.js

@@ -3,9 +3,11 @@ import {
   expect,
 } from 'chai';
 
+/* eslint-disable jsdoc/reject-any-type -- Deliberate error */
 /**
  * @typedef {any} BadArgument
  */
+/* eslint-enable jsdoc/reject-any-type -- Deliberate error */
 
 describe('jsdocUtils', () => {
   describe('getPreferredTagName()', () => {