eslint-plugin-jsdoc 39.3.5 → 39.3.12

package/README.md

@@ -2403,17 +2403,28 @@ const fn = ( lorem, sit ) => {}
 // Message: Expected JSDoc block lines to not be aligned.
 
 
-       /**
-        * Function description.
-        *
-        * @param {string} lorem Description.
-        * @param {int} sit Description multi words.
-        * @param {string} sth   Multi
-        *                       line description.
-        */
+       /**\r
+        * Function description.\r
+        *\r
+        * @param {string} lorem Description.\r
+        * @param {int} sit Description multi words.\r
+        * @param {string} sth   Multi\r
+        *                       line description.\r
+        */\r
        const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 // Message: Expected JSDoc block lines to be aligned.
+
+/**
+ * Function description.
+ *
+ * @param {string} lorem Description.
+ * @param {int} sit Description multi
+ *   line with asterisks.
+ */
+const fn = ( lorem, sit ) => {}
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
+// Message: Expected JSDoc block lines to be aligned.
 ````
 
 The following patterns are not considered problems:
@@ -2671,14 +2682,14 @@ const fn = ({ids}) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 
 
-       /**
-        * Function description.
-        *
-        * @param {string} lorem Description.
-        * @param {int}    sit   Description multi words.
-        * @param {string} sth   Multi
-        *                       line description.
-        */
+       /**\r
+        * Function description.\r
+        *\r
+        * @param {string} lorem Description.\r
+        * @param {int}    sit   Description multi words.\r
+        * @param {string} sth   Multi\r
+        *                       line description.\r
+        */\r
        const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 
@@ -2697,6 +2708,79 @@ const fn = ( lorem, sit ) => {};
  */
 const fn2 = () => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
+
+/**
+ * Function description.
+ *
+ * @param lorem Description.
+ * @param sit   Description multi words.
+ * @return      Return description.
+ */
+const fn = ( lorem, sit ) => {};
+
+/**
+ * Function description.
+ *
+ * @param lorem Description.
+ * @param sit   Description multi words.
+ * @returns     Return description.
+ */
+const fn2 = ( lorem, sit ) => {};
+
+/**
+ * Function description.
+ *
+ * @param a Description.
+ * @param b Description multi words.
+ * @returns Return description.
+ */
+const fn3 = ( a, b ) => {};
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
+
+/**
+ * Function description.
+ *
+ * @argument lorem Description.
+ * @return         Return description.
+ */
+const fn = ( lorem ) => {};
+
+/**
+ * Function description.
+ *
+ * @argument lorem Description.
+ * @returns        Return description.
+ */
+const fn2 = ( lorem ) => {};
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
+
+/**
+ * Function description.
+ *
+ * @arg a   Description.
+ * @returns Return description.
+ */
+const fn = ( a ) => {};
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
+
+/**
+ * Function description.
+ *
+ * @arg   lorem Description.
+ * @param sit   Return description.
+ */
+const fn = ( lorem, sit ) => {};
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
+
+/**
+ * Function description.
+ *
+ * @arg      a Description.
+ * @argument b Second description.
+ * @returns    Return description.
+ */
+const fn = ( a, b ) => {};
+// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 ````
 
 
@@ -3280,6 +3364,12 @@ function quux (foo) {
 }
 // "jsdoc/check-param-names": ["error"|"warn", {"enableFixer":true}]
 // Message: Duplicate @param "foo"
+
+/**
+ * @param barr This is the description of bar. Oops, we misspelled "bar" as "barr".
+ */
+declare function foo(bar: number) {}
+// Message: Expected @param names to be "bar". Got "barr".
 ````
 
 The following patterns are not considered problems:
