style-to-object 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,7 +1,62 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.3.0](https://github.com/remarkablemark/style-to-object/compare/v0.2.3...v0.3.0) (2019-11-07)
+
+
+### Bug Fixes
+
+* **index:** update return type of main function (remove `any`) ([c6e8a54](https://github.com/remarkablemark/style-to-object/commit/c6e8a54))
+
+
+### Features
+
+* add typescript support ([74a1b83](https://github.com/remarkablemark/style-to-object/commit/74a1b83))
+
+
+### Tests
+
+* **index:** add test for TS declaration file ([b029a4b](https://github.com/remarkablemark/style-to-object/commit/b029a4b))
+
+
+
+### [0.2.3](https://github.com/remarkablemark/style-to-object/compare/v0.2.2...v0.2.3) (2019-06-22)
+
+
+### Build System
+
+* **package:** add field "files" and remove `.npmignore` ([fdf3966](https://github.com/remarkablemark/style-to-object/commit/fdf3966))
+* **package:** update script `build:min` to generate sourcemap ([a13be58](https://github.com/remarkablemark/style-to-object/commit/a13be58))
+* **package:** upgrade devDependencies ([377bb40](https://github.com/remarkablemark/style-to-object/commit/377bb40))
+* **rollup:** remove `uglify-es` from config as it's unneeded ([b0951e0](https://github.com/remarkablemark/style-to-object/commit/b0951e0))
+
+
+### Tests
+
+* organize and rename describe blocks ([8d4c004](https://github.com/remarkablemark/style-to-object/commit/8d4c004))
+* organize data (test suites) into cases, errors, and invalids ([513732b](https://github.com/remarkablemark/style-to-object/commit/513732b))
+* rename `test/cases.js` to `test/data.js` ([75d084d](https://github.com/remarkablemark/style-to-object/commit/75d084d))
+* **data:** add more test cases and errors ([c9242c7](https://github.com/remarkablemark/style-to-object/commit/c9242c7))
+* **data:** refactor test data from object to array format ([1a07a38](https://github.com/remarkablemark/style-to-object/commit/1a07a38))
+
+
+
+<a name="0.2.2"></a>
+## [0.2.2](https://github.com/remarkablemark/style-to-object/compare/v0.2.1...v0.2.2) (2018-09-13)
+
+
+
+<a name="0.2.1"></a>
+## [0.2.1](https://github.com/remarkablemark/style-to-object/compare/v0.2.0...v0.2.1) (2018-05-09)
+
+
+### Bug Fixes
+
+* **package:** upgrade css@2.2.3 which resolves security vulnerability ([d8b94c0](https://github.com/remarkablemark/style-to-object/commit/d8b94c0))
+
+
+
 <a name="0.2.0"></a>
 # [0.2.0](https://github.com/remarkablemark/style-to-object/compare/v0.1.0...v0.2.0) (2017-11-26)
 

package/README.md

@@ -6,29 +6,35 @@
 [![Build Status](https://travis-ci.org/remarkablemark/style-to-object.svg?branch=master)](https://travis-ci.org/remarkablemark/style-to-object)
 [![Coverage Status](https://coveralls.io/repos/github/remarkablemark/style-to-object/badge.svg?branch=master)](https://coveralls.io/github/remarkablemark/style-to-object?branch=master)
 [![Dependency status](https://david-dm.org/remarkablemark/style-to-object.svg)](https://david-dm.org/remarkablemark/style-to-object)
+[![NPM downloads](https://img.shields.io/npm/dm/style-to-object.svg?style=flat-square)](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;');
-// { color: "#C0FFEE", background: "#BADA55" }
+var parse = require('style-to-object');
+parse('color: #C0FFEE; background: #BADA55;');
 ```
 
-[JSFiddle](https://jsfiddle.net/remarkablemark/ykz2meot/)
+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
+$ npm install style-to-object --save
 ```
 
 [Yarn](https://yarn.fyi/style-to-object):
 
 ```sh
-yarn add style-to-object
+$ yarn add style-to-object
 ```
 
 [CDN](https://unpkg.com/style-to-object/):
@@ -36,7 +42,7 @@ yarn add style-to-object
 ```html
 <script src="https://unpkg.com/style-to-object@latest/dist/style-to-object.min.js"></script>
 <script>
-  var parser = window.StyleToObject;
+  window.StyleToObject(/* string */);
 </script>
 ```
 
@@ -46,50 +52,70 @@ Import the module:
 
 ```js
 // CommonJS
-const parser = require('style-to-object');
+const parse = require('style-to-object');
 
 // ES Modules
-import parser from 'style-to-object';
+import parse from 'style-to-object';
 ```
 
 Parse single declaration:
 
 ```js
-parse(`
-  color: #f00
-`);
-// { color: '#f00' }
+parse('line-height: 42');
+```
+
+Output:
+
+```js
+{ 'line-height': '42' }
 ```
 
 Parse multiple declarations:
 
 ```js
 parse(`
-  color: #f00;
-  z-index: 42;
+  border-color: #ACE;
+  z-index: 1337;
 `);
-// { color: '#f00', 'z-index': '42' }
+```
+
+Output:
+
+```js
+{ 'border-color': '#ACE', 'z-index': '1337' }
 ```
 
 Parse unknown declarations:
 
 ```js
-parse(`
-  foo: bar;
-`);
-// { foo: 'bar' }
+parse('answer: 42;');
+```
+
+Output:
+
+```js
+{ 'answer': '42' }
 ```
 
-Invalid declarations:
+Invalid declarations/arguments:
 
 ```js
-parse(1); // null
-parse('top:'); // null
 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
@@ -97,13 +123,13 @@ parse('top'); // throws Error
 If the 2nd argument is a function, then the parser will return `null`:
 
 ```js
-parser('color: #f00', function() {}); // null
+parse('color: #f00', function() {}); // null
 ```
 
 But the function will iterate through each declaration:
 
 ```js
-parser('color: #f00', function(name, value, declaration) {
+parse('color: #f00', function(name, value, declaration) {
   console.log(name);        // 'color'
   console.log(value);       // '#f00'
   console.log(declaration); // { type: 'declaration', property: 'color', value: '#f00' }
@@ -114,35 +140,73 @@ This makes it easy to customize the output:
 
 ```js
 const style = `
-  color: #f00;
-  background: #ba4;
+  color: red;
+  background: blue;
 `;
 const output = [];
-const iterator = (name, value) => {
+
+function iterator(name, value) {
   output.push([name, value]);
-};
-parser(style, iterator);
-console.log(output); // [['color', '#f00'], ['background', '#ba4']]
+}
+
+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
+
+# generate html report
+$ npm run test:coverage:report
+```
+
+Lint files:
+
+```sh
 $ npm run lint
 ```
 
+Fix lint errors:
+
+```sh
+$ npm run lint:fix
+```
+
+Test TypeScript declaration file for style and correctness:
+
+```sh
+$ npm run lint:dts
+```
+
 ## Release
 
+Only collaborators with credentials can release and publish:
+
 ```sh
 $ npm run release
-$ npm publish
-$ git push --follow-tags
+$ git push --follow-tags && npm publish
 ```
 
 ## Special Thanks
 
-- [css](https://github.com/reworkcss/css)
+- [inline-style-parser](https://github.com/remarkablemark/inline-style-parser)
+- [Contributors](https://github.com/remarkablemark/style-to-object/graphs/contributors)
 
 ## License