Skip to content

Commit a55bf39

Browse files
committed
JSDocs only for js, jsx, or html files
1 parent aed7761 commit a55bf39

File tree

1 file changed

+41
-37
lines changed

1 file changed

+41
-37
lines changed

index.js

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -33,45 +33,8 @@ module.exports = {
3333

3434
'no-shadow': 'warn', // frontier has this as error, tw-blue has this as off
3535

36-
'valid-jsdoc': ['warn'], // frontier has this as off
3736
'no-undefined': 'off', // frontier has this as off, we had this as warn. I think it really should be off which means removing this line.
3837

39-
'jsdoc/check-access': 'off',
40-
'jsdoc/check-alignment': 'warn',
41-
'jsdoc/check-indentation': 'off',
42-
'jsdoc/check-param-names': 'warn',
43-
// 'jsdoc/check-property-names': 'warn',
44-
'jsdoc/check-syntax': 'warn',
45-
'jsdoc/check-tag-names': 'warn',
46-
'jsdoc/check-types': 'warn',
47-
// 'jsdoc/check-values': 'warn',
48-
// 'jsdoc/empty-tags': 'warn',
49-
'jsdoc/implements-on-classes': 'warn',
50-
'jsdoc/match-description': 'warn',
51-
'jsdoc/newline-after-description': 'off',
52-
'jsdoc/no-types': 'off',
53-
'jsdoc/no-undefined-types': 'off', // 2020-01-23: This was broken in eslint-plugin-jsdoc#8 in 2019-06, and hasn't gotten much better. Disabled, for now. Check back later.
54-
'jsdoc/require-description-complete-sentence': 'off',
55-
'jsdoc/require-description': 'warn',
56-
'jsdoc/require-example': 'off',
57-
'jsdoc/require-file-overview': 'off',
58-
'jsdoc/require-hyphen-before-param-description': 'warn',
59-
'jsdoc/require-jsdoc': 'off',
60-
'jsdoc/require-param-description': 'warn',
61-
'jsdoc/require-param-name': 'warn',
62-
'jsdoc/require-param-type': 'warn',
63-
'jsdoc/require-param': 'warn',
64-
// 'jsdoc/require-property-description': 'warn',
65-
// 'jsdoc/require-property-name': 'warn',
66-
// 'jsdoc/require-property-type': 'warn',
67-
// 'jsdoc/require-property': 'warn',
68-
'jsdoc/require-returns-check': 'warn',
69-
'jsdoc/require-returns-description': 'warn',
70-
'jsdoc/require-returns-type': 'warn',
71-
'jsdoc/require-returns': 'warn',
72-
'jsdoc/require-throws': 'off',
73-
'jsdoc/valid-types': 'warn',
74-
7538
'import/no-absolute-path': 'warn', // frontier has this as error
7639

7740
'bestpractices/no-eslint-disable': 'warn',
@@ -167,6 +130,47 @@ module.exports = {
167130
// ]
168131
},
169132
overrides: [
133+
{
134+
files: ['*.js?(x)', '*.html'],
135+
rules: {
136+
'valid-jsdoc': ['warn'], // frontier has this as off
137+
'jsdoc/check-access': 'off',
138+
'jsdoc/check-alignment': 'warn',
139+
'jsdoc/check-indentation': 'off',
140+
'jsdoc/check-param-names': 'warn',
141+
// 'jsdoc/check-property-names': 'warn',
142+
'jsdoc/check-syntax': 'warn',
143+
'jsdoc/check-tag-names': 'warn',
144+
'jsdoc/check-types': 'warn',
145+
// 'jsdoc/check-values': 'warn',
146+
// 'jsdoc/empty-tags': 'warn',
147+
'jsdoc/implements-on-classes': 'warn',
148+
'jsdoc/match-description': 'warn',
149+
'jsdoc/newline-after-description': 'off',
150+
'jsdoc/no-types': 'off',
151+
'jsdoc/no-undefined-types': 'off', // 2020-01-23: This was broken in eslint-plugin-jsdoc#8 in 2019-06, and hasn't gotten much better. Disabled, for now. Check back later.
152+
'jsdoc/require-description-complete-sentence': 'off',
153+
'jsdoc/require-description': 'warn',
154+
'jsdoc/require-example': 'off',
155+
'jsdoc/require-file-overview': 'off',
156+
'jsdoc/require-hyphen-before-param-description': 'warn',
157+
'jsdoc/require-jsdoc': 'off',
158+
'jsdoc/require-param-description': 'warn',
159+
'jsdoc/require-param-name': 'warn',
160+
'jsdoc/require-param-type': 'warn',
161+
'jsdoc/require-param': 'warn',
162+
// 'jsdoc/require-property-description': 'warn',
163+
// 'jsdoc/require-property-name': 'warn',
164+
// 'jsdoc/require-property-type': 'warn',
165+
// 'jsdoc/require-property': 'warn',
166+
'jsdoc/require-returns-check': 'warn',
167+
'jsdoc/require-returns-description': 'warn',
168+
'jsdoc/require-returns-type': 'warn',
169+
'jsdoc/require-returns': 'warn',
170+
'jsdoc/require-throws': 'off',
171+
'jsdoc/valid-types': 'warn',
172+
},
173+
},
170174
{
171175
files: ['*.stories.*', '*.test.*', '**/test/**', '**/*mock*/**', '*mock*'],
172176
rules: {

0 commit comments

Comments
 (0)