Skip to content

Commit

Permalink
chore: Make eslint-plugin-jsdoc aware of TypeDoc tags
Browse files Browse the repository at this point in the history
Ref #9632
  • Loading branch information
gibson042 committed Jul 12, 2024
1 parent 6c7054c commit 476229d
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,27 @@ module.exports = {
// The default is 'warn', but we want to enforce 'error'.
'@jessie.js/safe-await-separator': 'error',

'jsdoc/check-tag-names': [
'error',
{
// TypeDoc adds tags not otherwise known to JSDoc
// https://typedoc.org/guides/tags/
definedTags: [
'alpha',
'beta',
'category',
'categoryDescription',
'defaultValue',
'document',
'group',
'groupDescription',
'internal',
'privateRemarks',
'remarks',
],
},
],

// CI has a separate format check but keep this warn to maintain that "eslint --fix" prettifies
// UNTIL https://github.com/Agoric/agoric-sdk/issues/4339
'prettier/prettier': 'warn',
Expand Down

0 comments on commit 476229d

Please sign in to comment.