Skip to content

Commit d4e4881

Browse files
Improve JSDocs linting
* Update deps * Update E2E tests
1 parent b407b24 commit d4e4881

File tree

7 files changed

+226
-106
lines changed

7 files changed

+226
-106
lines changed

.eslintrc.js

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,27 @@ module.exports = {
2121
'jsdoc/check-alignment': 1,
2222
'jsdoc/check-examples': 1,
2323
'jsdoc/check-indentation': 0,
24-
// Waiting on bug fix: https://github.com/gajus/eslint-plugin-jsdoc/issues/680
25-
// 'jsdoc/check-line-alignment': [1, 'always'],
24+
'jsdoc/check-line-alignment': [
25+
1,
26+
'always',
27+
{
28+
'tags': [
29+
'param',
30+
'arg',
31+
'argument',
32+
'property',
33+
'prop',
34+
'returns',
35+
'return'
36+
],
37+
'customSpacings': {
38+
'postDelimiter': 1,
39+
'postTag': 1,
40+
'postType': 1,
41+
'postName': 2
42+
}
43+
}
44+
],
2645
'jsdoc/check-param-names': 1,
2746
'jsdoc/check-property-names': 1,
2847
'jsdoc/check-syntax': 1,
@@ -73,6 +92,20 @@ module.exports = {
7392
'jsdoc/require-returns-check': 1,
7493
'jsdoc/require-returns-description': 1,
7594
'jsdoc/require-returns-type': 1,
95+
'jsdoc/tag-lines': [
96+
1,
97+
'always',
98+
{
99+
'count': 0,
100+
'noEndLines': true,
101+
'tags': {
102+
'example': {
103+
'count': 1,
104+
'lines': 'always'
105+
}
106+
}
107+
}
108+
],
76109
'jsdoc/valid-types': 1
77110
},
78111
'settings': {

0 commit comments

Comments
 (0)