Skip to content

Commit

Permalink
pre-commit: add eslint-plugin-jsdoc
Browse files Browse the repository at this point in the history
This allows us to enforce that the libraries we ship
come with good JSDoc comments which should improve DX
when mapping with capable code editors.
  • Loading branch information
Swiftb0y committed Dec 22, 2021
1 parent 8f955e7 commit b1a0145
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"extends": "eslint:recommended",
"extends": ["eslint:recommended", "plugin:jsdoc/recommended"],
"parserOptions": {
"ecmaVersion": 7,
"sourceType": "script"
},
"env": {
"es6": true
},
"plugins": ["jsdoc"],
"rules": {
"array-bracket-spacing" : "warn",
"block-spacing": "warn",
Expand Down
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ repos:
stages:
- commit
- manual
additional_dependencies:
- eslint-plugin-jsdoc@^v37.4.0
- repo: local
hooks:
- id: clang-format
Expand Down

0 comments on commit b1a0145

Please sign in to comment.