├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── index.js
├── package-lock.json
├── package.json
└── test.js
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.log
3 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - '8'
4 | - '7'
5 | - '6'
6 | - '5'
7 | - '4'
8 | - '0.12'
9 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | ### 0.1.2
4 |
5 | - Update dependencies
6 |
7 | ### 0.1.1
8 |
9 | - Update lodash from ^3 to ^4
10 |
11 | ## 0.1.0
12 |
13 | - Initial experimental release.
14 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2015 stylelint
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
23 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # stylelint-checkstyle-formatter
2 |
3 | [](https://travis-ci.org/davidtheclark/stylelint-checkstyle-formatter)
4 |
5 | Output [Checkstyle](http://checkstyle.sourceforge.net/) XML reports of stylelint results,
6 | which might be handy if you use the Jenkins [Checkstyle Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Checkstyle+Plugin), so you can have graphs and be professional.
7 |
8 | ## Usage
9 |
10 | Simply read the [stylelint](https://github.com/stylelint/stylelint) documentation about using formatters and follow those instructions.
11 |
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | var escape = require('lodash/escape');
2 | var checkstyleVersion = '4.3'; // Why? Because that's what ESLint uses, I suppose
3 |
4 | module.exports = function(stylelintResults) {
5 | var xml = '';
6 | xml += '\n';
7 | stylelintResults.forEach(function(stylelintResult) {
8 | xml += '\n ';
9 | if (!stylelintResult.warnings.length) {
10 | xml += '';
11 | return;
12 | }
13 | stylelintResult.warnings.forEach(function(warning) {
14 | xml += '\n ';
20 | });
21 | xml += '\n ';
22 | });
23 | xml += '\n';
24 | return xml;
25 | }
26 |
--------------------------------------------------------------------------------
/package-lock.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "stylelint-checkstyle-formatter",
3 | "version": "0.1.1",
4 | "lockfileVersion": 1,
5 | "requires": true,
6 | "dependencies": {
7 | "balanced-match": {
8 | "version": "1.0.0",
9 | "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
10 | "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=",
11 | "dev": true
12 | },
13 | "brace-expansion": {
14 | "version": "1.1.11",
15 | "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
16 | "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
17 | "dev": true,
18 | "requires": {
19 | "balanced-match": "^1.0.0",
20 | "concat-map": "0.0.1"
21 | }
22 | },
23 | "concat-map": {
24 | "version": "0.0.1",
25 | "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
26 | "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=",
27 | "dev": true
28 | },
29 | "deep-equal": {
30 | "version": "1.0.1",
31 | "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-1.0.1.tgz",
32 | "integrity": "sha1-9dJgKStmDghO/0zbyfCK0yR0SLU=",
33 | "dev": true
34 | },
35 | "define-properties": {
36 | "version": "1.1.2",
37 | "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.2.tgz",
38 | "integrity": "sha1-g6c/L+pWmJj7c3GTyPhzyvbUXJQ=",
39 | "dev": true,
40 | "requires": {
41 | "foreach": "^2.0.5",
42 | "object-keys": "^1.0.8"
43 | }
44 | },
45 | "defined": {
46 | "version": "1.0.0",
47 | "resolved": "https://registry.npmjs.org/defined/-/defined-1.0.0.tgz",
48 | "integrity": "sha1-yY2bzvdWdBiOEQlpFRGZ45sfppM=",
49 | "dev": true
50 | },
51 | "es-abstract": {
52 | "version": "1.12.0",
53 | "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.12.0.tgz",
54 | "integrity": "sha512-C8Fx/0jFmV5IPoMOFPA9P9G5NtqW+4cOPit3MIuvR2t7Ag2K15EJTpxnHAYTzL+aYQJIESYeXZmDBfOBE1HcpA==",
55 | "dev": true,
56 | "requires": {
57 | "es-to-primitive": "^1.1.1",
58 | "function-bind": "^1.1.1",
59 | "has": "^1.0.1",
60 | "is-callable": "^1.1.3",
61 | "is-regex": "^1.0.4"
62 | }
63 | },
64 | "es-to-primitive": {
65 | "version": "1.1.1",
66 | "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.1.1.tgz",
67 | "integrity": "sha1-RTVSSKiJeQNLZ5Lhm7gfK3l13Q0=",
68 | "dev": true,
69 | "requires": {
70 | "is-callable": "^1.1.1",
71 | "is-date-object": "^1.0.1",
72 | "is-symbol": "^1.0.1"
73 | }
74 | },
75 | "for-each": {
76 | "version": "0.3.3",
77 | "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz",
78 | "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==",
79 | "dev": true,
80 | "requires": {
81 | "is-callable": "^1.1.3"
82 | }
83 | },
84 | "foreach": {
85 | "version": "2.0.5",
86 | "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz",
87 | "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k=",
88 | "dev": true
89 | },
90 | "fs.realpath": {
91 | "version": "1.0.0",
92 | "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
93 | "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=",
94 | "dev": true
95 | },
96 | "function-bind": {
97 | "version": "1.1.1",
98 | "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz",
99 | "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==",
100 | "dev": true
101 | },
102 | "glob": {
103 | "version": "7.1.2",
104 | "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz",
105 | "integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==",
106 | "dev": true,
107 | "requires": {
108 | "fs.realpath": "^1.0.0",
109 | "inflight": "^1.0.4",
110 | "inherits": "2",
111 | "minimatch": "^3.0.4",
112 | "once": "^1.3.0",
113 | "path-is-absolute": "^1.0.0"
114 | }
115 | },
116 | "has": {
117 | "version": "1.0.3",
118 | "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
119 | "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==",
120 | "dev": true,
121 | "requires": {
122 | "function-bind": "^1.1.1"
123 | }
124 | },
125 | "inflight": {
126 | "version": "1.0.6",
127 | "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
128 | "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=",
129 | "dev": true,
130 | "requires": {
131 | "once": "^1.3.0",
132 | "wrappy": "1"
133 | }
134 | },
135 | "inherits": {
136 | "version": "2.0.3",
137 | "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
138 | "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=",
139 | "dev": true
140 | },
141 | "is-callable": {
142 | "version": "1.1.4",
143 | "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.4.tgz",
144 | "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==",
145 | "dev": true
146 | },
147 | "is-date-object": {
148 | "version": "1.0.1",
149 | "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.1.tgz",
150 | "integrity": "sha1-mqIOtq7rv/d/vTPnTKAbM1gdOhY=",
151 | "dev": true
152 | },
153 | "is-regex": {
154 | "version": "1.0.4",
155 | "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz",
156 | "integrity": "sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=",
157 | "dev": true,
158 | "requires": {
159 | "has": "^1.0.1"
160 | }
161 | },
162 | "is-symbol": {
163 | "version": "1.0.1",
164 | "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.1.tgz",
165 | "integrity": "sha1-PMWfAAJRlLarLjjbrmaJJWtmBXI=",
166 | "dev": true
167 | },
168 | "lodash": {
169 | "version": "4.17.10",
170 | "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.10.tgz",
171 | "integrity": "sha512-UejweD1pDoXu+AD825lWwp4ZGtSwgnpZxb3JDViD7StjQz+Nb/6l093lx4OQ0foGWNRoc19mWy7BzL+UAK2iVg=="
172 | },
173 | "minimatch": {
174 | "version": "3.0.4",
175 | "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
176 | "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
177 | "dev": true,
178 | "requires": {
179 | "brace-expansion": "^1.1.7"
180 | }
181 | },
182 | "minimist": {
183 | "version": "1.2.0",
184 | "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz",
185 | "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=",
186 | "dev": true
187 | },
188 | "object-inspect": {
189 | "version": "1.6.0",
190 | "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.6.0.tgz",
191 | "integrity": "sha512-GJzfBZ6DgDAmnuaM3104jR4s1Myxr3Y3zfIyN4z3UdqN69oSRacNK8UhnobDdC+7J2AHCjGwxQubNJfE70SXXQ==",
192 | "dev": true
193 | },
194 | "object-keys": {
195 | "version": "1.0.12",
196 | "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.0.12.tgz",
197 | "integrity": "sha512-FTMyFUm2wBcGHnH2eXmz7tC6IwlqQZ6mVZ+6dm6vZ4IQIHjs6FdNsQBuKGPuUUUY6NfJw2PshC08Tn6LzLDOag==",
198 | "dev": true
199 | },
200 | "once": {
201 | "version": "1.4.0",
202 | "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
203 | "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
204 | "dev": true,
205 | "requires": {
206 | "wrappy": "1"
207 | }
208 | },
209 | "path-is-absolute": {
210 | "version": "1.0.1",
211 | "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
212 | "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=",
213 | "dev": true
214 | },
215 | "path-parse": {
216 | "version": "1.0.6",
217 | "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
218 | "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
219 | "dev": true
220 | },
221 | "resolve": {
222 | "version": "1.7.1",
223 | "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.7.1.tgz",
224 | "integrity": "sha512-c7rwLofp8g1U+h1KNyHL/jicrKg1Ek4q+Lr33AL65uZTinUZHe30D5HlyN5V9NW0JX1D5dXQ4jqW5l7Sy/kGfw==",
225 | "dev": true,
226 | "requires": {
227 | "path-parse": "^1.0.5"
228 | }
229 | },
230 | "resumer": {
231 | "version": "0.0.0",
232 | "resolved": "https://registry.npmjs.org/resumer/-/resumer-0.0.0.tgz",
233 | "integrity": "sha1-8ej0YeQGS6Oegq883CqMiT0HZ1k=",
234 | "dev": true,
235 | "requires": {
236 | "through": "~2.3.4"
237 | }
238 | },
239 | "sax": {
240 | "version": "1.2.4",
241 | "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",
242 | "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==",
243 | "dev": true
244 | },
245 | "string.prototype.trim": {
246 | "version": "1.1.2",
247 | "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.1.2.tgz",
248 | "integrity": "sha1-0E3iyJ4Tf019IG8Ia17S+ua+jOo=",
249 | "dev": true,
250 | "requires": {
251 | "define-properties": "^1.1.2",
252 | "es-abstract": "^1.5.0",
253 | "function-bind": "^1.0.2"
254 | }
255 | },
256 | "tape": {
257 | "version": "4.9.1",
258 | "resolved": "https://registry.npmjs.org/tape/-/tape-4.9.1.tgz",
259 | "integrity": "sha512-6fKIXknLpoe/Jp4rzHKFPpJUHDHDqn8jus99IfPnHIjyz78HYlefTGD3b5EkbQzuLfaEvmfPK3IolLgq2xT3kw==",
260 | "dev": true,
261 | "requires": {
262 | "deep-equal": "~1.0.1",
263 | "defined": "~1.0.0",
264 | "for-each": "~0.3.3",
265 | "function-bind": "~1.1.1",
266 | "glob": "~7.1.2",
267 | "has": "~1.0.3",
268 | "inherits": "~2.0.3",
269 | "minimist": "~1.2.0",
270 | "object-inspect": "~1.6.0",
271 | "resolve": "~1.7.1",
272 | "resumer": "~0.0.0",
273 | "string.prototype.trim": "~1.1.2",
274 | "through": "~2.3.8"
275 | }
276 | },
277 | "through": {
278 | "version": "2.3.8",
279 | "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz",
280 | "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=",
281 | "dev": true
282 | },
283 | "wrappy": {
284 | "version": "1.0.2",
285 | "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
286 | "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=",
287 | "dev": true
288 | },
289 | "xml2js": {
290 | "version": "0.4.19",
291 | "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.19.tgz",
292 | "integrity": "sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q==",
293 | "dev": true,
294 | "requires": {
295 | "sax": ">=0.6.0",
296 | "xmlbuilder": "~9.0.1"
297 | }
298 | },
299 | "xmlbuilder": {
300 | "version": "9.0.4",
301 | "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.4.tgz",
302 | "integrity": "sha1-UZy0ymhtAFqEINNJbz8MruzKWA8=",
303 | "dev": true
304 | }
305 | }
306 | }
307 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "stylelint-checkstyle-formatter",
3 | "version": "0.1.2",
4 | "description": "Output Checkstyle XML reports of stylelint results",
5 | "main": "index.js",
6 | "scripts": {
7 | "test": "tape test.js"
8 | },
9 | "repository": {
10 | "type": "git",
11 | "url": "git+https://github.com/stylelint/stylelint-checkstyle-formatter.git"
12 | },
13 | "keywords": [
14 | "stylelint",
15 | "checkstyle",
16 | "formatter",
17 | "reporter",
18 | "report"
19 | ],
20 | "author": "David Clark",
21 | "license": "MIT",
22 | "bugs": {
23 | "url": "https://github.com/stylelint/stylelint-checkstyle-formatter/issues"
24 | },
25 | "homepage": "https://github.com/stylelint/stylelint-checkstyle-formatter#readme",
26 | "devDependencies": {
27 | "tape": "^4.9.1",
28 | "xml2js": "^0.4.15"
29 | },
30 | "dependencies": {
31 | "lodash": "^4.17.10"
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/test.js:
--------------------------------------------------------------------------------
1 | var test = require('tape');
2 | var xml2js = require('xml2js');
3 | var checkstyleFormatter = require('./index');
4 |
5 | var mockResults = [
6 | {
7 | source: 'path/to/fileA.css',
8 | errored: false,
9 | warnings: [
10 | {
11 | line: 3,
12 | column: 8,
13 | rule: 'block-no-empty',
14 | severity: 'warning',
15 | text: 'No empty block!',
16 | },
17 | ],
18 | },
19 | {
20 | source: 'path/to/fileB.css',
21 | errors: true,
22 | warnings: [
23 | {
24 | line: 1,
25 | column: 2,
26 | rule: 'foo',
27 | severity: 'error',
28 | text: 'foo text',
29 | },
30 | {
31 | line: 2,
32 | column: 5,
33 | rule: 'bar',
34 | severity: 'error',
35 | text: 'bar text',
36 | },
37 | ],
38 | },
39 | {
40 | source: 'path/to/fileC.css',
41 | errors: false,
42 | warnings: [],
43 | },
44 | ];
45 |
46 | var expectedXml = '\n' +
47 | '\n' +
48 | ' \n' +
49 | ' \n' +
50 | ' \n' +
51 | ' \n' +
52 | ' \n' +
53 | ' \n' +
54 | ' \n' +
55 | ' \n' +
56 | '';
57 |
58 | test('output XML string', function(t) {
59 | var output = checkstyleFormatter(mockResults);
60 | t.equal(output, expectedXml, "matches expectation");
61 | t.doesNotThrow(function() {
62 | xml2js.parseString(output, function(err) {
63 | if (err) throw err;
64 | });
65 | }, "is valid XML");
66 | t.end()
67 | });
68 |
--------------------------------------------------------------------------------