Skip to content

Commit b9372c6

Browse files
committed
refactor: ts work
1 parent 231da2a commit b9372c6

33 files changed

+1115
-507
lines changed

.README/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ values are objects with the following optional properties:
320320
is required (not just that if present, it is a valid type). You
321321
might use this with `@throws` or `@typedef` which might otherwise
322322
normally have their types optional. See the type groups 3-5 above.
323-
- `"typeOrName"` - Must have either type (e.g., `@throws {aType}`) or
323+
- `"typeOrNameRequired"` - Must have either type (e.g., `@throws {aType}`) or
324324
name (`@throws Some text`); does not require that both exist but
325325
disallows just an empty tag.
326326

docs/rules/check-tag-names.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -764,6 +764,15 @@ function Test() {
764764
*/
765765
// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
766766
// Message: '@typedef' is redundant when using a type system.
767+
768+
/**
769+
* @todo
770+
*/
771+
function quux () {
772+
773+
}
774+
// Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please don't use todo"}}}}
775+
// Message: Please don't use todo
767776
````
768777

769778

docs/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ values are objects with the following optional properties:
347347
is required (not just that if present, it is a valid type). You
348348
might use this with `@throws` or `@typedef` which might otherwise
349349
normally have their types optional. See the type groups 3-5 above.
350-
- `"typeOrName"` - Must have either type (e.g., `@throws {aType}`) or
350+
- `"typeOrNameRequired"` - Must have either type (e.g., `@throws {aType}`) or
351351
name (`@throws Some text`); does not require that both exist but
352352
disallows just an empty tag.
353353

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"@types/estree": "^1.0.1",
3737
"@types/lodash.defaultsdeep": "^4.6.7",
3838
"@types/mocha": "^10.0.1",
39-
"@types/node": "^20.1.3",
39+
"@types/node": "^20.1.4",
4040
"@types/semver": "^7.5.0",
4141
"@types/spdx-expression-parse": "^3.0.2",
4242
"@typescript-eslint/parser": "^5.59.5",

0 commit comments

Comments
 (0)