Skip to content

Commit

Permalink
feat(htmlhint): add new rule for whitespace in attributes (#310) (#322)
Browse files Browse the repository at this point in the history 
* 0.10.3

* feat(htmlhint): add new rule for whitespace in attributes (#310)

* fix(htmlhint): removed unnecessary code (#310)

* 0.11.0

* Revert "Merge branch 'develop' into attr-whitespace"

This reverts commit 35988c1, reversing
changes made to 981cca7.

* Revert "Revert "Merge branch 'develop' into attr-whitespace""

This reverts commit cfa794d.

* chore(htmlhint): rebuilt package.json

* chore(htmlhint): updated rule to use ES6

* 0.10.3

* 0.11.0

* fix(htmlhint): made change to test cases and index.js
  • Loading branch information
@thedaviddias
Daman Mulye authored and thedaviddias committed Feb 1, 2020
1 parent 6ccb453 commit 5480149
Show file tree
Hide file tree
Showing 37 changed files with 7,249 additions and 5,612 deletions.
1,323 changes: 1,322 additions & 1 deletion dist/htmlhint.js
View file

Large diffs are not rendered by default.

9,458 changes: 4,740 additions & 4,718 deletions package-lock.json
View file

Large diffs are not rendered by default.

253 changes: 137 additions & 116 deletions src/core.js
View file
@@ -1,129 +1,150 @@
import HTMLParser from './htmlparser'
import Reporter from './reporter'
import * as HTMLRules from './rules'
import HTMLParser from './htmlparser';
import Reporter from './reporter';
import * as HTMLRules from './rules';
class HTMLHint {
constructor () {
this.rules = {}
this.defaultRuleset = {
'tagname-lowercase': true,
'attr-lowercase': true,
'attr-value-double-quotes': true,
'doctype-first': true,
'tag-pair': true,
'spec-char-escape': true,
'id-unique': true,
'src-not-empty': true,
'attr-no-duplication': true,
'title-require': true
}
}
addRule (rule) {
this.rules[rule.id] = rule
constructor() {
this.rules = {};
this.defaultRuleset = {
'tagname-lowercase': true,
'attr-lowercase': true,
'attr-value-double-quotes': true,
'doctype-first': true,
'tag-pair': true,
'spec-char-escape': true,
'id-unique': true,
'src-not-empty': true,
'attr-no-duplication': true,
'title-require': true
};
}
addRule(rule) {
this.rules[rule.id] = rule;
}
verify(html, ruleset) {
if (ruleset === undefined || Object.keys(ruleset).length === 0) {
ruleset = this.defaultRuleset;
}
verify (html, ruleset) {

if(ruleset === undefined || Object.keys(ruleset).length ===0){
ruleset = this.defaultRuleset;
// parse inline ruleset
html = html.replace(/^\s*<!--\s*htmlhint\s+([^\r\n]+?)\s*-->/i, function(
all,
strRuleset
) {
if (ruleset === undefined) {
ruleset = {};
}
strRuleset.replace(/(?:^|,)\s*([^:,]+)\s*(?:\:\s*([^,\s]+))?/g, function(
all,
key,
value
) {
if (value === 'false') {
value = false;
} else if (value === 'true') {
value = true;
}
ruleset[key] = value === undefined ? true : value;
});
return '';
});

// parse inline ruleset
html = html.replace(/^\s*<!--\s*htmlhint\s+([^\r\n]+?)\s*-->/i, function(all, strRuleset){
if(ruleset === undefined){
ruleset = {};
}
strRuleset.replace(/(?:^|,)\s*([^:,]+)\s*(?:\:\s*([^,\s]+))?/g, function(all, key, value){
if(value === 'false'){
value = false;
}
else if(value === 'true'){
value = true;
}
ruleset[key] = value === undefined ? true : value;
});
return '';
});

var parser = new HTMLParser();
var reporter = new Reporter(html, ruleset);
var parser = new HTMLParser();
var reporter = new Reporter(html, ruleset);

var rules = this.rules,
rule;
for (var id in ruleset){
rule = rules[id];
if (rule !== undefined && ruleset[id] !== false){
rule.init(parser, reporter, ruleset[id]);
}
}
var rules = this.rules,
rule;
for (var id in ruleset) {
rule = rules[id];
if (rule !== undefined && ruleset[id] !== false) {
rule.init(parser, reporter, ruleset[id]);
}
}

parser.parse(html);
parser.parse(html);

return reporter.messages;
}
format (arrMessages, options) {
options = options || {};
var arrLogs = [];
var colors = {
white: '',
grey: '',
red: '',
reset: ''
};
if(options.colors){
colors.white = '\x1b[37m';
colors.grey = '\x1b[90m';
colors.red = '\x1b[31m';
colors.reset = '\x1b[39m';
}
var indent = options.indent || 0;
arrMessages.forEach((hint) => {
var leftWindow = 40;
var rightWindow = leftWindow + 20;
var evidence = hint.evidence;
var line = hint.line;
var col = hint.col;
var evidenceCount = evidence.length;
var leftCol = col > leftWindow + 1 ? col - leftWindow : 1;
var rightCol = evidence.length > col + rightWindow ? col + rightWindow : evidenceCount;
if(col < leftWindow + 1){
rightCol += leftWindow - col + 1;
}
evidence = evidence.replace(/\t/g, ' ').substring(leftCol - 1, rightCol);
// add ...
if(leftCol > 1){
evidence = '...' + evidence;
leftCol -= 3;
}
if(rightCol < evidenceCount){
evidence += '...';
}
// show evidence
arrLogs.push(colors.white+repeatStr(indent)+'L'+line+' |' + colors.grey + evidence + colors.reset);
// show pointer & message
var pointCol = col - leftCol;
// add double byte character
var match = evidence.substring(0, pointCol).match(/[^\u0000-\u00ff]/g);
if(match !== null){
pointCol += match.length;
}
arrLogs.push(colors.white+repeatStr(indent)+repeatStr(String(line).length + 3 + pointCol)+'^ ' + colors.red + hint.message + ' (' + hint.rule.id+')' + colors.reset);
});
return arrLogs;
return reporter.messages;
}
format(arrMessages, options) {
options = options || {};
var arrLogs = [];
var colors = {
white: '',
grey: '',
red: '',
reset: ''
};
if (options.colors) {
colors.white = '\x1b[37m';
colors.grey = '\x1b[90m';
colors.red = '\x1b[31m';
colors.reset = '\x1b[39m';
}
var indent = options.indent || 0;
arrMessages.forEach(hint => {
var leftWindow = 40;
var rightWindow = leftWindow + 20;
var evidence = hint.evidence;
var line = hint.line;
var col = hint.col;
var evidenceCount = evidence.length;
var leftCol = col > leftWindow + 1 ? col - leftWindow : 1;
var rightCol =
evidence.length > col + rightWindow ? col + rightWindow : evidenceCount;
if (col < leftWindow + 1) {
rightCol += leftWindow - col + 1;
}
evidence = evidence.replace(/\t/g, ' ').substring(leftCol - 1, rightCol);
// add ...
if (leftCol > 1) {
evidence = '...' + evidence;
leftCol -= 3;
}
if (rightCol < evidenceCount) {
evidence += '...';
}
// show evidence
arrLogs.push(
colors.white +
repeatStr(indent) +
'L' +
line +
' |' +
colors.grey +
evidence +
colors.reset
);
// show pointer & message
var pointCol = col - leftCol;
// add double byte character
var match = evidence.substring(0, pointCol).match(/[^\u0000-\u00ff]/g);
if (match !== null) {
pointCol += match.length;
}
arrLogs.push(
colors.white +
repeatStr(indent) +
repeatStr(String(line).length + 3 + pointCol) +
'^ ' +
colors.red +
hint.message +
' (' +
hint.rule.id +
')' +
colors.reset
);
});
return arrLogs;
}
}

// repeat string
function repeatStr(n, str){
return new Array(n + 1).join(str || ' ');
}
// repeat string
function repeatStr(n, str) {
return new Array(n + 1).join(str || ' ');
}

const hint = new HTMLHint()
const hint = new HTMLHint();
Object.values(HTMLRules).forEach(rule => {
hint.addRule(rule)
})
export default hint
export {
HTMLRules,
Reporter,
HTMLParser,
HTMLHint,
}
hint.addRule(rule);
});
export default hint;
export { HTMLRules, Reporter, HTMLParser, HTMLHint };

0 comments on commit 5480149

Please sign in to comment.