Skip to content

Commit 4eaf868

Browse files
committed
docs: update info on default mode
1 parent 055adf8 commit 4eaf868

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

.README/settings.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ how many line breaks to add when a block is missing.
2727
### Mode
2828

2929
- `settings.jsdoc.mode` - Set to `typescript`, `closure`, or `jsdoc` (the
30-
default unless the `@typescript-eslint` parser is in use in which case
31-
`typescript` will be the default).
30+
default is now `typescript`).
3231
Note that if you do not wish to use separate `.eslintrc.*` files for a
3332
project containing both JavaScript and TypeScript, you can also use
3433
[`overrides`](https://eslint.org/docs/user-guide/configuring). You may also
@@ -51,6 +50,12 @@ how many line breaks to add when a block is missing.
5150
- Disallows namepath on `@interface` for "closure" mode in `valid-types` (and
5251
avoids checking in other rules)
5352

53+
Note that if you are using TypeScript syntax (and not just the TypeScript
54+
flavor of JSDoc which `mode` set to "typescript" implies), you may wish
55+
to use the `recommended-typescript` or `recommended-typescript-error`
56+
config. This will add rules such as `jsdoc/no-types` to expect you have
57+
no types expressed in JSDoc (since these can be added in TypeScript).
58+
5459
### Alias Preference
5560

5661
Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for

docs/settings.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ how many line breaks to add when a block is missing.
4444
### Mode
4545

4646
- `settings.jsdoc.mode` - Set to `typescript`, `closure`, or `jsdoc` (the
47-
default unless the `@typescript-eslint` parser is in use in which case
48-
`typescript` will be the default).
47+
default is now `typescript`).
4948
Note that if you do not wish to use separate `.eslintrc.*` files for a
5049
project containing both JavaScript and TypeScript, you can also use
5150
[`overrides`](https://eslint.org/docs/user-guide/configuring). You may also
@@ -68,6 +67,12 @@ how many line breaks to add when a block is missing.
6867
- Disallows namepath on `@interface` for "closure" mode in `valid-types` (and
6968
avoids checking in other rules)
7069

70+
Note that if you are using TypeScript syntax (and not just the TypeScript
71+
flavor of JSDoc which `mode` set to "typescript" implies), you may wish
72+
to use the `recommended-typescript` or `recommended-typescript-error`
73+
config. This will add rules such as `jsdoc/no-types` to expect you have
74+
no types expressed in JSDoc (since these can be added in TypeScript).
75+
7176
<a name="user-content-settings-alias-preference"></a>
7277
<a name="settings-alias-preference"></a>
7378
### Alias Preference

0 commit comments

Comments
 (0)