eslint-plugin-jsdoc 39.6.0 → 39.6.1

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 (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -9641,6 +9641,16 @@ 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
9644
9654
  ````
9645
9655
 
9646
9656
  The following patterns are not considered problems:
@@ -9699,6 +9709,13 @@ const MY_ENUM = Object.freeze({
9699
9709
  /** Does something very important. */
9700
9710
  function foo(): string;
9701
9711
  // "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[endLine=0][description!=/^\\S[\\s\\S]*\\S\\s$/]"}]}]
9712
+
9713
+ /** Some text and more */
9714
+ // "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"}]}]
9715
+
9716
+ /** Some text and
9717
+ * more */
9718
+ // "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"}]}]
9702
9719
  ````
9703
9720
 
9704
9721
 
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "url": "http://gajus.com"
6
6
  },
7
7
  "dependencies": {
8
- "@es-joy/jsdoccomment": "~0.33.4",
8
+ "@es-joy/jsdoccomment": "~0.35.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.0"
120
+ "version": "39.6.1"
121
121
  }