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/text-escaping.md DELETED
@@ -1,177 +0,0 @@
1
- <a name="user-content-text-escaping"></a>
2
- <a name="text-escaping"></a>
3
- # <code>text-escaping</code>
4
-
5
- * [Fixer](#user-content-text-escaping-fixer)
6
- * [Options](#user-content-text-escaping-options)
7
- * [`escapeHTML`](#user-content-text-escaping-options-escapehtml)
8
- * [`escapeMarkdown`](#user-content-text-escaping-options-escapemarkdown)
9
- * [Context and settings](#user-content-text-escaping-context-and-settings)
10
- * [Failing examples](#user-content-text-escaping-failing-examples)
11
- * [Passing examples](#user-content-text-escaping-passing-examples)
12
-
13
-
14
- This rule can auto-escape certain characters that are input within block and
15
- tag descriptions.
16
-
17
- This rule may be desirable if your text is known not to contain HTML or
18
- Markdown and you therefore do not wish for it to be accidentally interpreted
19
- as such by the likes of Visual Studio Code or if you wish to view it escaped
20
- within it or your documentation.
21
-
22
- <a name="user-content-text-escaping-fixer"></a>
23
- <a name="text-escaping-fixer"></a>
24
- ## Fixer
25
-
26
- (TODO)
27
-
28
- <a name="user-content-text-escaping-options"></a>
29
- <a name="text-escaping-options"></a>
30
- ## Options
31
-
32
- <a name="user-content-text-escaping-options-escapehtml"></a>
33
- <a name="text-escaping-options-escapehtml"></a>
34
- ### <code>escapeHTML</code>
35
-
36
- This option escapes all `<` and `&` characters (except those followed by
37
- whitespace which are treated as literals by Visual Studio Code).
38
-
39
- <a name="user-content-text-escaping-options-escapemarkdown"></a>
40
- <a name="text-escaping-options-escapemarkdown"></a>
41
- ### <code>escapeMarkdown</code>
42
-
43
- This option escapes the first backtick (`` ` ``) in a paired sequence.
44
-
45
- <a name="user-content-text-escaping-context-and-settings"></a>
46
- <a name="text-escaping-context-and-settings"></a>
47
- ## Context and settings
48
-
49
- |||
50
- |---|---|
51
- |Context|everywhere|
52
- |Tags|``|
53
- |Recommended|false|
54
- |Settings||
55
- |Options|`escapeHTML`, `escapeMarkdown`|
56
-
57
- <a name="user-content-text-escaping-failing-examples"></a>
58
- <a name="text-escaping-failing-examples"></a>
59
- ## Failing examples
60
-
61
- The following patterns are considered problems:
62
-
63
- ````js
64
- /**
65
- * Some things to escape: <a> and &gt; and `test`
66
- */
67
- // Message: You must include either `escapeHTML` or `escapeMarkdown`
68
-
69
- /**
70
- * Some things to escape: <a> and &gt; and &#xabc; and `test`
71
- */
72
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
73
- // Message: You have unescaped HTML characters < or &
74
-
75
- /**
76
- * Some things to escape: <a> and &gt; and `test`
77
- */
78
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
79
- // Message: You have unescaped Markdown backtick sequences
80
-
81
- /**
82
- * Some things to escape:
83
- * <a> and &gt; and `test`
84
- */
85
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
86
- // Message: You have unescaped HTML characters < or &
87
-
88
- /**
89
- * Some things to escape:
90
- * <a> and &gt; and `test`
91
- */
92
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
93
- // Message: You have unescaped Markdown backtick sequences
94
-
95
- /**
96
- * @param {SomeType} aName Some things to escape: <a> and &gt; and `test`
97
- */
98
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
99
- // Message: You have unescaped HTML characters < or & in a tag
100
-
101
- /**
102
- * @param {SomeType} aName Some things to escape: <a> and &gt; and `test`
103
- */
104
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
105
- // Message: You have unescaped Markdown backtick sequences in a tag
106
-
107
- /**
108
- * @param {SomeType} aName Some things to escape:
109
- * <a> and &gt; and `test`
110
- */
111
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
112
- // Message: You have unescaped HTML characters < or & in a tag
113
-
114
- /**
115
- * @param {SomeType} aName Some things to escape:
116
- * <a> and &gt; and `test`
117
- */
118
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
119
- // Message: You have unescaped Markdown backtick sequences in a tag
120
- ````
121
-
122
-
123
-
124
- <a name="user-content-text-escaping-passing-examples"></a>
125
- <a name="text-escaping-passing-examples"></a>
126
- ## Passing examples
127
-
128
- The following patterns are not considered problems:
129
-
130
- ````js
131
- /**
132
- * Some things to escape: &lt;a> and &gt; and `test`
133
- */
134
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
135
-
136
- /**
137
- * Some things to escape: <a> and &gt; and \`test`
138
- */
139
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
140
-
141
- /**
142
- * Some things to escape: < and &
143
- */
144
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
145
-
146
- /**
147
- * Some things to escape: `
148
- */
149
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
150
-
151
- /**
152
- * @param {SomeType} aName Some things to escape: &lt;a> and &gt; and `test`
153
- */
154
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
155
-
156
- /**
157
- * @param {SomeType} aName Some things to escape: <a> and &gt; and \`test`
158
- */
159
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
160
-
161
- /**
162
- * @param {SomeType} aName Some things to escape: < and &
163
- */
164
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
165
-
166
- /**
167
- * @param {SomeType} aName Some things to escape: `
168
- */
169
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeMarkdown":true}]
170
-
171
- /**
172
- * Nothing
173
- * to escape
174
- */
175
- // "jsdoc/text-escaping": ["error"|"warn", {"escapeHTML":true}]
176
- ````
177
-