eslint-plugin-jsdoc 44.0.1 → 44.1.0

package/docs/rules/no-undefined-types.md

@@ -55,11 +55,18 @@ array's items will be considered as defined for the purposes of that tag.
 <a name="no-undefined-types-options"></a>
 ## Options
 
-An option object may have the following key:
+An option object may have the following keys:
 
 - `definedTypes` - This array can be populated to indicate other types which
   are automatically considered as defined (in addition to globals, etc.).
   Defaults to an empty array.
+- `markVariablesAsUsed` - Whether to mark variables as used for the purposes
+  of the `no-unused-vars` rule when they are not found to be undefined.
+  Defaults to `true`. May be set to `false` to enforce a practice of not
+  importing types unless used in code.
+- `disableReporting` - Whether to disable reporting of errors. Defaults to
+  `false`. This may be set to `true` in order to take advantage of only
+  marking defined variables as used.
 
 <a name="user-content-no-undefined-types-context-and-settings"></a>
 <a name="no-undefined-types-context-and-settings"></a>
@@ -72,7 +79,7 @@ An option object may have the following key:
 |Aliases|`constructor`, `const`, `extends`, `var`, `arg`, `argument`, `prop`, `return`, `exception`, `yield`|
 |Closure-only|`package`, `private`, `protected`, `public`, `static`|
 |Recommended|true|
-|Options|`definedTypes`|
+|Options|`definedTypes`, `markVariablesAsUsed`, `disableReporting`|
 |Settings|`preferredTypes`, `mode`, `structuredTags`|
 
 
@@ -354,7 +361,7 @@ import {MyType} from 'my-library';
  * @param {object<string, number>} foo
  * @param {Array<string>} baz
  */
-  function quux(foo, bar, baz) {
+function quux(foo, bar, baz) {
 
 }
 
@@ -727,5 +734,16 @@ class Foo {
   }
 }
 // Settings: {"jsdoc":{"mode":"typescript"}}
+
+import {MyType} from 'my-library';
+
+/**
+ * @param {MyType} foo - Bar.
+ * @param {AnUndefinedType} bar
+ */
+function quux(foo, bar) {
+
+}
+// "jsdoc/no-undefined-types": ["error"|"warn", {"disableReporting":true}]
 ````
 

package/docs/rules/valid-types.md

@@ -846,5 +846,9 @@ function quux() {
 
 }
 // Settings: {"jsdoc":{"mode":"typescript"}}
+
+/**
+ * @returns {Promise<{publicKey, privateKey}>} - The public and private key
+ */
 ````
 

package/package.json

@@ -24,20 +24,22 @@
     "@babel/plugin-transform-flow-strip-types": "^7.21.0",
     "@babel/preset-env": "^7.21.5",
     "@babel/register": "^7.21.0",
-    "@es-joy/jsdoc-eslint-parser": "^0.18.0",
+    "@es-joy/jsdoc-eslint-parser": "^0.19.0",
     "@hkdobrev/run-if-changed": "^0.3.1",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/github": "^8.0.7",
     "@semantic-release/npm": "^10.0.3",
-    "@typescript-eslint/parser": "^5.59.2",
+    "@types/eslint": "^8.37.0",
+    "@types/node": "^20.1.1",
+    "@typescript-eslint/parser": "^5.59.5",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-istanbul": "^6.1.1",
     "camelcase": "^6.3.0",
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",
     "decamelize": "^5.0.1",
-    "eslint-config-canonical": "~33.0.1",
     "eslint": "^8.39.0",
+    "eslint-config-canonical": "~33.0.1",
     "gitdown": "^3.1.5",
     "glob": "^10.2.2",
     "husky": "^8.0.3",
@@ -107,9 +109,10 @@
     "package-lock.json": "npm run install-offline"
   },
   "scripts": {
+    "tsc": "tsc",
     "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored",
-    "check-readme": "babel-node ./src/bin/generateDocs.js --check",
-    "create-readme": "babel-node ./src/bin/generateDocs.js",
+    "check-docs": "babel-node ./src/bin/generateDocs.js --check",
+    "create-docs": "babel-node ./src/bin/generateDocs.js",
     "create-rule": "babel-node ./src/bin/generateRule.js",
     "install-offline": "pnpm install --prefer-offline --no-audit",
     "lint": "npm run lint-arg -- .",
@@ -121,5 +124,5 @@
     "test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
     "test-index": "npm run test-no-cov -- test/rules/index.js"
   },
-  "version": "44.0.1"
+  "version": "44.1.0"
 }

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "lib": ["es2022"],
+    "moduleResolution": "node",
+    "module": "esnext",
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "declaration": true,
+    "declarationMap": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "target": "es6",
+    "outDir": "dist"
+  },
+  // Restore to `src/**/*.js` as ready
+  "include": ["src/bin/*.js", "src/bin/gitdown.d.ts"],
+  "exclude": ["node_modules"]
+}