/
no-mergeable-selectors.js
190 lines (177 loc) · 5.45 KB
/
no-mergeable-selectors.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
'use strict';
var helpers = require('../helpers'),
selectorHelpers = require('../selector-helpers');
var mergeableNodes = ['atrule', 'include', 'ruleset'],
validAtRules = ['media'],
curLevel = 0,
curSelector = [],
parentSelector = [],
selectorList = [],
syntax = '';
/**
* Traverses a block and calls our callback function for each block encountered
*
* @param {object} block - The current node / part of our selector
* @param {object} cb - The callback function we wish to apply to each block
* @returns {undefined}
*/
var traverseBlock = function (block, cb) {
block.forEach(function (contentItem) {
cb(contentItem);
});
};
/**
* Traverses a block and calls our callback function for each block encountered
*
* @param {string} ruleSet - The current selector
* @param {boolean} isAtRule - Whether the ruleSet is an atRule
* @param {string} line - The line that the ruleset starts
* @param {string} col - The column that the ruleset starts
* @returns {undefined}
*/
var updateList = function (ruleSet, isAtRule, line, col) {
parentSelector[curLevel] = ruleSet;
curSelector = {
selector: helpers.stripLastSpace(parentSelector.join('')),
line: line,
column: col
};
if (!isAtRule) {
selectorList.push(curSelector);
}
};
/**
* Checks a rulesets contents for selectors and calls our consstructSelector method
*
* @param {object} ruleNode - The current node / part of our selector
* @returns {undefined}
*/
var checkRuleset = function (ruleNode) {
var ruleSet = '';
ruleNode.forEach(function (ruleNodeItem) {
if (!ruleNodeItem.is('block')) {
if (ruleNodeItem.is('selector')) {
ruleNodeItem.forEach(function (selectorContent) {
ruleSet += selectorHelpers.constructSelector(selectorContent);
});
}
else if (ruleNodeItem.is('delimiter') || ruleNodeItem.is('space')) {
ruleSet += selectorHelpers.constructSelector(ruleNodeItem);
}
}
});
if (ruleSet !== '') {
updateList(ruleSet, false, ruleNode.start.line, ruleNode.start.column);
}
};
/**
* Checks an atRule contents for selectors and calls our consstructSelector method
*
* @param {object} atRule - The current node / atRule part of our selector
* @returns {undefined}
*/
var checkAtRule = function (atRule) {
var test = '';
atRule.forEach(function (atRuleItem) {
if (!atRuleItem.is('block')) {
test += selectorHelpers.constructSelector(atRuleItem);
}
});
updateList(test, true, atRule.start.line, atRule.start.column);
};
/**
* Checks an atRule to see if if it's part of our mergeable at rule list.
* It also checks for Sass syntax as gonzales currently has issues with the syntax
*
* @param {object} node - The current node / atRule part of our selector
* @returns {boolean} Whether this atRule should be merged or not
*/
var isMergeableAtRule = function (node) {
var isMergeable = false;
node.forEach(function (item) {
// TODO Check back when Gonzales updates to fix this
// Gonzales has issues with nest levels in media queries :(
if (item.is('atkeyword') && validAtRules.indexOf(item.first('ident').content) !== -1 && syntax !== 'sass') {
isMergeable = true;
}
});
return isMergeable;
};
/**
* Checks if a node contains a block and if so calls our traverseBlock method. Also
* handles our current level counter.
*
* @param {object} node - The current node / atRule part of our selector
* @param {object} cb - The callback function we wish to pass through
* @returns {undefined}
*/
var checkForBlock = function (node, cb) {
if (node.contains('block')) {
curLevel += 1;
node.forEach('block', function (block) {
traverseBlock(block.content, cb);
});
curLevel -= 1;
parentSelector.pop();
}
};
/**
* Traverses a node and checks for rulesets and at rules and then fires off to the
* respective method for them to be handled
*
* @param {object} node - The current node / atRule part of our selector
* @returns {undefined}
*/
var traverseNode = function (node) {
if (mergeableNodes.indexOf(node.type) !== -1) {
if (node.is('ruleset')) {
checkRuleset(node);
checkForBlock(node, traverseNode);
}
else if (node.is('atrule')) {
if (isMergeableAtRule(node)) {
checkAtRule(node);
checkForBlock(node, traverseNode);
}
}
}
};
/**
* Checks our selector list for mergeable selectors and reports errors where needed
*
* @param {object} parser - The parser object
* @returns {array} Array of result objects
*/
var checkMergeable = function (parser) {
var result = [];
selectorList.forEach(function (item, index, arr) {
var pos = helpers.propertySearch(arr, item.selector, 'selector');
if (pos !== index && parser.options.whitelist.indexOf(item.selector) === -1) {
result = helpers.addUnique(result, {
'ruleId': parser.rule.name,
'line': item.line,
'column': item.column,
'message': 'Rule `' + item.selector + '` should be merged with the rule on line ' + selectorList[pos].line,
'severity': parser.severity
});
}
});
return result;
};
module.exports = {
'name': 'no-mergeable-selectors',
'defaults': {
'whitelist': []
},
'detect': function (ast, parser) {
curLevel = 0;
curSelector = [];
parentSelector = [];
selectorList = [];
syntax = ast.syntax;
ast.traverseByType('stylesheet', function (styleSheet) {
traverseBlock(styleSheet, traverseNode);
});
return checkMergeable(parser);
}
};