Validate CSS via W3C's service
npm install css-validatorValidate CSS via [W3C's service][jigsaw]
[jigsaw]: http://jigsaw.w3.org/css-validator/
This was created to validate CSS inside of the [json2css][] test suite.
[json2css]: https://github.com/twolfson/json2css
npm install css-validator``js`
var validateCss = require('css-validator');
var assert = require('assert');
validateCss({text: 'a { color: blue; }'}, function (err, data) {
assert.strictEqual(data.validity, true);
assert.deepEqual(data.errors, []);
assert.deepEqual(data.warnings, []);
});
[projects]: http://twolfson.com/projects
[support-me]: http://twolfson.com/support-me
returns a single function as its module.exports$3
Validate CSS against [W3C's Jigsaw validation service][jigsaw]- options
- If options is a String, it will be treated as options.text
- w3cUrl - URL to validate against. Default is http://jigsaw.w3.org/css-validator/validator
- The following options from the validator itself
- Reference: http://jigsaw.w3.org/css-validator/manual.html#api
- uri null|String - URL of document to validate. CSS and HTML documents are allowed. Supports http and https protocols.
- text null|String - CSS to validate
- usermedium String - Medium where the CSS will be used (e.g. all, print, screen)
- Service's default value: all
- profile - CSS profile to use for validation (e.g. css3svg, css21, svg)
- Service's default value: css3svg
- lang - Language to use in response (e.g. en, bg, de)
- Service's default value: en
- warning - Warning level to set. Default is 2
- Service's default value:
- If set to , no warnings will be returned
- If set to 0, less warnings will be returned
- If set to 1 or 2, more warnings will be returned
- vextwarning String|Boolean - Allow vendor extensions to just show up as warnings
- Possible values: false, true
- Service's default value:
- cb - Error first callback with function (err, data) {} signature
- err null|Error - If there was a connetivity error, this will be it
- data null|Object - Container for response from [jigsaw][]
- validity Boolean - If there were no errors, this will be true. Otherwise, it is false.
- errors Object[] - Array of errors
- These are dynamically parsed and not guaranteed to exist. The service only guarantees line, level, and message.
- Reference: http://jigsaw.w3.org/css-validator/api.html#soap12message
- line Number - Line where error occurred
- errortype String
- context
- errorsubtype
- skippedstring - Content where error occurred
- message String - Human readable information about the error and why it occurred
- warnings Object[] - Array of warnings
- line Number - Line where error occurred
- level Number - Intensity of the warning. See options.warning for more info
- message String - Human readable information about the warning and why it occurredIf
cb is not provided, a [DuplexStream][] will be returned to you.If you have not provided
options.uri or options.text, you can .write + .end OR .pipe to the stream CSS to validate.Additionally, you can use
.read and .pipe to get the data returned by cb.The stream will emit the following events:
- error
Error - Error occurring during connection or parsing of response
- data Object - Same as data sent to cb. Emitted once.
- end - Emitted when we have finished parsing the input and outputting events
- validity Boolean - Event for data.validity with data.validity as its data
- validation-error Object - Event for a new data.errors object with the error as its argument
- validation-warning Object - Event for a new data.warnings object with the warning as its argument[
DuplexStream]: https://github.com/isaacs/readable-stream#class-streamduplex$3
css-validator offers a command line interface for validation:`
$ css-validator --help Usage: css-validator [options]
Options:
-h, --help output usage information
-V, --version output the version number
--w3c-url URL to validate against. Default is http://jigsaw.w3.org/css-validator/validator
--delay Delay between validation requests to avoid service blacklisting, defaults to 100ms
--concurrency Amount of requests to run in parallel, defaults to 1
--usermedium Medium where the CSS will be used (e.g.
(service default), print, screen)
--profile CSS profile to use for validation (e.g. css3svg (service default), css21, svg)
--lang Language to use in response (e.g. en (service default), bg, de)
--warning Warning level to set (e.g. 0, 1, 2 (service default), no)
--vextwarning Allow vendor extensions to just show up as warnings. Possible values are: true, false (service default)
`Examples
js
var cssValidate = require('css-validator');
var css = [
"body {",
" background: url(ab'cd');",
" -moz-box-sizing: content-box;",
"}",
].join('\n');cssValidate(css, function (err, data) {
console.log(data);
/*
{ validity: false,
errors:
[ { line: '2',
errortype: 'parse-error',
context: ' body ',
errorsubtype: '\n exp\n ',
skippedstring: '\n url(ab \'cd\')\n ',
message: '\n \n Value Error : background (nullcolors.html#propdef-background)\n \n url(ab \'cd\') is not a background-color value : \n ',
error: '\n ' } ],
warnings:
[ { line: '3',
level: '0',
message: 'Property -moz-box-sizing is an unknown vendor extension',
warning: '\n ' } ] }
*/
});
`Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via and test via npm test`.It has been released under the [UNLICENSE][].
[UNLICENSE]: UNLICENSE