Validate CSS via W3C's service
This was created to validate CSS inside of the json2css test suite.
Install the module with: npm install css-validator
var validateCss = require('css-validator');
validateCss({text: 'a { color: blue; }'}, function (err, data) {
assert.strictEqual(data.validity, true);
assert.deepEqual(data.errors, []);
assert.deepEqual(data.warnings, []);
});
css-validator
returns a single function as its module.exports
Validate CSS against W3C's Jigsaw validation service
- options
String|Object
- Ifoptions
is aString
, it will be treated asoptions.text
- w3cUrl
String
- URL to validate against. Default is http://jigsaw.w3.org/css-validator/validator - The following options from the validator itself
- uri
null|String
- URL of document to validate. CSS and HTML documents are allowed - text
null|String
- CSS to validate - usermedium
String
- Medium where the CSS will be used (e.g.screen
,print
,braille
). Default isall
. - profile
String
- CSS profile to use for validation. Default iscss3
.- Possible values are
css1
,css2
,css21
,css3
,svg
,svgbasic
,svgtiny
,mobile
,atsc-tv
,tv
,none
- Possible values are
- lang
String
- Language to use in response. Default isen
- Possible values are
en
,fr
,it
,ko
,ja
,es
,zh-cn
,nl
,de
,it
,pl
- Possible values are
- warning
Number|String
- Warning level to set. Default is2
- If set to
no
, no warnings will be returned - If set to
0
, less warnings will be returned - If set to
1
or2
, more warnings will be returned
- If set to
- w3cUrl
- cb
null|Function
- Error first callback withfunction (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 betrue
. Otherwise, it isfalse
. - errors
Object[]
- Array of errors- These are dynamically parsed and not guaranteed to exist. The service only guarantees
line
,level
, andmessage
. - line
Number
- Line where error occurred - errortype
String
- context
String
- errorsubtype
String
- skippedstring
String
- Content where error occurred - message
String
- Human readable information about the error and why it occurred
- These are dynamically parsed and not guaranteed to exist. The service only guarantees
- warnings
Object[]
- Array of warnings- line
Number
- Line where error occurred - level
Number
- Intensity of the warning. Seeoptions.warning
for more info - message
String
- Human readable information about the warning and why it occurred
- line
- validity
- err
If 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 asdata
sent tocb
. Emitted once. - end - Emitted when we have finished parsing the input and outputting events
- validity
Boolean
- Event fordata.validity
withdata.validity
as its data - validation-error
Object
- Event for a newdata.errors
object with the error as its argument - validation-warning
Object
- Event for a newdata.warnings
object with the warning as its argument
var cssValidate = require('css-validate');
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 ' } ] }
*/
});
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 grunt and test via npm test
.
Support this project and others by twolfson via gittip.
As of Nov 27 2013, Todd Wolfson has released this repository and its contents to the public domain.
It has been released under the UNLICENSE.