@@ -3654,6 +3744,18 @@ class A {
  * @param root."1" Our "b"
  */
 const foo = ([, b]) => b;
+
+/**
+ * @param arg1 This is the description for arg1.
+ */
+function foo(this: void, arg1: number): void;
+
+declare global {
+  /**
+   * @param arg1 This is the number for foo.
+   */
+  function foo(this: void, arg1: number): void;
+}
 ````
 
 
@@ -6277,7 +6379,7 @@ function quux (foo) {
 
 /**
  * @module test
- * @license MIT
+ * @license MIT\r
  */
 'use strict';
 
@@ -8354,14 +8456,14 @@ function quux () {
 // Message: There must be no newline after the description of the JSDoc block.
 
 
-         /**
-          * Bar.
-          *
-          * Bar.
-          *
-          * @bar
-          */
-         function quux () {
+         /**\r
+          * Bar.\r
+          *\r
+          * Bar.\r
+          *\r
+          * @bar\r
+          */\r
+         function quux () {\r
 
          }
 // "jsdoc/newline-after-description": ["error"|"warn", "never"]
@@ -8385,12 +8487,12 @@ function quux () {
 // Message: There must be a newline after the description of the JSDoc block.
 
 
-     /**
-      * Service for fetching symbols.
-      * @param {object} $http - Injected http helper.
-      * @param {object} $q - Injected Promise api helper.
-      * @param {object} $location - Injected window location object.
-      * @param {object} REPORT_DIALOG_CONSTANTS - Injected handle.
+     /**\r
+      * Service for fetching symbols.\r
+      * @param {object} $http - Injected http helper.\r
+      * @param {object} $q - Injected Promise api helper.\r
+      * @param {object} $location - Injected window location object.\r
+      * @param {object} REPORT_DIALOG_CONSTANTS - Injected handle.\r
       */
 // Message: There must be a newline after the description of the JSDoc block.
 
@@ -8453,20 +8555,20 @@ function quux () {
 // "jsdoc/newline-after-description": ["error"|"warn", "never"]
 
 
-     /**
-      * @foo
-      * Test 
-      * abc 
-      * @bar 
+     /**\r
+      * @foo\r
+      * Test \r
+      * abc \r
+      * @bar \r
       */
 
 
-     /**
-      * 
-      * @foo
-      * Test 
-      * abc 
-      * @bar 
+     /**\r
+      * \r
+      * @foo\r
+      * Test \r
+      * abc \r
+      * @bar \r
       */
 
 /***
@@ -8477,16 +8579,16 @@ function quux () {
 }
 // "jsdoc/newline-after-description": ["error"|"warn", "always"]
 
-/**
- * Parses query string to object containing URL parameters
- * 
- * @param queryString
- * Input string
- * 
- * @returns
- * Object containing URL parameters
- */
-export function parseQueryString(queryString: string): { [key: string]: string } {    // <-- Line 10 that fails
+/**\r
+ * Parses query string to object containing URL parameters\r
+ * \r
+ * @param queryString\r
+ * Input string\r
+ * \r
+ * @returns\r
+ * Object containing URL parameters\r
+ */\r
+export function parseQueryString(queryString: string): { [key: string]: string } {    // <-- Line 10 that fails\r
 
 }
 
@@ -17298,6 +17400,41 @@ function quux (foo) {
   return foo;
 }
 // Message: JSDoc @returns declaration set with "never" but return expression is present in function.
+
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns The file contents as buffer.
+ */
+export function readFixture(path: string): void;
+// Message: JSDoc @returns declaration present but return expression not available in function.
+
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns The file contents as buffer.
+ */
+export function readFixture(path: string);
+// Message: JSDoc @returns declaration present but return expression not available in function.
+
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns The file contents as buffer.
+ */
+export function readFixture(path: string): void {
+  return;
+};
+// Message: JSDoc @returns declaration present but return expression not available in function.
 ````
 
 The following patterns are not considered problems:
@@ -17674,6 +17811,46 @@ function * quux() {}
 function * quux() {}
 // Settings: {"jsdoc":{"mode":"jsdoc"}}
 // "jsdoc/require-returns-check": ["error"|"warn", {"exemptGenerators":true}]
+
+/**
+ * @param {unknown} val
+ * @returns { asserts val is number }
+ */
+function assertNumber(val) {
+  assert(typeof val === 'number');
+}
+
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns The file contents as buffer.
+ */
+export function readFixture(path: string): Promise<Buffer>;
+
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns The file contents as buffer.
+ */
+export function readFixture(path: string): Promise<Buffer> {
+  return new Promise(() => {});
+}
+
+/**
+ * Reads a test fixture.
+ *
+ * @param path The path to resolve relative to the fixture base. It will be normalized for the
+ * operating system.
+ *
+ * @returns {void} The file contents as buffer.
+ */
+export function readFixture(path: string);
 ````
 
 
@@ -18548,6 +18725,26 @@ export const sleep = (ms: number) => {
   return new Promise<string>((res) => setTimeout(res, ms));
 };
 // Message: Missing JSDoc @returns declaration.
+
+/**
+ * Reads a test fixture.
+ */
+export function readFixture(path: string): Promise<Buffer>;
+// Message: Missing JSDoc @returns declaration.
+
+/**
+ * Reads a test fixture.
+ */
+export function readFixture(path: string): void;
+// "jsdoc/require-returns": ["error"|"warn", {"forceRequireReturn":true}]
+// Message: Missing JSDoc @returns declaration.
+
+/**
+ * Reads a test fixture.
+ */
+export function readFixture(path: string);
+// "jsdoc/require-returns": ["error"|"warn", {"forceRequireReturn":true}]
+// Message: Missing JSDoc @returns declaration.
 ````
 
 The following patterns are not considered problems:
@@ -19051,6 +19248,30 @@ export const sleep = (ms: number) =>
 export const sleep = (ms: number) => {
   return new Promise<void>((res) => setTimeout(res, ms));
 };
+
+/**
+ * Reads a test fixture.
+ *
+ * @returns The file contents as buffer.
+ */
+export function readFixture(path: string): Promise<Buffer>;
+
+/**
+ * Reads a test fixture.
+ *
+ * @returns {void}.
+ */
+export function readFixture(path: string): void;
+
+/**
+ * Reads a test fixture.
+ */
+export function readFixture(path: string): void;
+
+/**
+ * Reads a test fixture.
+ */
+export function readFixture(path: string);
 ````
 
 

package/dist/WarnSettings.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 const WarnSettings = function () {
   /** @type {WeakMap<object, Set<string>>} */
   const warnedSettings = new WeakMap();
@@ -18,19 +17,15 @@ const WarnSettings = function () {
     hasBeenWarned(context, setting) {
       return warnedSettings.has(context) && warnedSettings.get(context).has(setting);
     },
-
     markSettingAsWarned(context, setting) {
       // istanbul ignore else
       if (!warnedSettings.has(context)) {
         warnedSettings.set(context, new Set());
       }
-
       warnedSettings.get(context).add(setting);
     }
-
   };
 };
-
 var _default = WarnSettings;
 exports.default = _default;
 module.exports = exports.default;

package/dist/WarnSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"WarnSettings.js","names":["WarnSettings","warnedSettings","WeakMap","hasBeenWarned","context","setting","has","get","markSettingAsWarned","set","Set","add"],"sources":["../src/WarnSettings.js"],"sourcesContent":["const WarnSettings = function () {\n  /** @type {WeakMap<object, Set<string>>} */\n  const warnedSettings = new WeakMap();\n\n  return {\n    /**\n     * Warn only once for each context and setting\n     *\n     * @param {object} context\n     * @param {string} setting\n     */\n    hasBeenWarned (context, setting) {\n      return warnedSettings.has(context) && warnedSettings.get(context).has(setting);\n    },\n\n    markSettingAsWarned (context, setting) {\n      // istanbul ignore else\n      if (!warnedSettings.has(context)) {\n        warnedSettings.set(context, new Set());\n      }\n\n      warnedSettings.get(context).add(setting);\n    },\n  };\n};\n\nexport default WarnSettings;\n"],"mappings":";;;;;;;AAAA,MAAMA,YAAY,GAAG,YAAY;EAC/B;EACA,MAAMC,cAAc,GAAG,IAAIC,OAAJ,EAAvB;EAEA,OAAO;IACL;AACJ;AACA;AACA;AACA;AACA;IACIC,aAAa,CAAEC,OAAF,EAAWC,OAAX,EAAoB;MAC/B,OAAOJ,cAAc,CAACK,GAAf,CAAmBF,OAAnB,KAA+BH,cAAc,CAACM,GAAf,CAAmBH,OAAnB,EAA4BE,GAA5B,CAAgCD,OAAhC,CAAtC;IACD,CATI;;IAWLG,mBAAmB,CAAEJ,OAAF,EAAWC,OAAX,EAAoB;MACrC;MACA,IAAI,CAACJ,cAAc,CAACK,GAAf,CAAmBF,OAAnB,CAAL,EAAkC;QAChCH,cAAc,CAACQ,GAAf,CAAmBL,OAAnB,EAA4B,IAAIM,GAAJ,EAA5B;MACD;;MAEDT,cAAc,CAACM,GAAf,CAAmBH,OAAnB,EAA4BO,GAA5B,CAAgCN,OAAhC;IACD;;EAlBI,CAAP;AAoBD,CAxBD;;eA0BeL,Y"}
+{"version":3,"file":"WarnSettings.js","names":["WarnSettings","warnedSettings","WeakMap","hasBeenWarned","context","setting","has","get","markSettingAsWarned","set","Set","add"],"sources":["../src/WarnSettings.js"],"sourcesContent":["const WarnSettings = function () {\n  /** @type {WeakMap<object, Set<string>>} */\n  const warnedSettings = new WeakMap();\n\n  return {\n    /**\n     * Warn only once for each context and setting\n     *\n     * @param {object} context\n     * @param {string} setting\n     */\n    hasBeenWarned (context, setting) {\n      return warnedSettings.has(context) && warnedSettings.get(context).has(setting);\n    },\n\n    markSettingAsWarned (context, setting) {\n      // istanbul ignore else\n      if (!warnedSettings.has(context)) {\n        warnedSettings.set(context, new Set());\n      }\n\n      warnedSettings.get(context).add(setting);\n    },\n  };\n};\n\nexport default WarnSettings;\n"],"mappings":";;;;;;AAAA,MAAMA,YAAY,GAAG,YAAY;EAC/B;EACA,MAAMC,cAAc,GAAG,IAAIC,OAAO,EAAE;EAEpC,OAAO;IACL;AACJ;AACA;AACA;AACA;AACA;IACIC,aAAa,CAAEC,OAAO,EAAEC,OAAO,EAAE;MAC/B,OAAOJ,cAAc,CAACK,GAAG,CAACF,OAAO,CAAC,IAAIH,cAAc,CAACM,GAAG,CAACH,OAAO,CAAC,CAACE,GAAG,CAACD,OAAO,CAAC;IAChF,CAAC;IAEDG,mBAAmB,CAAEJ,OAAO,EAAEC,OAAO,EAAE;MACrC;MACA,IAAI,CAACJ,cAAc,CAACK,GAAG,CAACF,OAAO,CAAC,EAAE;QAChCH,cAAc,CAACQ,GAAG,CAACL,OAAO,EAAE,IAAIM,GAAG,EAAE,CAAC;MACxC;MAEAT,cAAc,CAACM,GAAG,CAACH,OAAO,CAAC,CAACO,GAAG,CAACN,OAAO,CAAC;IAC1C;EACF,CAAC;AACH,CAAC;AAAC,eAEaL,YAAY;AAAA;AAAA"}