Skip to content

Commit 52e3fcc

Browse files
gajusgajus
committed
style: fix style issues
1 parent ef01bde commit 52e3fcc

29 files changed

+1589
-1594
lines changed

‎src/index.js

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,30 @@ import requireReturnsDescription from './rules/requireReturnsDescription';
1111
import requireReturnsType from './rules/requireReturnsType';
1212

1313
export default {
14-
rules: {
15-
'check-param-names': checkParamNames,
16-
'check-tag-names': checkTagNames,
17-
'check-types': checkTypes,
18-
'newline-after-description': newlineAfterDescription,
19-
'require-description-complete-sentence': requireDescriptionCompleteSentence,
20-
'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,
21-
'require-param': requireParam,
22-
'require-param-description': requireParamDescription,
23-
'require-param-type': requireParamType,
24-
'require-returns-description': requireReturnsDescription,
25-
'require-returns-type': requireReturnsType
26-
},
27-
rulesConfig: {
28-
'check-param-names': 0,
29-
'check-tag-names': 0,
30-
'check-types': 0,
31-
'newline-after-description': 0,
32-
'require-description-complete-sentence': 0,
33-
'require-hyphen-before-param-description': 0,
34-
'require-param': 0,
35-
'require-param-description': 0,
36-
'require-param-type': 0,
37-
'require-returns-description': 0,
38-
'require-returns-type': 0
39-
}
14+
rules: {
15+
'check-param-names': checkParamNames,
16+
'check-tag-names': checkTagNames,
17+
'check-types': checkTypes,
18+
'newline-after-description': newlineAfterDescription,
19+
'require-description-complete-sentence': requireDescriptionCompleteSentence,
20+
'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,
21+
'require-param': requireParam,
22+
'require-param-description': requireParamDescription,
23+
'require-param-type': requireParamType,
24+
'require-returns-description': requireReturnsDescription,
25+
'require-returns-type': requireReturnsType
26+
},
27+
rulesConfig: {
28+
'check-param-names': 0,
29+
'check-tag-names': 0,
30+
'check-types': 0,
31+
'newline-after-description': 0,
32+
'require-description-complete-sentence': 0,
33+
'require-hyphen-before-param-description': 0,
34+
'require-param': 0,
35+
'require-param-description': 0,
36+
'require-param-type': 0,
37+
'require-returns-description': 0,
38+
'require-returns-type': 0
39+
}
4040
};

‎src/iterateJsdoc.js

Lines changed: 66 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -3,83 +3,84 @@ import commentParser from 'comment-parser';
33
import jsdocUtils from './jsdocUtils';
44

55
const curryUtils = (functionNode, jsdoc, tagNamePreference, additionalTagNames) => {
6-
const utils = {};
6+
const utils = {};
77

8-
utils.getFunctionParameterNames = () => {
9-
return jsdocUtils.getFunctionParameterNames(functionNode);
10-
};
8+
utils.getFunctionParameterNames = () => {
9+
return jsdocUtils.getFunctionParameterNames(functionNode);
10+
};
1111

12-
utils.getJsdocParameterNamesDeep = () => {
13-
return jsdocUtils.getJsdocParameterNamesDeep(jsdoc, utils.getPreferredTagName('param'));
14-
};
12+
utils.getJsdocParameterNamesDeep = () => {
13+
return jsdocUtils.getJsdocParameterNamesDeep(jsdoc, utils.getPreferredTagName('param'));
14+
};
1515

16-
utils.getJsdocParameterNames = () => {
17-
return jsdocUtils.getJsdocParameterNames(jsdoc, utils.getPreferredTagName('param'));
18-
};
16+
utils.getJsdocParameterNames = () => {
17+
return jsdocUtils.getJsdocParameterNames(jsdoc, utils.getPreferredTagName('param'));
18+
};
1919

20-
utils.getPreferredTagName = (name) => {
21-
return jsdocUtils.getPreferredTagName(name, tagNamePreference);
22-
};
20+
utils.getPreferredTagName = (name) => {
21+
return jsdocUtils.getPreferredTagName(name, tagNamePreference);
22+
};
2323

24-
utils.isValidTag = (name) => {
25-
return jsdocUtils.isValidTag(name, additionalTagNames);
26-
};
27-
28-
utils.hasTag = (name) => {
29-
return jsdocUtils.hasTag(jsdoc, name);
30-
};
24+
utils.isValidTag = (name) => {
25+
return jsdocUtils.isValidTag(name, additionalTagNames);
26+
};
3127

32-
return utils;
28+
utils.hasTag = (name) => {
29+
return jsdocUtils.hasTag(jsdoc, name);
30+
};
31+
32+
return utils;
3333
};
3434

