Skip to content

Commit ab11855

Browse files
mdevilsmdevils
committed
[Fix] Linting fixes
1 parent bebd40f commit ab11855

File tree

7 files changed

+123
-113
lines changed

7 files changed

+123
-113
lines changed

‎lib/jsdoc.js

Lines changed: 83 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -363,94 +363,94 @@ function _iterateDocTypes(node, cb) {
363363
var res;
364364

365365
switch (true) {
366-
case node instanceof TypeBuilder.TypeUnion:
367-
// optional: boolean,
368-
// nullable: boolean,
369-
// variable: boolean,
370-
// nonNullable: boolean,
371-
// all: boolean,
372-
// unknown: boolean,
373-
// types: Array.<TypeName|GenericType|FunctionType|RecordType>
374-
res = node.types.map(function(subnode) {
375-
if (node.collectionNode) {
376-
subnode.parentElement = node.collectionNode;
366+
case node instanceof TypeBuilder.TypeUnion:
367+
// optional: boolean,
368+
// nullable: boolean,
369+
// variable: boolean,
370+
// nonNullable: boolean,
371+
// all: boolean,
372+
// unknown: boolean,
373+
// types: Array.<TypeName|GenericType|FunctionType|RecordType>
374+
res = node.types.map(function(subnode) {
375+
if (node.collectionNode) {
376+
subnode.parentElement = node.collectionNode;
377+
}
378+
return _iterateDocTypes(subnode, cb);
379+
}) || [];
380+
if (node.nullable) {
381+
var subnode = {typeName: 'null', collectionNode: node};
382+
res.concat(cb(subnode));
377383
}
378-
return _iterateDocTypes(subnode, cb);
379-
}) || [];
380-
if (node.nullable) {
381-
var subnode = {typeName: 'null', collectionNode: node};
382-
res.concat(cb(subnode));
383-
}
384-
break;
385-
386-
case node instanceof TypeBuilder.TypeName:
387-
// name: string
388-
node.typeName = node.name;
389-
res = cb(node);
390-
break;
391-
392-
case node instanceof TypeBuilder.GenericType:
393-
// genericTypeName: string,
394-
// parameterTypeUnions: Array.<TypeUnion>
395-
node.typeName = node.genericTypeName.type;
396-
res = cb(node) || [];
397-
if (node.parameterTypeUnions) {
398-
// node.parameterTypeUnions.collectionNode = node;
384+
break;
385+
386+
case node instanceof TypeBuilder.TypeName:
387+
// name: string
388+
node.typeName = node.name;
389+
res = cb(node);
390+
break;
391+
392+
case node instanceof TypeBuilder.GenericType:
393+
// genericTypeName: string,
394+
// parameterTypeUnions: Array.<TypeUnion>
395+
node.typeName = node.genericTypeName.type;
396+
res = cb(node) || [];
397+
if (node.parameterTypeUnions) {
398+
// node.parameterTypeUnions.collectionNode = node;
399+
res.concat(node.parameterTypeUnions.map(function(subnode) {
400+
subnode.parentElement = node;
401+
_iterateDocTypes(subnode, cb);
402+
}));
403+
}
404+
break;
405+
406+
case node instanceof TypeBuilder.FunctionType:
407+
// parameterTypeUnions: Array.<TypeUnion>,
408+
// returnTypeUnion: TypeUnion|null,
409+
// isConstructor: boolean,
410+
// contextTypeUnion: TypeUnion|null
411+
node.typeName = 'Function';
412+
res = cb(node) || [];
399413
res.concat(node.parameterTypeUnions.map(function(subnode) {
400414
subnode.parentElement = node;
401415
_iterateDocTypes(subnode, cb);
402416
}));
403-
}
404-
break;
405-
406-
case node instanceof TypeBuilder.FunctionType:
407-
// parameterTypeUnions: Array.<TypeUnion>,
408-
// returnTypeUnion: TypeUnion|null,
409-
// isConstructor: boolean,
410-
// contextTypeUnion: TypeUnion|null
411-
node.typeName = 'Function';
412-
res = cb(node) || [];
413-
res.concat(node.parameterTypeUnions.map(function(subnode) {
414-
subnode.parentElement = node;
415-
_iterateDocTypes(subnode, cb);
416-
}));
417-
if (node.returnTypeUnion) {
418-
node.returnTypeUnion.collectionNode = node;
419-
res.concat(_iterateDocTypes(node.returnTypeUnion, cb));
420-
}
421-
if (node.contextTypeUnion) {
422-
node.contextTypeUnion.collectionNode = node;
423-
res.concat(_iterateDocTypes(node.contextTypeUnion, cb));
424-
}
425-
break;
426-
427-
case node instanceof TypeBuilder.RecordType:
428-
// entries: Array.<RecordEntry>
429-
node.typeName = 'Object';
430-
res = cb(node) || [];
431-
if (node.entries) {
432-
res.concat(node.entries.map(function(subnode) {
433-
subnode.parentElement = node;
434-
_iterateDocTypes(subnode, cb);
435-
}));
436-
}
437-
break;
438-
439-
case node instanceof TypeBuilder.RecordType.Entry:
440-
// name: string,
441-
// typeUnion: TypeUnion
442-
node.typeUnion.collectionNode = node;
443-
res = _iterateDocTypes(node.typeUnion, cb);
444-
break;
445-
446-
case node instanceof TypeBuilder.ModuleName:
447-
node.typeName = node.name;
448-
node.module = true;
449-
res = cb(node);
450-
break;
451-
452-
default:
453-
throw new Error('DocType: Unsupported doc node');
417+
if (node.returnTypeUnion) {
418+
node.returnTypeUnion.collectionNode = node;
419+
res.concat(_iterateDocTypes(node.returnTypeUnion, cb));
420+
}
421+
if (node.contextTypeUnion) {
422+
node.contextTypeUnion.collectionNode = node;
423+
res.concat(_iterateDocTypes(node.contextTypeUnion, cb));
424+
}
425+
break;
426+
427+
case node instanceof TypeBuilder.RecordType:
428+
// entries: Array.<RecordEntry>
429+
node.typeName = 'Object';
430+
res = cb(node) || [];
431+
if (node.entries) {
432+
res.concat(node.entries.map(function(subnode) {
433+
subnode.parentElement = node;
434+
_iterateDocTypes(subnode, cb);
435+
}));
436+
}
437+
break;
438+
439+
case node instanceof TypeBuilder.RecordType.Entry:
440+
// name: string,
441+
// typeUnion: TypeUnion
442+
node.typeUnion.collectionNode = node;
443+
res = _iterateDocTypes(node.typeUnion, cb);
444+
break;
445+
446+
case node instanceof TypeBuilder.ModuleName:
447+
node.typeName = node.name;
448+
node.module = true;
449+
res = cb(node);
450+
break;
451+
452+
default:
453+
throw new Error('DocType: Unsupported doc node');
454454
}
455455

456456
return res;

‎lib/rules/validate-jsdoc/check-redundant-access.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,18 @@ function checkRedundantAccess(node, err) {
4242
var name;
4343
var nodeToReport;
4444
switch (node.parentElement.type) {
45-
case 'VariableDeclarator':
46-
name = node.parentElement.id.name;
47-
nodeToReport = node.parentElement.id;
48-
break;
49-
case 'ObjectProperty':
50-
name = node.parentElement.key.name;
51-
nodeToReport = node.parentElement.key;
52-
break;
53-
default: // try to use func name itself (if not anonymous)
54-
name = (node.id || {}).name;
55-
nodeToReport = node.id || node;
56-
break;
45+
case 'VariableDeclarator':
46+
name = node.parentElement.id.name;
47+
nodeToReport = node.parentElement.id;
48+
break;
49+
case 'ObjectProperty':
50+
name = node.parentElement.key.name;
51+
nodeToReport = node.parentElement.key;
52+
break;
53+
default: // try to use func name itself (if not anonymous)
54+
name = (node.id || {}).name;
55+
nodeToReport = node.id || node;
56+
break;
5757
}
5858

5959
// skip anonymous and names without underscores at begin

‎lib/rules/validate-jsdoc/disallow-newline-after-description.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports.options = {
55
};
66

77
var RE_NEWLINE_AT_THE_END = /\n$/;
8-
var RE_NEWLINES = /\n/g;
98

109
/**
1110
* Disallows newline after description in jsdoc comment

‎lib/rules/validate-jsdoc/leading-underscore-access.js

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,20 @@ function validateLeadingUnderscoresAccess(node, err) {
4646
// fetch name from variable, property or function
4747
var name;
4848
var nodeToReport;
49+
4950
switch (node.parentElement.type) {
50-
case 'VariableDeclarator':
51-
name = node.parentElement.id.name;
52-
nodeToReport = node.parentElement.id;
53-
break;
54-
case 'ObjectProperty':
55-
name = node.parentElement.key.name;
56-
nodeToReport = node.parentElement.key;
57-
break;
58-
default: // try to use func name itself (if not anonymous)
59-
name = (node.id || {}).name;
60-
nodeToReport = node.id || node;
61-
break;
51+
case 'VariableDeclarator':
52+
name = node.parentElement.id.name;
53+
nodeToReport = node.parentElement.id;
54+
break;
55+
case 'ObjectProperty':
56+
name = node.parentElement.key.name;
57+
nodeToReport = node.parentElement.key;
58+
break;
59+
default: // try to use func name itself (if not anonymous)
60+
name = (node.id || {}).name;
61+
nodeToReport = node.id || node;
62+
break;
6263
}
6364

6465
if (nativeUnderscoredProperties.indexOf(name) !== -1) {

‎lib/rules/validate-jsdoc/require-newline-after-description.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports.options = {
55
};
66

77
var RE_NEWLINE_AT_THE_END = /\n$/;
8-
var RE_NEWLINES = /\n/g;
98

109
/**
1110
* Requires newline after description in jsdoc comment
@@ -20,8 +19,6 @@ function requireNewlineAfterDescription(node, err) {
2019
}
2120

2221
if (!RE_NEWLINE_AT_THE_END.test(doc.description)) {
23-
var loc = node.jsdoc.loc.start;
24-
var lines = doc.description.split(RE_NEWLINES);
2522
err('Newline required after description', doc.description.length + 1);
2623
}
2724
}

‎lib/utils.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
var lineBreakRegexGlobal = /\r\n|\r|\n/g;
22

3+
/**
4+
* @param {Element} node
5+
* @returns {number}
6+
*/
37
exports.getNodeColumn = function(node) {
48
var currentToken = node.getFirstToken().getPreviousToken();
59
var indentationLevel = 0;
@@ -17,6 +21,10 @@ exports.getNodeColumn = function(node) {
1721
return indentationLevel;
1822
};
1923

24+
/**
25+
* @param {string} code
26+
* @returns {Array}
27+
*/
2028
exports.getLineInfo = function(code) {
2129
var lines = [];
2230
lineBreakRegexGlobal.lastIndex = 0;
@@ -34,6 +42,11 @@ exports.getLineInfo = function(code) {
3442
return lines;
3543
};
3644

45+
/**
46+
* @param {Element} tokenBefore
47+
* @param {Element} tokenAfter
48+
* @returns {number}
49+
*/
3750
exports.getLineCountBetween = function(tokenBefore, tokenAfter) {
3851
if (tokenBefore === tokenAfter) {
3952
return 0;

‎test/lib/rules/validate-jsdoc/require-newline-after-description.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ describe('lib/rules/validate-jsdoc/require-newline-after-description', function
5353
}
5454
},
5555
errors: {
56-
line: 1,
57-
column: 0
56+
line: 2,
57+
column: 13
5858
},
5959
}, {
6060
it: 'should not report newline after description',

0 commit comments

Comments
 (0)