Skip to content

Commit b6d307a

Browse files
committed
adding jsdoc to combined list of rules for codeclimate. alpha release
1 parent 4fe43e6 commit b6d307a

File tree

3 files changed

+31
-3
lines changed

3 files changed

+31
-3
lines changed

codeclimateEslintRules.js

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"html",
55
"json",
66
"babel",
7-
"react-hooks"
7+
"react-hooks",
8+
"jsdoc"
89
],
910
"extends": [
1011
"airbnb",
@@ -67,7 +68,33 @@
6768
"react/require-default-props": "off",
6869
"react-hooks/rules-of-hooks": "error",
6970
"react-hooks/exhaustive-deps": "warn",
70-
"jest/no-large-snapshots": "error"
71+
"jest/no-large-snapshots": "error",
72+
"jsdoc/check-alignment": "warn",
73+
"jsdoc/check-examples": "warn",
74+
"jsdoc/check-indentation": "off",
75+
"jsdoc/check-param-names": "warn",
76+
"jsdoc/check-syntax": "warn",
77+
"jsdoc/check-tag-names": "warn",
78+
"jsdoc/check-types": "warn",
79+
"jsdoc/implements-on-classes": "warn",
80+
"jsdoc/match-description": "warn",
81+
"jsdoc/newline-after-description": "off",
82+
"jsdoc/no-types": "off",
83+
"jsdoc/no-undefined-types": "warn",
84+
"jsdoc/require-description-complete-sentence": "off",
85+
"jsdoc/require-description": "warn",
86+
"jsdoc/require-example": "off",
87+
"jsdoc/require-hyphen-before-param-description": "warn",
88+
"jsdoc/require-jsdoc": "warn",
89+
"jsdoc/require-param-description": "warn",
90+
"jsdoc/require-param-name": "warn",
91+
"jsdoc/require-param-type": "warn",
92+
"jsdoc/require-param": "warn",
93+
"jsdoc/require-returns-check": "warn",
94+
"jsdoc/require-returns-description": "warn",
95+
"jsdoc/require-returns-type": "warn",
96+
"jsdoc/require-returns": "warn",
97+
"jsdoc/valid-types": "warn"
7198
},
7299
"env": {
73100
"es6": true,

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@fs/eslint-config-frontier-react",
3-
"version": "2.1.0",
3+
"version": "2.2.0-alpha.0",
44
"description": "A common ESLint configuration setup for frontier apps",
55
"main": "index.js",
66
"scripts": {

scripts/combineRules.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const configsToCombine = [
1010
require('../es6'), // eslint-disable-line
1111
require('../react'), // eslint-disable-line
1212
require('../jest'), // eslint-disable-line
13+
require('../jsdoc'), // eslint-disable-line
1314
]
1415

1516
const codeclimateConfig = {

0 commit comments

Comments
 (0)