eslint-plugin-jsdoc - npm Package Compare versions

Comparing version 52.0.1 to 52.0.2

dist/getJsdocProcessorPlugin.d.ts

@@ -1,29 +0,2 @@
-export function getJsdocProcessorPlugin(options?: JsdocProcessorOptions): {
-    meta: {
-        name: string;
-        version: any;
-    };
-    processors: {
-        examples: {
-            meta: {
-                name: string;
-                version: any;
-            };
-            /**
-             * @param {import('eslint').Linter.LintMessage[][]} messages
-             * @param {string} filename
-             */
-            postprocess([jsMessages, ...messages]: import("eslint").Linter.LintMessage[][], filename: string): import("eslint").Linter.LintMessage[];
-            /**
-             * @param {string} text
-             * @param {string} filename
-             */
-            preprocess(text: string, filename: string): (string | {
-                text: string;
-                filename: string | null | undefined;
-            })[];
-            supportsAutofix: boolean;
-        };
-    };
-};
+export function getJsdocProcessorPlugin(options?: JsdocProcessorOptions): ESLint.Plugin;
 export type Integer = number;
@@ -90,4 +63,6 @@ export type JsdocProcessorOptions = {
      */
-    parser?: import("eslint").Linter.ESTreeParser | import("eslint").Linter.NonESTreeParser | undefined;
+    parser?: Linter.ESTreeParser | Linter.NonESTreeParser | undefined;
 };
+import type { ESLint } from 'eslint';
+import type { Linter } from 'eslint';
 //# sourceMappingURL=getJsdocProcessorPlugin.d.ts.map

package.json

@@ -53,3 +53,2 @@ {
     "chai": "^5.2.0",
-    "cross-env": "^7.0.3",
     "decamelize": "^6.0.0",
@@ -84,7 +83,3 @@ "eslint": "9.29.0",
   "lint-staged": {
-    ".eslintignore": [
-      "npm run lint-fix",
-      "git add ."
-    ],
-    "*.js": "npm run lint-arg -- --fix"
+    "*.js": "eslint --fix"
   },
@@ -145,3 +140,3 @@ "type": "module",
   "run-if-changed": {
-    "package-lock.json": "npm run install-offline"
+    "package-lock.json": "pnpm run install-offline"
   },
@@ -151,18 +146,17 @@ "scripts": {
     "tsc-build": "tsc -p tsconfig-prod.json",
-    "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
+    "build": "rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
     "check-docs": "babel-node ./src/bin/generateDocs.js --check",
-    "create-docs": "npm run create-options && babel-node ./src/bin/generateDocs.js",
+    "create-docs": "pnpm run create-options && babel-node ./src/bin/generateDocs.js",
     "create-rule": "babel-node ./src/bin/generateRule.js",
     "create-options": "node ./src/bin/generateOptions.mjs",
     "install-offline": "pnpm install --prefer-offline --no-audit",
-    "lint": "npm run lint-arg -- .",
-    "lint-arg": "eslint",
-    "lint-fix": "npm run lint-arg -- --fix .",
+    "lint": "eslint",
+    "lint-fix": "eslint --fix",
     "prepare": "husky",
-    "test-no-cov": "cross-env BABEL_ENV=test mocha",
-    "test": "c8 npm run test-no-cov",
-    "test-cov": "cross-env TIMING=1 c8 --reporter text npm run test-no-cov",
-    "test-index": "npm run test-no-cov -- test/rules/index.js"
+    "test-no-cov": "BABEL_ENV=test mocha",
+    "test": "c8 pnpm run test-no-cov",
+    "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
+    "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "52.0.1"
+  "version": "52.0.2"
 }

src/getJsdocProcessorPlugin.js

@@ -19,2 +19,13 @@ import {
 
+/**
+ * @import {
+ *   Integer,
+ *   JsdocBlockWithInline,
+ * } from './iterateJsdoc.js';
+ * @import {
+ *   ESLint,
+ *   Linter,
+ * } from 'eslint';
+ */
+
 const {
@@ -47,3 +58,3 @@ version,
  * @param {string} ch
- * @returns {import('./iterateJsdoc.js').Integer}
+ * @returns {Integer}
  */
@@ -57,4 +68,4 @@ const countChars = (str, ch) => {
  * @returns {[
- *   import('./iterateJsdoc.js').Integer,
- *   import('./iterateJsdoc.js').Integer
+ *   Integer,
+ *   Integer
  * ]}
@@ -101,2 +112,3 @@ */
  * @param {JsdocProcessorOptions} [options]
+ * @returns {ESLint.Plugin}
  */
@@ -157,3 +169,3 @@ export const getJsdocProcessorPlugin = (options = {}) => {
   /**
-   * @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
+   * @param {JsdocBlockWithInline} jsdoc
    * @param {string} jsFileName
@@ -178,15 +190,15 @@ * @param {[number, number]} commentLineCols
      *   rules?: import('eslint').Linter.RulesRecord|undefined,
-     *   lines?: import('./iterateJsdoc.js').Integer,
-     *   cols?: import('./iterateJsdoc.js').Integer,
+     *   lines?: Integer,
+     *   cols?: Integer,
      *   skipInit?: boolean,
      *   ext: string,
      *   sources?: {
-     *     nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
-     *     nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
+     *     nonJSPrefacingCols: Integer,
+     *     nonJSPrefacingLines: Integer,
      *     string: string,
      *   }[],
      *   tag?: import('comment-parser').Spec & {
-     *     line?: import('./iterateJsdoc.js').Integer,
+     *     line?: Integer,
      *   }|{
-     *     line: import('./iterateJsdoc.js').Integer,
+     *     line: Integer,
      *   }
@@ -219,4 +231,4 @@ * }} cfg
        * @param {{
-       *   nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
-       *   nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
+       *   nonJSPrefacingCols: Integer,
+       *   nonJSPrefacingLines: Integer,
        *   string: string
@@ -244,3 +256,3 @@ * }} cfg
                                * @type {import('comment-parser').Spec & {
-                               *     line: import('./iterateJsdoc.js').Integer,
+                               *     line: Integer,
                                * }}
@@ -578,2 +590,3 @@ */ (tag).line + nonJSPrefacingLines;
          * @param {string} filename
+         * @returns {(string | Linter.ProcessorFile)[]}
          */
@@ -646,3 +659,10 @@ preprocess (text, filename) {
                 );
-              }).filter(Boolean),
+              }).filter(
+                /**
+                 * @returns {file is Linter.ProcessorFile}
+                 */
+                (file) => {
+                  return file !== null && file !== undefined;
+                },
+              ),
             ];
@@ -649,0 +669,0 @@ /* c8 ignore next 6 */

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

50

-1.96%

Lines of code

35280

0.03%

Worsened metrics

Total package byte prevSize

2152996

-0.03%

No dependency changes