eslint-plugin-jsdoc 39.6.0 → 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 +27 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9641,6 +9641,21 @@ const MyComponent = ({ children }) => {
|
|
|
9641
9641
|
}
|
|
9642
9642
|
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"type\"]:has([value=/FunctionComponent/]))","context":"any","message":"The `FunctionComponent` type is not allowed. Please use `FC` instead."}]}]
|
|
9643
9643
|
// Message: The `FunctionComponent` type is not allowed. Please use `FC` instead.
|
|
9644
|
+
|
|
9645
|
+
/** Some text and more */
|
|
9646
|
+
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][descriptionEndLine=0]","context":"any","message":"Requiring descriptive text on 0th line only"}]}]
|
|
9647
|
+
// Message: Requiring descriptive text on 0th line only
|
|
9648
|
+
|
|
9649
|
+
/** Some text and
|
|
9650
|
+
* more
|
|
9651
|
+
*/
|
|
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
|
+
// 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
|
|
9644
9659
|
````
|
|
9645
9660
|
|
|
9646
9661
|
The following patterns are not considered problems:
|
|
@@ -9699,6 +9714,18 @@ const MY_ENUM = Object.freeze({
|
|
|
9699
9714
|
/** Does something very important. */
|
|
9700
9715
|
function foo(): string;
|
|
9701
9716
|
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[endLine=0][description!=/^\\S[\\s\\S]*\\S\\s$/]"}]}]
|
|
9717
|
+
|
|
9718
|
+
/** Some text and more */
|
|
9719
|
+
// "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[descriptionStartLine=0][descriptionEndLine=1]","context":"any","message":"Requiring descriptive text on 0th line and no final newline"}]}]
|
|
9720
|
+
|
|
9721
|
+
/** Some text and
|
|
9722
|
+
* more */
|
|
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"}]}]
|
|
9702
9729
|
````
|
|
9703
9730
|
|
|
9704
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
|
}
|