eslint-plugin-jsdoc 39.6.1 → 39.6.2
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.
- package/README.md +10 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9651,6 +9651,11 @@ const MyComponent = ({ children }) => {
|
|
|
9651
9651
|
*/
|
|
9652
9652
|
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][hasPreterminalDescription=0]","context":"any","message":"Requiring descriptive text on 0th line and no preterminal description"}]}]
|
|
9653
9653
|
// Message: Requiring descriptive text on 0th line and no preterminal description
|
|
9654
|
+
|
|
9655
|
+
/** Some text
|
|
9656
|
+
* @param sth Param text followed by no newline */
|
|
9657
|
+
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][hasPreterminalTagDescription=1]","context":"any","message":"Requiring descriptive text on 0th line but no preterminal description"}]}]
|
|
9658
|
+
// Message: Requiring descriptive text on 0th line but no preterminal description
|
|
9654
9659
|
````
|
|
9655
9660
|
|
|
9656
9661
|
The following patterns are not considered problems:
|
|
@@ -9716,6 +9721,11 @@ function foo(): string;
|
|
|
9716
9721
|
/** Some text and
|
|
9717
9722
|
* more */
|
|
9718
9723
|
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][hasPreterminalDescription=0]","context":"any","message":"Requiring descriptive text on 0th line and no preterminal description"}]}]
|
|
9724
|
+
|
|
9725
|
+
/** Some text
|
|
9726
|
+
* @param sth Param text followed by newline
|
|
9727
|
+
*/
|
|
9728
|
+
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][hasPreterminalTagDescription=1]","context":"any","message":"Requiring descriptive text on 0th line but no preterminal description"}]}]
|
|
9719
9729
|
````
|
|
9720
9730
|
|
|
9721
9731
|
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"url": "http://gajus.com"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@es-joy/jsdoccomment": "~0.
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.36.0",
|
|
9
9
|
"comment-parser": "1.3.1",
|
|
10
10
|
"debug": "^4.3.4",
|
|
11
11
|
"escape-string-regexp": "^4.0.0",
|
|
@@ -117,5 +117,5 @@
|
|
|
117
117
|
"test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
|
|
118
118
|
"test-index": "npm run test-no-cov -- test/rules/index.js"
|
|
119
119
|
},
|
|
120
|
-
"version": "39.6.
|
|
120
|
+
"version": "39.6.2"
|
|
121
121
|
}
|