Skip to content

Commit

Permalink
ci(eslint): ignore private/internal code for jsdoc rules (#6416)
Browse files Browse the repository at this point in the history
**Related Issue:** N/A

## Summary

Prevents
[`eslint-jsdoc-plugin`](https://www.npmjs.com/package/eslint-plugin-jsdoc)
from complaining when an interface/function/class/etc is marked as
`@internal` or `@private` in its jsdoc block. We will need to go through
the code and appropriately mark a lot of our utils as `@internal`.
  • Loading branch information
benelan authored Mar 7, 2023
1 parent bc9239b commit 942cf56
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,19 @@
"curly": "error",
"jest/expect-expect": "off",
"jest/no-export": "warn",
"jsdoc/require-jsdoc": "off",
"jsdoc/check-tag-names": "off",
"jsdoc/require-jsdoc": "off",
"lines-between-class-members": ["error", "always"],
"no-multiple-empty-lines": ["error", { "max": 1 }],
"no-unneeded-ternary": "error",
"no-eval": "error",
"no-implied-eval": "error",
"no-multiple-empty-lines": [
"error",
{
"max": 1
}
],
"no-new-func": "error",
"no-unneeded-ternary": "error",
"react/forbid-component-props": [
"warn",
{
Expand Down Expand Up @@ -130,6 +135,10 @@
"settings": {
"react": {
"pragma": "h"
},
"jsdoc": {
"ignoreInternal": true,
"ignorePrivate": true
}
}
}

0 comments on commit 942cf56

Please sign in to comment.