3535
export default (iterator) => {
36-
return (context) => {
37-
const sourceCode = context.getSourceCode();
38-
const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
39-
const additionalTagNames = _.get(context, 'settings.jsdoc.additionalTagNames') || {};
36+
return (context) => {
37+
const sourceCode = context.getSourceCode();
38+
const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
39+
const additionalTagNames = _.get(context, 'settings.jsdoc.additionalTagNames') || {};
4040

41-
const checkJsdoc = (functionNode) => {
42-
const jsdocNode = sourceCode.getJSDocComment(functionNode);
41+
const checkJsdoc = (functionNode) => {
42+
const jsdocNode = sourceCode.getJSDocComment(functionNode);
4343

44-
if (!jsdocNode) {
45-
return;
46-
}
44+
if (!jsdocNode) {
45+
return;
46+
}
4747

48-
const jsdoc = commentParser('/*' + jsdocNode.value + '*/', {
48+
const jsdoc = commentParser('/*' + jsdocNode.value + '*/', {
4949
// @see https://github.com/yavorskiy/comment-parser/issues/21
50-
parsers: [
51-
commentParser.PARSERS.parse_tag,
52-
commentParser.PARSERS.parse_type,
53-
(str, data) => {
54-
if (_.includes(['return', 'returns'], data.tag)) {
55-
return null;
56-
}
57-
return commentParser.PARSERS.parse_name(str, data);
58-
},
59-
commentParser.PARSERS.parse_description
60-
]
61-
})[0] || {};
62-
63-
const report = (message) => {
64-
context.report(jsdocNode, message);
65-
};
66-
67-
const utils = curryUtils(functionNode, jsdoc, tagNamePreference, additionalTagNames);
68-
69-
iterator({
70-
context,
71-
functionNode,
72-
jsdoc,
73-
jsdocNode,
74-
report,
75-
utils
76-
});
77-
};
78-
79-
return {
80-
ArrowFunctionExpression: checkJsdoc,
81-
FunctionDeclaration: checkJsdoc,
82-
FunctionExpression: checkJsdoc
83-
};
50+
parsers: [
51+
commentParser.PARSERS.parse_tag,
52+
commentParser.PARSERS.parse_type,
53+
(str, data) => {
54+
if (_.includes(['return', 'returns'], data.tag)) {
55+
return null;
56+
}
57+
58+
return commentParser.PARSERS.parse_name(str, data);
59+
},
60+
commentParser.PARSERS.parse_description
61+
]
62+
})[0] || {};
63+
64+
const report = (message) => {
65+
context.report(jsdocNode, message);
66+
};
67+
68+
const utils = curryUtils(functionNode, jsdoc, tagNamePreference, additionalTagNames);
69+
70+
iterator({
71+
context,
72+
functionNode,
73+
jsdoc,
74+
jsdocNode,
75+
report,
76+
utils
77+
});
78+
};
79+
80+
return {
81+
ArrowFunctionExpression: checkJsdoc,
82+
FunctionDeclaration: checkJsdoc,
83+
FunctionExpression: checkJsdoc
8484
};
85+
};
8586
};

‎src/jsdocUtils.js

Lines changed: 52 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,90 +2,91 @@ import _ from 'lodash';
22
import tagNames from './tagNames';
33

44
const getFunctionParameterNames = (functionNode : Object) : Array<string> => {
5-
return _.map(functionNode.params, (param) => {
6-
if (_.has(param, 'name')) {
7-
return param.name;
8-
}
5+
return _.map(functionNode.params, (param) => {
6+
if (_.has(param, 'name')) {
7+
return param.name;
8+
}
99

10-
if (_.has(param, 'left.name')) {
11-
return param.left.name;
12-
}
10+
if (_.has(param, 'left.name')) {
11+
return param.left.name;
12+
}
1313

14-
if (param.type === 'ObjectPattern') {
15-
return '<ObjectPattern>';
16-
}
14+
if (param.type === 'ObjectPattern') {
15+
return '<ObjectPattern>';
16+
}
1717

18-
if (param.type === 'RestElement') {
19-
return param.argument.name;
20-
}
18+
if (param.type === 'RestElement') {
19+
return param.argument.name;
20+
}
2121

22-
throw new Error('Unsupported function signature format.');
23-
});
22+
throw new Error('Unsupported function signature format.');
23+
});
2424
};
2525

2626
/**
2727
* Gets all parameter names, including those that refer to a path, e.g. "@param foo; @param foo.bar".
2828
*/
2929
const getJsdocParameterNamesDeep = (jsdoc : Object, targetTagName : string) : Array<string> => {
30-
let jsdocParameterNames;
30+
let jsdocParameterNames;
3131

32-
jsdocParameterNames = _.filter(jsdoc.tags, {
33-
tag: targetTagName
34-
});
32+
jsdocParameterNames = _.filter(jsdoc.tags, {
33+
tag: targetTagName
34+
});
3535

36-
jsdocParameterNames = _.map(jsdocParameterNames, 'name');
36+
jsdocParameterNames = _.map(jsdocParameterNames, 'name');
3737

38-
return jsdocParameterNames;
38+
return jsdocParameterNames;
3939
};
4040

4141
const getJsdocParameterNames = (jsdoc : Object, targetTagName : string) : Array<string> => {
42-
let jsdocParameterNames;
42+
let jsdocParameterNames;
4343

44-
jsdocParameterNames = getJsdocParameterNamesDeep(jsdoc, targetTagName);
44+
jsdocParameterNames = getJsdocParameterNamesDeep(jsdoc, targetTagName);
4545

46-
jsdocParameterNames = _.filter(jsdocParameterNames, (name) => {
47-
return name.indexOf('.') === -1;
48-
});
46+
jsdocParameterNames = _.filter(jsdocParameterNames, (name) => {
47+
return name.indexOf('.') === -1;
48+
});
4949

50-
return jsdocParameterNames;
50+
return jsdocParameterNames;
5151
};
5252

5353
const getPreferredTagName = (name : string, tagPreference : Object = {}) : string => {
54-
if (_.includes(_.values(tagPreference), name)) {
55-
return name;
56-
}
54+
if (_.includes(_.values(tagPreference), name)) {
55+
return name;
56+
}
5757

58-
const preferredTagName = _.findKey(tagNames, (aliases) => {
59-
return _.includes(aliases, name);
60-
});
58+
const preferredTagName = _.findKey(tagNames, (aliases) => {
59+
return _.includes(aliases, name);
60+
});
6161

62-
if (preferredTagName) {
63-
return preferredTagName;
64-
}
62+
if (preferredTagName) {
63+
return preferredTagName;
64+
}
6565

66-
return _.has(tagPreference, name) ? tagPreference[name] : name;
66+
return _.has(tagPreference, name) ? tagPreference[name] : name;
6767
};
6868

6969
const isValidTag = (name : string, additionalTagNames : Object) : boolean => {
70-
const validTagNames = _.keys(tagNames).concat(_.flatten(_.values(tagNames)));
71-
const additionalTags = additionalTagNames.customTags || [];
72-
const allTags = validTagNames.concat(additionalTags);
70+
const validTagNames = _.keys(tagNames).concat(_.flatten(_.values(tagNames)));
71+
const additionalTags = additionalTagNames.customTags || [];
72+
const allTags = validTagNames.concat(additionalTags);
7373

74-
return _.includes(allTags, name);
74+
return _.includes(allTags, name);
7575
};
7676

7777
const hasTag = (jsdoc : Object, targetTagName : string) : boolean => {
78-
const targetTagLower = targetTagName.toLowerCase();
79-
return _.some(jsdoc.tags, (doc : Object) => {
80-
return doc.tag.toLowerCase() == targetTagLower;
81-
});
78+
const targetTagLower = targetTagName.toLowerCase();
79+
80+
return _.some(jsdoc.tags, (doc : Object) => {
81+
return doc.tag.toLowerCase() === targetTagLower;
82+
});
8283
};
8384

8485
export default {
85-
getFunctionParameterNames,
86-
getJsdocParameterNames,
87-
getJsdocParameterNamesDeep,
88-
getPreferredTagName,
89-
isValidTag,
90-
hasTag
86+
getFunctionParameterNames,
87+
getJsdocParameterNames,
88+
getJsdocParameterNamesDeep,
89+
getPreferredTagName,
90+
hasTag,
91+
isValidTag
9192
};

0 commit comments

Comments
 (0)