Skip to content

Commit

Permalink
ci(eslint): add eslint-plugin-jsdoc (#53)
Browse files Browse the repository at this point in the history
## Summary

<!-- Please summarize your changes. -->

<!-- Please link to any applicable information (forum posts, bug
reports, etc.). -->

I added
[eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc)
This will help us make conventional and sustainable jsdoc comment

## Checks

<!-- For completed items, change [ ] to [x]. -->

<!-- If you leave this checklist empty, your PR will very likely be
closed. -->

Please check the following:

- [x] I have written documents and tests, if needed.
  • Loading branch information
manudeli authored Sep 25, 2023
1 parent 76feea2 commit 7fd6111
Show file tree
Hide file tree
Showing 3 changed files with 256 additions and 26 deletions.
9 changes: 7 additions & 2 deletions configs/eslint-config-ts/noimport.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,17 @@ module.exports = {
root: true,
parser: "@typescript-eslint/parser",
extends: [
"plugin:jsdoc/recommended-typescript",
"@fepack/eslint-config-js/noimport",
"plugin:@typescript-eslint/recommended",
],
plugins: ["@typescript-eslint"],
plugins: ["jsdoc", "@typescript-eslint"],
rules: {
"@typescript-eslint/no-empty-function": ["off"],
"@typescript-eslint/no-empty-function": "off",
"@typescript-eslint/no-unused-vars": "error",
"jsdoc/require-description": "warn",
"jsdoc/require-returns": "off",
"jsdoc/require-jsdoc": "off",
"jsdoc/check-param-names": "error",
},
};
3 changes: 2 additions & 1 deletion configs/eslint-config-ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"@fepack/eslint-config-js": "workspace:*",
"@typescript-eslint/eslint-plugin": "^5.7.0",
"@typescript-eslint/parser": "^5.7.0",
"eslint-import-resolver-typescript": "^2.5.0"
"eslint-import-resolver-typescript": "^2.5.0",
"eslint-plugin-jsdoc": "^46.8.2"
},
"peerDependencies": {
"eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
Expand Down
Loading

0 comments on commit 7fd6111

Please sign in to comment.