docs: recommended-typescript

gajus · Mar 19, 2023 · 921cedd · 921cedd
1 parent 07ba155
commit 921cedd
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 0 deletions.
diff --git a/.README/README.md b/.README/README.md
@@ -116,6 +116,37 @@ as failing errors, you may use the "recommended-error" config:
 }
 ```
 
+If you plan to use TypeScript syntax (and not just "typescript"
+`mode` to indicate the JSDoc flavor is TypeScript), you can configure
+the following:
+
+```javascript
+{
+    "rules": {
+      "jsdoc/no-types": 1,
+      "jsdoc/require-param-type": 0,
+      "jsdoc/require-property-type": 0,
+      "jsdoc/require-returns-type": 0,
+    }
+}
+```
+
+...or just use:
+
+```json
+{
+  "extends": ["plugin:jsdoc/recommended-typescript"]
+}
+```
+
+...or to report with failing errors instead of mere warnings:
+
+```json
+{
+  "extends": ["plugin:jsdoc/recommended-typescript-error"]
+}
+```
+
 ## Options
 
 Rules may, as per the [ESLint user guide](https://eslint.org/docs/user-guide/configuring), have their own individual options. In `eslint-plugin-jsdoc`, a few options,

diff --git a/README.md b/README.md
@@ -188,6 +188,37 @@ as failing errors, you may use the "recommended-error" config:
 }
 ```
 
+If you plan to use TypeScript syntax (and not just "typescript"
+`mode` to indicate the JSDoc flavor is TypeScript), you can configure
+the following:
+
+```javascript
+{
+    "rules": {
+      "jsdoc/no-types": 1,
+      "jsdoc/require-param-type": 0,
+      "jsdoc/require-property-type": 0,
+      "jsdoc/require-returns-type": 0,
+    }
+}
+```
+
+...or just use:
+
+```json
+{
+  "extends": ["plugin:jsdoc/recommended-typescript"]
+}
+```
+
+...or to report with failing errors instead of mere warnings:
+
+```json
+{
+  "extends": ["plugin:jsdoc/recommended-typescript-error"]
+}
+```
+
 <a name="user-content-eslint-plugin-jsdoc-options"></a>
 <a name="eslint-plugin-jsdoc-options"></a>
 ## Options