| 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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286 |
1×
1×
1×
91×
1×
1×
2×
2×
2×
88×
2×
91×
91×
218×
4×
214×
9476×
142×
142×
142×
269×
142×
60×
60×
10×
50×
50×
15×
15×
15×
660×
234×
15×
35×
35×
35×
35×
142×
103×
103×
2073×
14787×
14787×
14787×
2073×
103×
103×
103×
2486×
2821×
2821×
2821×
2486×
2486×
103×
39×
1726×
468×
342×
342×
342×
468×
468×
39×
1×
1×
| /**
* @file operation of rules
* @author nighca<nighca@live.cn>
*/
var util = require('./util');
var rules = [];
/**
* class Rule
*
* @constructor
* @param {Object} rule - config info for rule
*/
var Rule = function (rule) {
util.extend(this, rule);
};
/**
* Target of rule: "document" / "parser".
* @type {string}
*/
Rule.prototype.target = 'document';
var rulesManager = {
/**
* Init rules.
*
* @return {Object} rules export
*/
init: function () {
var self = this;
rules = [];
// pre-set rules
[
require('./rules/asset-type'),
require('./rules/attr-lowercase'),
require('./rules/attr-no-duplication'),
require('./rules/attr-value-double-quotes'),
require('./rules/bool-attribute-value'),
require('./rules/button-name'),
require('./rules/button-type'),
require('./rules/charset'),
require('./rules/css-in-head'),
require('./rules/doctype'),
require('./rules/html-lang'),
require('./rules/id-class-ad-disabled'),
require('./rules/ie-edge'),
require('./rules/img-alt'),
require('./rules/img-src'),
require('./rules/img-title'),
require('./rules/img-width-height'),
require('./rules/indent-char'),
require('./rules/lowercase-class-with-hyphen'),
require('./rules/lowercase-id-with-hyphen'),
require('./rules/nest'),
require('./rules/rel-stylesheet'),
require('./rules/script-content'),
require('./rules/script-in-tail'),
require('./rules/self-close'),
require('./rules/spec-char-escape'),
require('./rules/style-content'),
require('./rules/style-disabled'),
require('./rules/tag-pair'),
require('./rules/tagname-lowercase'),
require('./rules/title-required'),
require('./rules/unique-id'),
require('./rules/no-duplication-id-and-name'),
require('./rules/viewport'),
require('./rules/label-for-input'),
require('./rules/no-meta-css'),
require('./rules/no-hook-class'),
require('./rules/max-len'),
require('./rules/no-bom'),
require('./rules/no-space-before-tag-end'),
require('./rules/protocol-omitted-in-href'),
require('./rules/new-line-for-blocks'),
require('./rules/multiple-stylesheets'),
require('./rules/unnecessary-whitespace-in-text')
].forEach(function (rule) {
self.add(rule);
});
return this;
},
/**
* Add a rule.
*
* @param {Object} rule - rule to add
* @return {number} current rules num
*/
add: function (rule) {
rule = new Rule(rule);
return rules.push(rule);
},
/**
* Get list of rule for given target.
*
* @param {string=} target - given target ("document" / "parser")
* @return {Array} rule list
*/
list: function (target) {
if (!target) {
return rules.slice();
}
return rules.filter(function (rule) {
return rule.target === target;
});
},
/**
* Collect inline-config info during parse.
*
* @param {Parser} parser - the HTML parser, instance of htmlparser2.Parser
* @return {Object} inline-config info, including reporter config & rules config
*/
collectInlineCfg: function (parser) {
var rulesCfg = {};
var reporterCfg = {};
var collect = function (ruleName, content, target) {
(target[ruleName] = target[ruleName] || []).push({
index: parser.startIndex,
content: content
});
};
parser.on('comment', function (comment) {
var commentInfo = util.extractCommentInfo(comment);
// if no valid info
if (!commentInfo) {
return;
}
var operation = commentInfo.operation;
switch (operation) {
case 'enable':
case 'disable':
var targets = commentInfo.content;
var targetAll = !targets;
rules.forEach(function (rule) {
if (targetAll || targets.indexOf(rule.name) >= 0) {
collect(rule.name, operation, reporterCfg);
}
});
break;
case 'config':
var cfg = commentInfo.content;
for (var ruleName in cfg) {
Eif (cfg.hasOwnProperty(ruleName)) {
collect(ruleName, cfg[ruleName], rulesCfg);
}
}
default:
}
});
return {
rules: rulesCfg,
reporter: reporterCfg
};
},
/**
* Do lint parser.
*
* @param {Parser} parser - the HTML parser, instance of htmlparser2.Parser
* @param {Reporter} reporter - the reporter
* @param {Object} cfg - config
* @param {Object} inlineCfg - inline config
* @param {string} code - target code
* @return {Object} rules export
*/
lintParser: function (parser, reporter, cfg, inlineCfg, code) {
cfg = util.extend({}, cfg);
// lint parser
this.list('parser').forEach(function (rule) {
var getCfg = function (index, ruleName) {
index = index == null ? parser.startIndex : index;
ruleName = ruleName == null ? rule.name : ruleName;
return util.getCfgByIndex(ruleName, index, inlineCfg, cfg);
};
rule.lint(
getCfg,
parser,
reporter.bindRule(rule.name),
code
);
});
return this;
},
/**
* Do lint document.
*
* @param {Node} document - the document node
* @param {Reporter} reporter - the reporter
* @param {Object} cfg - config
* @param {Object} inlineCfg - inline config
* @param {string} code - target code
* @return {Object} rules export
*/
lintDocument: function (document, reporter, cfg, inlineCfg, code) {
cfg = util.extend({}, cfg);
// lint document
this.list('document').forEach(function (rule) {
var getCfg = function (index, ruleName) {
index = index == null ? -1 : (index.startIndex || index);
ruleName = ruleName == null ? rule.name : ruleName;
return util.getCfgByIndex(ruleName, index, inlineCfg, cfg);
};
try {
rule.lint(
getCfg,
document,
reporter.bindRule(rule.name),
code
);
}
catch (e) {}
});
return this;
},
/**
* Do format document.
*
* @param {Node} document - the document node
* @param {Object} cfg - config
* @param {Object} inlineCfg - inline config
* @param {Object} options - options for format
* @return {Object} rules export
*/
format: function (document, cfg, inlineCfg, options) {
// format document
rules.forEach(function (rule) {
if (rule.format) {
var getCfg = function (index, ruleName) {
index = index == null ? -1 : (index.startIndex || index);
ruleName = ruleName == null ? rule.name : ruleName;
return util.getCfgByIndex(ruleName, index, inlineCfg, cfg);
};
try {
rule.format(
getCfg,
document,
options
);
}
catch (e) {
console.warn('Error:', e.stack || e);
}
}
});
return this;
}
};
rulesManager.init();
module.exports = rulesManager;
|