posthtml-parser - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "posthtml-parser",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Parse HTML/XML to PostHTMLTree",
@@ -16,3 +16,5 @@ "keywords": [
     "lint": "jshint . && jscs -v .",
-    "coverage": "istanbul cover --report text --report html --report lcov node_modules/mocha/bin/_mocha"
+    "coverage": "istanbul cover --report text --report html --report lcov node_modules/mocha/bin/_mocha",
+    "preversion": "npm test",
+    "postversion": "git push && git push --tags && rm -rf coverage"
   },
@@ -19,0 +21,0 @@ "repository": {

README.md

@@ -8,4 +8,57 @@ # posthtml-parser
 
+## Install
+
+[NPM](http://npmjs.com) install
+```
+$ npm install posthtml-parser
+```
+
+## Usage 
+
+#### input HTML
+```html
+<a class="animals" href="#">
+    <span class="animals__cat" style="background: url(cat.png)">Cat</span>
+</a>
+```
+```js
+var parser = require('posthtml-parser');
+var fs = require('fs');
+var html = fs.readFileSync('path/to/input.html').toString();
+
+clonsole.log(parser(html)); // Look #Result PostHTMLTree
+```
+
+#### input HTML
+```html
+<a class="animals" href="#">
+    <span class="animals__cat" style="background: url(cat.png)">Cat</span>
+</a>
+```
+
+#### Result PostHTMLTree
+```js
+[{
+    tag: 'a',
+    attrs: {
+        class: 'animals',
+        href: '#'
+    },
+    content: [
+        '\n    ',
+            {
+            tag: 'span',
+            attrs: {
+                class: 'animals__cat',
+                style: 'background: url(cat.png)'
+            },
+            content: ['Cat']
+        },
+        '\n'
+    ]
+}]
+```
+
 ## License
 
 [MIT](LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

64

increased by481.82%

Worsened metrics

Total package byte prevSize

5907

decreased by-94.16%

Number of package files

6

decreased by-75%

Lines of code

67

decreased by-92.5%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes