WIP - add extractor, generate snippet_data
This commit is contained in:
203
node_modules/style-to-object/README.md
generated
vendored
Normal file
203
node_modules/style-to-object/README.md
generated
vendored
Normal file
@ -0,0 +1,203 @@
|
||||
# style-to-object
|
||||
|
||||
[](https://nodei.co/npm/style-to-object/)
|
||||
|
||||
[](https://www.npmjs.com/package/style-to-object)
|
||||
[](https://travis-ci.org/remarkablemark/style-to-object)
|
||||
[](https://coveralls.io/github/remarkablemark/style-to-object?branch=master)
|
||||
[](https://david-dm.org/remarkablemark/style-to-object)
|
||||
[](https://www.npmjs.com/package/style-to-object)
|
||||
|
||||
Parses inline style to object:
|
||||
|
||||
```js
|
||||
var parser = require('style-to-object');
|
||||
parser('color: #C0FFEE; background: #BADA55;');
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```js
|
||||
{ color: '#C0FFEE', background: '#BADA55' }
|
||||
```
|
||||
|
||||
[JSFiddle](https://jsfiddle.net/remarkablemark/ykz2meot/) | [Repl.it](https://repl.it/@remarkablemark/style-to-object) | [Examples](https://github.com/remarkablemark/style-to-object/tree/master/examples)
|
||||
|
||||
## Installation
|
||||
|
||||
[NPM](https://www.npmjs.com/package/style-to-object):
|
||||
|
||||
```sh
|
||||
$ npm install style-to-object --save
|
||||
```
|
||||
|
||||
[Yarn](https://yarn.fyi/style-to-object):
|
||||
|
||||
```sh
|
||||
$ yarn add style-to-object
|
||||
```
|
||||
|
||||
[CDN](https://unpkg.com/style-to-object/):
|
||||
|
||||
```html
|
||||
<script src="https://unpkg.com/style-to-object@latest/dist/style-to-object.min.js"></script>
|
||||
<script>
|
||||
window.StyleToObject(/* string */);
|
||||
</script>
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Import the module:
|
||||
|
||||
```js
|
||||
// CommonJS
|
||||
const parse = require('style-to-object');
|
||||
|
||||
// ES Modules
|
||||
import parse from 'style-to-object';
|
||||
```
|
||||
|
||||
Parse single declaration:
|
||||
|
||||
```js
|
||||
parse('line-height: 42');
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```js
|
||||
{ 'line-height': '42' }
|
||||
```
|
||||
|
||||
Parse multiple declarations:
|
||||
|
||||
```js
|
||||
parse(`
|
||||
border-color: #ACE;
|
||||
z-index: 1337;
|
||||
`);
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```js
|
||||
{ 'border-color': '#ACE', 'z-index': '1337' }
|
||||
```
|
||||
|
||||
Parse unknown declarations:
|
||||
|
||||
```js
|
||||
parse('answer: 42;');
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```js
|
||||
{ 'answer': '42' }
|
||||
```
|
||||
|
||||
Invalid declarations/arguments:
|
||||
|
||||
```js
|
||||
parse(`
|
||||
top: ;
|
||||
right: 1em;
|
||||
`); // { right: '1em' }
|
||||
|
||||
parse(); // null
|
||||
parse(null); // null
|
||||
parse(1); // null
|
||||
parse(true); // null
|
||||
parse('top:'); // null
|
||||
parse(':12px'); // null
|
||||
parse(':'); // null
|
||||
parse(';'); // null
|
||||
|
||||
parse('top'); // throws Error
|
||||
parse('/*'); // throws Error
|
||||
```
|
||||
|
||||
### Iterator
|
||||
|
||||
If the 2nd argument is a function, then the parser will return `null`:
|
||||
|
||||
```js
|
||||
parse('color: #f00', function() {}); // null
|
||||
```
|
||||
|
||||
But the function will iterate through each declaration:
|
||||
|
||||
```js
|
||||
parser('color: #f00', function(name, value, declaration) {
|
||||
console.log(name); // 'color'
|
||||
console.log(value); // '#f00'
|
||||
console.log(declaration); // { type: 'declaration', property: 'color', value: '#f00' }
|
||||
});
|
||||
```
|
||||
|
||||
This makes it easy to customize the output:
|
||||
|
||||
```js
|
||||
const style = `
|
||||
color: red;
|
||||
background: blue;
|
||||
`;
|
||||
const output = [];
|
||||
function iterator(name, value) {
|
||||
output.push([name, value]);
|
||||
}
|
||||
parse(style, iterator);
|
||||
console.log(output); // [['color', 'red'], ['background', 'blue']]
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
Run tests:
|
||||
|
||||
```sh
|
||||
$ npm test
|
||||
```
|
||||
|
||||
Run tests in watch mode:
|
||||
|
||||
```sh
|
||||
$ npm run test:watch
|
||||
```
|
||||
|
||||
Run tests with coverage:
|
||||
|
||||
```sh
|
||||
$ npm run test:coverage
|
||||
# npm run test:coverage:report
|
||||
```
|
||||
|
||||
Lint files:
|
||||
|
||||
```sh
|
||||
$ npm run lint
|
||||
```
|
||||
|
||||
Fix lint errors:
|
||||
|
||||
```sh
|
||||
$ npm run lint:fix
|
||||
```
|
||||
|
||||
## Release
|
||||
|
||||
Only collaborators with credentials can release and publish:
|
||||
|
||||
```sh
|
||||
$ npm run release
|
||||
$ git push --follow-tags && npm publish
|
||||
```
|
||||
|
||||
## Special Thanks
|
||||
|
||||
- [inline-style-parser](https://github.com/remarkablemark/inline-style-parser)
|
||||
- [Contributors](https://github.com/remarkablemark/style-to-object/graphs/contributors)
|
||||
|
||||
## License
|
||||
|
||||
[MIT](https://github.com/remarkablemark/style-to-object/blob/master/LICENSE)
|
||||
Reference in New Issue
Block a user