eslint-plugin-jsdoc 46.4.5 → 46.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +31 -0
  2. package/dist/alignTransform.js +5 -5
  3. package/dist/alignTransform.js.map +1 -1
  4. package/dist/index.js +21 -10
  5. package/dist/index.js.map +1 -1
  6. package/dist/iterateJsdoc.js +1 -1
  7. package/dist/iterateJsdoc.js.map +1 -1
  8. package/dist/rules/checkExamples.js +12 -6
  9. package/dist/rules/checkExamples.js.map +1 -1
  10. package/package.json +19 -15
  11. package/docs/advanced.md +0 -102
  12. package/docs/rules/check-access.md +0 -193
  13. package/docs/rules/check-alignment.md +0 -169
  14. package/docs/rules/check-examples.md +0 -784
  15. package/docs/rules/check-indentation.md +0 -296
  16. package/docs/rules/check-line-alignment.md +0 -1002
  17. package/docs/rules/check-param-names.md +0 -1035
  18. package/docs/rules/check-property-names.md +0 -244
  19. package/docs/rules/check-syntax.md +0 -80
  20. package/docs/rules/check-tag-names.md +0 -1132
  21. package/docs/rules/check-types.md +0 -1198
  22. package/docs/rules/check-values.md +0 -409
  23. package/docs/rules/empty-tags.md +0 -220
  24. package/docs/rules/implements-on-classes.md +0 -219
  25. package/docs/rules/imports-as-dependencies.md +0 -99
  26. package/docs/rules/informative-docs.md +0 -400
  27. package/docs/rules/match-description.md +0 -1008
  28. package/docs/rules/match-name.md +0 -249
  29. package/docs/rules/multiline-blocks.md +0 -398
  30. package/docs/rules/no-bad-blocks.md +0 -174
  31. package/docs/rules/no-blank-block-descriptions.md +0 -91
  32. package/docs/rules/no-blank-blocks.md +0 -98
  33. package/docs/rules/no-defaults.md +0 -207
  34. package/docs/rules/no-missing-syntax.md +0 -275
  35. package/docs/rules/no-multi-asterisks.md +0 -278
  36. package/docs/rules/no-restricted-syntax.md +0 -383
  37. package/docs/rules/no-types.md +0 -168
  38. package/docs/rules/no-undefined-types.md +0 -789
  39. package/docs/rules/require-asterisk-prefix.md +0 -297
  40. package/docs/rules/require-description-complete-sentence.md +0 -820
  41. package/docs/rules/require-description.md +0 -585
  42. package/docs/rules/require-example.md +0 -390
  43. package/docs/rules/require-file-overview.md +0 -324
  44. package/docs/rules/require-hyphen-before-param-description.md +0 -281
  45. package/docs/rules/require-jsdoc.md +0 -1857
  46. package/docs/rules/require-param-description.md +0 -238
  47. package/docs/rules/require-param-name.md +0 -163
  48. package/docs/rules/require-param-type.md +0 -227
  49. package/docs/rules/require-param.md +0 -1820
  50. package/docs/rules/require-property-description.md +0 -88
  51. package/docs/rules/require-property-name.md +0 -79
  52. package/docs/rules/require-property-type.md +0 -79
  53. package/docs/rules/require-property.md +0 -128
  54. package/docs/rules/require-returns-check.md +0 -1053
  55. package/docs/rules/require-returns-description.md +0 -181
  56. package/docs/rules/require-returns-type.md +0 -144
  57. package/docs/rules/require-returns.md +0 -1191
  58. package/docs/rules/require-throws.md +0 -326
  59. package/docs/rules/require-yields-check.md +0 -544
  60. package/docs/rules/require-yields.md +0 -823
  61. package/docs/rules/sort-tags.md +0 -635
  62. package/docs/rules/tag-lines.md +0 -551
  63. package/docs/rules/text-escaping.md +0 -177
  64. package/docs/rules/valid-types.md +0 -881
  65. package/docs/settings.md +0 -362
  66. package/tsconfig.json +0 -22
