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/check-alignment.md DELETED
@@ -1,169 +0,0 @@
1
- <a name="user-content-check-alignment"></a>
2
- <a name="check-alignment"></a>
3
- # <code>check-alignment</code>
4
-
5
- * [Fixer](#user-content-check-alignment-fixer)
6
- * [Context and settings](#user-content-check-alignment-context-and-settings)
7
- * [Failing examples](#user-content-check-alignment-failing-examples)
8
- * [Passing examples](#user-content-check-alignment-passing-examples)
9
-
10
-
11
- Reports invalid alignment of JSDoc block asterisks.
12
-
13
- <a name="user-content-check-alignment-fixer"></a>
14
- <a name="check-alignment-fixer"></a>
15
- ## Fixer
16
-
17
- Fixes alignment.
18
-
19
- <a name="user-content-check-alignment-context-and-settings"></a>
20
- <a name="check-alignment-context-and-settings"></a>
21
- ## Context and settings
22
-
23
- |||
24
- |---|---|
25
- |Context|everywhere|
26
- |Tags|N/A|
27
- |Recommended|true|
28
-
29
- <a name="user-content-check-alignment-failing-examples"></a>
30
- <a name="check-alignment-failing-examples"></a>
31
- ## Failing examples
32
-
33
- The following patterns are considered problems:
34
-
35
- ````js
36
- /**
37
- * @param {Number} foo
38
- */
39
- function quux (foo) {
40
- // with spaces
41
- }
42
- // Message: Expected JSDoc block to be aligned.
43
-
44
- /**
45
- * @param {Number} foo
46
- */
47
- function quux (foo) {
48
- // with tabs
49
- }
50
- // Message: Expected JSDoc block to be aligned.
51
-
52
- /**
53
- * @param {Number} foo
54
- */
55
- function quux (foo) {
56
- // with spaces
57
- }
58
- // Message: Expected JSDoc block to be aligned.
59
-
60
- /**
61
- * @param {Number} foo
62
- */
63
- function quux (foo) {
64
- // with spaces
65
- }
66
- // Message: Expected JSDoc block to be aligned.
67
-
68
- /**
69
- * @param {Number} foo
70
- */
71
- function quux (foo) {
72
-
73
- }
74
- // Message: Expected JSDoc block to be aligned.
75
-
76
- /**
77
- * @param {Number} foo
78
- */
79
- function quux (foo) {
80
-
81
- }
82
- // Message: Expected JSDoc block to be aligned.
83
-
84
- /**
85
- * @param {Number} foo
86
- */
87
- function quux (foo) {
88
-
89
- }
90
- // Message: Expected JSDoc block to be aligned.
91
-
92
- /**
93
- * @param {Number} foo
94
- */
95
- function quux (foo) {
96
-
97
- }
98
- // Message: Expected JSDoc block to be aligned.
99
-
100
- /**
101
- * A jsdoc not attached to any node.
102
- */
103
- // Message: Expected JSDoc block to be aligned.
104
-
105
- class Foo {
106
- /**
107
- * Some method
108
- * @param a
109
- */
110
- quux(a) {}
111
- }
112
- // Message: Expected JSDoc block to be aligned.
113
- ````
114
-
115
-
116
-
117
- <a name="user-content-check-alignment-passing-examples"></a>
118
- <a name="check-alignment-passing-examples"></a>
119
- ## Passing examples
120
-
121
- The following patterns are not considered problems:
122
-
123
- ````js
124
- /**
125
- * Desc
126
- *
127
- * @param {Number} foo
128
- */
129
- function quux (foo) {
130
-
131
- }
132
-
133
- /**
134
- * Desc
135
- *
136
- * @param {{
137
- foo: Bar,
138
- bar: Baz
139
- * }} foo
140
- *
141
- */
142
- function quux (foo) {
143
-
144
- }
145
-
146
- /* <- JSDoc must start with 2 stars.
147
- * So this is unchecked.
148
- */
149
- function quux (foo) {}
150
-
151
- /**
152
- * @param {Number} foo
153
- * @private
154
- */
155
- function quux (foo) {
156
- // with spaces
157
- }
158
- // Settings: {"jsdoc":{"ignorePrivate":true}}
159
-
160
- /**
161
- * @param {Number} foo
162
- * @access private
163
- */
164
- function quux (foo) {
165
- // with spaces
166
- }
167
- // Settings: {"jsdoc":{"ignorePrivate":true}}
168
- ````
169
-