Skip to content

Commit 647dc04

Browse files
pdehaangajus
authored andcommitted
feat: add 'recommended' config (#51)
1 parent d579850 commit 647dc04

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

src/index.js

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,25 @@ import requireReturnsDescription from './rules/requireReturnsDescription';
1313
import requireReturnsType from './rules/requireReturnsType';
1414

1515
export default {
16+
configs: {
17+
recommended: {
18+
rules: {
19+
'jsdoc/check-param-names': 'warn',
20+
'jsdoc/check-tag-names': 'warn',
21+
'jsdoc/check-types': 'warn',
22+
'jsdoc/newline-after-description': 'warn',
23+
'jsdoc/require-description-complete-sentence': 'off',
24+
'jsdoc/require-example': 'off',
25+
'jsdoc/require-hyphen-before-param-description': 'off',
26+
'jsdoc/require-param': 'warn',
27+
'jsdoc/require-param-description': 'warn',
28+
'jsdoc/require-param-name': 'warn',
29+
'jsdoc/require-param-type': 'warn',
30+
'jsdoc/require-returns-description': 'warn',
31+
'jsdoc/require-returns-type': 'warn'
32+
}
33+
}
34+
},
1635
rules: {
1736
'check-param-names': checkParamNames,
1837
'check-tag-names': checkTagNames,
@@ -29,18 +48,18 @@ export default {
2948
'require-returns-type': requireReturnsType
3049
},
3150
rulesConfig: {
32-
'check-param-names': 0,
33-
'check-tag-names': 0,
34-
'check-types': 0,
35-
'newline-after-description': 0,
36-
'require-description-complete-sentence': 0,
37-
'require-example': 0,
38-
'require-hyphen-before-param-description': 0,
39-
'require-param': 0,
40-
'require-param-description': 0,
41-
'require-param-name': 0,
42-
'require-param-type': 0,
43-
'require-returns-description': 0,
44-
'require-returns-type': 0
51+
'check-param-names': 'off',
52+
'check-tag-names': 'off',
53+
'check-types': 'off',
54+
'newline-after-description': 'off',
55+
'require-description-complete-sentence': 'off',
56+
'require-example': 'off',
57+
'require-hyphen-before-param-description': 'off',
58+
'require-param': 'off',
59+
'require-param-description': 'off',
60+
'require-param-name': 'off',
61+
'require-param-type': 'off',
62+
'require-returns-description': 'off',
63+
'require-returns-type': 'off'
4564
}
4665
};

0 commit comments

Comments
 (0)