package/docs/rules/require-property-description.md DELETED
@@ -1,88 +0,0 @@
1
- <a name="user-content-require-property-description"></a>
2
- <a name="require-property-description"></a>
3
- # <code>require-property-description</code>
4
-
5
- * [Context and settings](#user-content-require-property-description-context-and-settings)
6
- * [Failing examples](#user-content-require-property-description-failing-examples)
7
- * [Passing examples](#user-content-require-property-description-passing-examples)
8
-
9
-
10
- Requires that each `@property` tag has a `description` value.
11
-
12
- <a name="user-content-require-property-description-context-and-settings"></a>
13
- <a name="require-property-description-context-and-settings"></a>
14
- ## Context and settings
15
-
16
- |||
17
- |---|---|
18
- |Context|everywhere|
19
- |Tags|`property`|
20
- |Aliases|`prop`|
21
- |Recommended|true|
22
-
23
- <a name="user-content-require-property-description-failing-examples"></a>
24
- <a name="require-property-description-failing-examples"></a>
25
- ## Failing examples
26
-
27
- The following patterns are considered problems:
28
-
29
- ````js
30
- /**
31
- * @typedef {SomeType} SomeTypedef
32
- * @property foo
33
- */
34
- // Message: Missing JSDoc @property "foo" description.
35
-
36
- /**
37
- * @typedef {SomeType} SomeTypedef
38
- * @prop foo
39
- */
40
- // Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
41
- // Message: Missing JSDoc @prop "foo" description.
42
-
43
- /**
44
- * @typedef {SomeType} SomeTypedef
45
- * @property foo
46
- */
47
- // Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
48
- // Message: Unexpected tag `@property`
49
- ````
50
-
51
-
52
-
53
- <a name="user-content-require-property-description-passing-examples"></a>
54
- <a name="require-property-description-passing-examples"></a>
55
- ## Passing examples
56
-
57
- The following patterns are not considered problems:
58
-
59
- ````js
60
- /**
61
- * @typedef {SomeType} SomeTypedef
62
- */
63
-
64
- /**
65
- * @typedef {SomeType} SomeTypedef
66
- * @property foo Foo.
67
- */
68
-
69
- /**
70
- * @namespace {SomeType} SomeName
71
- * @property foo Foo.
72
- */
73
-
74
- /**
75
- * @class
76
- * @property foo Foo.
77
- */
78
-
79
- /**
80
- * Typedef with multi-line property type.
81
- *
82
- * @typedef {object} MyType
83
- * @property {function(
84
- * number
85
- * )} numberEater Method which takes a number.
86
- */
87
- ````
88
-
package/docs/rules/require-property-name.md DELETED
@@ -1,79 +0,0 @@
1
- <a name="user-content-require-property-name"></a>
2
- <a name="require-property-name"></a>
3
- # <code>require-property-name</code>
4
-
5
- * [Context and settings](#user-content-require-property-name-context-and-settings)
6
- * [Failing examples](#user-content-require-property-name-failing-examples)
7
- * [Passing examples](#user-content-require-property-name-passing-examples)
8
-
9
-
10
- Requires that all `@property` tags have names.
11
-
12
- <a name="user-content-require-property-name-context-and-settings"></a>
13
- <a name="require-property-name-context-and-settings"></a>
14
- ## Context and settings
15
-
16
- |||
17
- |---|---|
18
- |Context|everywhere|
19
- |Tags|`property`|
20
- |Aliases|`prop`|
21
- |Recommended|true|
22
-
23
- <a name="user-content-require-property-name-failing-examples"></a>
24
- <a name="require-property-name-failing-examples"></a>
25
- ## Failing examples
26
-
27
- The following patterns are considered problems:
28
-
29
- ````js
30
- /**
31
- * @typedef {SomeType} SomeTypedef
32
- * @property
33
- */
34
- // Message: There must be an identifier after @property type.
35
-
36
- /**
37
- * @typedef {SomeType} SomeTypedef
38
- * @property {string}
39
- */
40
- // Message: There must be an identifier after @property tag.
41
-
42
- /**
43
- * @typedef {SomeType} SomeTypedef
44
- * @property foo
45
- */
46
- // Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
47
- // Message: Unexpected tag `@property`
48
- ````
49
-
50
-
51
-
52
- <a name="user-content-require-property-name-passing-examples"></a>
53
- <a name="require-property-name-passing-examples"></a>
54
- ## Passing examples
55
-
56
- The following patterns are not considered problems:
57
-
58
- ````js
59
- /**
60
- * @typedef {SomeType} SomeTypedef
61
- * @property foo
62
- */
63
-
64
- /**
65
- * @typedef {SomeType} SomeTypedef
66
- * @property {string} foo
67
- */
68
-
69
- /**
70
- * @namespace {SomeType} SomeName
71
- * @property {string} foo
72
- */
73
-
74
- /**
75
- * @class
76
- * @property {string} foo
77
- */
78
- ````
79
-
package/docs/rules/require-property-type.md DELETED
@@ -1,79 +0,0 @@
1
- <a name="user-content-require-property-type"></a>
2
- <a name="require-property-type"></a>
3
- # <code>require-property-type</code>
4
-
5
- * [Context and settings](#user-content-require-property-type-context-and-settings)
6
- * [Failing examples](#user-content-require-property-type-failing-examples)
7
- * [Passing examples](#user-content-require-property-type-passing-examples)
8
-
9
-
10
- Requires that each `@property` tag has a type value (within curly brackets).
11
-
12
- <a name="user-content-require-property-type-context-and-settings"></a>
13
- <a name="require-property-type-context-and-settings"></a>
14
- ## Context and settings
15
-
16
- |||
17
- |---|---|
18
- |Context|everywhere|
19
- |Tags|`property`|
20
- |Aliases|`prop`|
21
- |Recommended|true|
22
-
23
- <a name="user-content-require-property-type-failing-examples"></a>
24
- <a name="require-property-type-failing-examples"></a>
25
- ## Failing examples
26
-
27
- The following patterns are considered problems:
28
-
29
- ````js
30
- /**
31
- * @typedef {SomeType} SomeTypedef
32
- * @property foo
33
- */
34
- // Message: Missing JSDoc @property "foo" type.
35
-
36
- /**
37
- * @typedef {SomeType} SomeTypedef
38
- * @prop foo
39
- */
40
- // Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
41
- // Message: Missing JSDoc @prop "foo" type.
42
-
43
- /**
44
- * @typedef {SomeType} SomeTypedef
45
- * @property foo
46
- */
47
- // Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
48
- // Message: Unexpected tag `@property`
49
- ````
50
-
51
-
52
-
53
- <a name="user-content-require-property-type-passing-examples"></a>
54
- <a name="require-property-type-passing-examples"></a>
55
- ## Passing examples
56
-
57
- The following patterns are not considered problems:
58
-
59
- ````js
60
- /**
61
- * @typedef {SomeType} SomeTypedef
62
- */
63
-
64
- /**
65
- * @typedef {SomeType} SomeTypedef
66
- * @property {number} foo
67
- */
68
-
69
- /**
70
- * @namespace {SomeType} SomeName
71
- * @property {number} foo
72
- */
73
-
74
- /**
75
- * @class
76
- * @property {number} foo
77
- */
78
- ````
79
-
package/docs/rules/require-property.md DELETED
@@ -1,128 +0,0 @@
1
- <a name="user-content-require-property"></a>
2
- <a name="require-property"></a>
3
- # <code>require-property</code>
4
-
5
- * [Fixer](#user-content-require-property-fixer)
6
- * [Context and settings](#user-content-require-property-context-and-settings)
7
- * [Failing examples](#user-content-require-property-failing-examples)
8
- * [Passing examples](#user-content-require-property-passing-examples)
9
-
10
-
11
- Requires that all `@typedef` and `@namespace` tags have `@property`
12
- tags when their type is a plain `object`, `Object`, or `PlainObject`.
13
-
14
- Note that any other type, including a subtype of object such as
15
- `object<string, string>`, will not be reported.
16
-
17
- <a name="user-content-require-property-fixer"></a>
18
- <a name="require-property-fixer"></a>
19
- ## Fixer
20
-
21
- The fixer for `require-property` will add an empty `@property`.
22
-
23
- <a name="user-content-require-property-context-and-settings"></a>
24
- <a name="require-property-context-and-settings"></a>
25
- ## Context and settings
26
-
27
- |||
28
- |---|---|
29
- |Context|Everywhere|
30
- |Tags|`typedef`, `namespace`|
31
- |Recommended|true|
32
-
33
- <a name="user-content-require-property-failing-examples"></a>
34
- <a name="require-property-failing-examples"></a>
35
- ## Failing examples
36
-
37
- The following patterns are considered problems:
38
-
39
- ````js
40
- /**
41
- * @typedef {object} SomeTypedef
42
- */
43
- // Message: Missing JSDoc @property.
44
-
45
- class Test {
46
- /**
47
- * @typedef {object} SomeTypedef
48
- */
49
- quux () {}
50
- }
51
- // Message: Missing JSDoc @property.
52
-
53
- /**
54
- * @typedef {PlainObject} SomeTypedef
55
- */
56
- // Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
57
- // Message: Missing JSDoc @prop.
58
-
59
- /**
60
- * @namespace {Object} SomeName
61
- */
62
- // Message: Missing JSDoc @property.
63
- ````
64
-
65
-
66
-
67
- <a name="user-content-require-property-passing-examples"></a>
68
- <a name="require-property-passing-examples"></a>
69
- ## Passing examples
70
-
71
- The following patterns are not considered problems:
72
-
73
- ````js
74
- /**
75
- *
76
- */
77
-
78
- /**
79
- * @property
80
- */
81
-
82
- /**
83
- * @typedef {Object} SomeTypedef
84
- * @property {SomeType} propName Prop description
85
- */
86
-
87
- /**
88
- * @typedef {object} SomeTypedef
89
- * @prop {SomeType} propName Prop description
90
- */
91
- // Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
92
-
93
- /**
94
- * @typedef {object} SomeTypedef
95
- * @property
96
- * // arbitrary property content
97
- */
98
-
99
- /**
100
- * @typedef {object<string, string>} SomeTypedef
101
- */
102
-
103
- /**
104
- * @typedef {string} SomeTypedef
105
- */
106
-
107
- /**
108
- * @namespace {object} SomeName
109
- * @property {SomeType} propName Prop description
110
- */
111
-
112
- /**
113
- * @namespace {object} SomeName
114
- * @property
115
- * // arbitrary property content
116
- */
117
-
118
- /**
119
- * @typedef {object} SomeTypedef
120
- * @property someProp
121
- * @property anotherProp This with a description
122
- * @property {anotherType} yetAnotherProp This with a type and desc.
123
- */
124
- function quux () {
125
-
126
- }
127
- ````
128
-