Skip to content

Commit

Permalink
refactor: ts work
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed May 15, 2023
1 parent 231da2a commit b9372c6
Show file tree
Hide file tree
Showing 33 changed files with 1,115 additions and 507 deletions.
2 changes: 1 addition & 1 deletion .README/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ values are objects with the following optional properties:
is required (not just that if present, it is a valid type). You
might use this with `@throws` or `@typedef` which might otherwise
normally have their types optional. See the type groups 3-5 above.
- `"typeOrName"` - Must have either type (e.g., `@throws {aType}`) or
- `"typeOrNameRequired"` - Must have either type (e.g., `@throws {aType}`) or
name (`@throws Some text`); does not require that both exist but
disallows just an empty tag.

Expand Down
9 changes: 9 additions & 0 deletions docs/rules/check-tag-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,15 @@ function Test() {
*/
// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
// Message: '@typedef' is redundant when using a type system.

/**
* @todo
*/
function quux () {

}
// Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please don't use todo"}}}}
// Message: Please don't use todo
````


Expand Down
2 changes: 1 addition & 1 deletion docs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ values are objects with the following optional properties:
is required (not just that if present, it is a valid type). You
might use this with `@throws` or `@typedef` which might otherwise
normally have their types optional. See the type groups 3-5 above.
- `"typeOrName"` - Must have either type (e.g., `@throws {aType}`) or
- `"typeOrNameRequired"` - Must have either type (e.g., `@throws {aType}`) or
name (`@throws Some text`); does not require that both exist but
disallows just an empty tag.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"@types/estree": "^1.0.1",
"@types/lodash.defaultsdeep": "^4.6.7",
"@types/mocha": "^10.0.1",
"@types/node": "^20.1.3",
"@types/node": "^20.1.4",
"@types/semver": "^7.5.0",
"@types/spdx-expression-parse": "^3.0.2",
"@typescript-eslint/parser": "^5.59.5",
Expand Down

0 comments on commit b9372c6

Please sign in to comment.