Skip to content

Add "rule" attribute to "lintxml" output format #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2016
+27 −4
Merged

Add "rule" attribute to "lintxml" output format #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/formatters/lint-xml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ CSSLint.addFormatter({
* - & is the escape sequence for &
* - &lt; is the escape sequence for <
* - &gt; is the escape sequence for >
*
*
* @param {String} message to escape
* @return escaped message as {String}
*/
Expand All @@ -51,13 +51,17 @@ CSSLint.addFormatter({
};

if (messages.length > 0) {

output.push("<file name=\""+filename+"\">");
CSSLint.Util.forEach(messages, function (message, i) {
if (message.rollup) {
output.push("<issue severity=\"" + message.type + "\" reason=\"" + escapeSpecialCharacters(message.message) + "\" evidence=\"" + escapeSpecialCharacters(message.evidence) + "\"/>");
} else {
output.push("<issue line=\"" + message.line + "\" char=\"" + message.col + "\" severity=\"" + message.type + "\"" +
var rule = '';
if (message.rule && message.rule.id) {
rule = 'rule=\"' + escapeSpecialCharacters(message.rule.id) + '\" ';
}
output.push("<issue " + rule + "line=\"" + message.line + "\" char=\"" + message.col + "\" severity=\"" + message.type + "\"" +
" reason=\"" + escapeSpecialCharacters(message.message) + "\" evidence=\"" + escapeSpecialCharacters(message.evidence) + "\"/>");
}
});
Expand Down
21 changes: 20 additions & 1 deletion tests/formatters/lint-xml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
YUITest.TestRunner.add(new YUITest.TestCase({

name: "Lint XML formatter test",

"File with no problems should say so": function(){
var result = { messages: [], stats: [] },
expected = "<?xml version=\"1.0\" encoding=\"utf-8\"?><lint></lint>";
Expand Down Expand Up @@ -38,6 +38,25 @@
expected = "<?xml version=\"1.0\" encoding=\"utf-8\"?><lint>" + file + error1 + error2 + "</file></lint>",
actual = CSSLint.format(result, "FILE", "lint-xml");
Assert.areEqual(expected, actual);
},

"Messages should include rule IDs": function() {
var result = { messages: [
{ type: "error", line: 1, col: 1, message: "X", evidence: "Y", rule: { id: "Z" } }
], stats: [] };

var expected =
'<?xml version="1.0" encoding="utf-8"?>' +
'<lint>' +
'<file name="FILE">' +
'<issue rule="Z" line="1" char="1" severity="error" reason="X" evidence="Y"/>' +
'</file>' +
'</lint>';

var actual = CSSLint.format(result, "FILE", "lint-xml");

Assert.areEqual(expected, actual);
}

}));
})();