# css-validator > Validate CSS via W3C's service Latest version **0.11.0** (published 2022-03-04) · 0 weekly downloads ## Install ```sh npm install css-validator pnpm add css-validator yarn add css-validator bun add css-validator ``` Provides the command `css-validator`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.11.0 | | Published | 2022-03-04 | | First published | 2013-11-27 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | >= 4.0.0 | | Dependencies | 6 | | Unpacked size | 68.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 43 | | Author | Todd Wolfson | | Maintainers | twolfson | | Keywords | css, validate, w3c | ## Links - npm: https://www.npmjs.com/package/css-validator - Repository: https://github.com/twolfson/css-validator - Issues: https://github.com/twolfson/css-validator/issues - npm.io page: https://npm.io/package/css-validator ## Dependencies (6) - [sax](https://npm.io/package/sax.md) ~1.2.4 - [async](https://npm.io/package/async.md) ~3.2.0 - [commander](https://npm.io/package/commander.md) ~7.1.0 - [form-data](https://npm.io/package/form-data.md) ~4.0.0 - [obj-extend](https://npm.io/package/obj-extend.md) ~0.1.0 - [readable-stream](https://npm.io/package/readable-stream.md) ~3.6.0 ## Alternatives - [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads - [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads - [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads - [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads - [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads ## Recent versions - 0.11.0 (latest) — 2022-03-04 - 0.10.0 — 2021-03-07 - 0.9.0 — 2019-09-13 - 0.8.1 — 2018-10-31 - 0.8.0 — 2017-03-19 - 0.7.0 — 2017-03-14 - 0.6.0 — 2017-03-14 - 0.5.3 — 2016-09-17 - 0.5.2 — 2016-09-17 - 0.5.1 — 2014-01-28 - 0.5.0 — 2013-11-28 - 0.4.0 — 2013-11-28 - 0.3.0 — 2013-11-28 - 0.2.0 — 2013-11-27 - 0.1.1 — 2013-11-27 - … 1 more at https://npm.io/package/css-validator/versions ## README # css-validator [![Build status](https://travis-ci.org/twolfson/css-validator.png?branch=master)](https://travis-ci.org/twolfson/css-validator) Validate 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 ## Getting Started Install the module with: `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, []); }); ``` ## Donations Support this project and [others by twolfson][projects] via [donations][support-me] [projects]: http://twolfson.com/projects [support-me]: http://twolfson.com/support-me ## Documentation `css-validator` returns a single function as its `module.exports` ### `validateCss(options, cb)` Validate CSS against [W3C's Jigsaw validation service][jigsaw] - options `String|Object` - If `options` is a `String`, it will be treated as `options.text` - w3cUrl `String` - 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 `String` - CSS profile to use for validation (e.g. `css3svg`, `css21`, `svg`) - Service's default value: `css3svg` - lang `String` - Language to use in response (e.g. `en`, `bg`, `de`) - Service's default value: `en` - warning `Number|String` - Warning level to set. Default is `2` - Service's default value: `2` - If set to `no`, 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: `false` - cb `null|Function` - 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 `String` - errorsubtype `String` - skippedstring `String` - 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 occurred 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 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 ### CLI `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. `all` (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 `npm run lint` and test via `npm test`. ## Unlicense 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][]. [UNLICENSE]: UNLICENSE --- _Source: https://npm.io/package/css-validator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._