File tree Expand file tree Collapse file tree 2 files changed +14
-4
lines changed Expand file tree Collapse file tree 2 files changed +14
-4
lines changed Original file line number Diff line number Diff line change @@ -27,8 +27,7 @@ how many line breaks to add when a block is missing.
27
27
### Mode
28
28
29
29
- ` 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 ` ).
32
31
Note that if you do not wish to use separate ` .eslintrc.* ` files for a
33
32
project containing both JavaScript and TypeScript, you can also use
34
33
[ ` 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.
51
50
- Disallows namepath on ` @interface ` for "closure" mode in ` valid-types ` (and
52
51
avoids checking in other rules)
53
52
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
+
54
59
### Alias Preference
55
60
56
61
Use ` settings.jsdoc.tagNamePreference ` to configure a preferred alias name for
Original file line number Diff line number Diff line change @@ -44,8 +44,7 @@ how many line breaks to add when a block is missing.
44
44
### Mode
45
45
46
46
- ` 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 ` ).
49
48
Note that if you do not wish to use separate ` .eslintrc.* ` files for a
50
49
project containing both JavaScript and TypeScript, you can also use
51
50
[ ` 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.
68
67
- Disallows namepath on ` @interface ` for "closure" mode in ` valid-types ` (and
69
68
avoids checking in other rules)
70
69
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
+
71
76
<a name =" user-content-settings-alias-preference " ></a >
72
77
<a name =" settings-alias-preference " ></a >
73
78
### Alias Preference
You can’t perform that action at this time.
0 commit comments