posthtml-render - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "posthtml-render",
-  "version": "1.1.0",
-  "description": "Render PostHTMLTree to HTML/XML",
-  "main": "lib/posthtml-render.js",
+  "version": "1.1.1",
+  "description": "Renders PostHTML Tree to HTML/XML",
+  "author": "Ivan Voischev <[e-mail]>",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "browser": "lib/browser.min.js",
+  "files": [
+    "lib"
+  ],
+  "devDependencies": {
+    "chai": "^4.0.0",
+    "jsdoc-to-markdown": "^3.0.0",
+    "mocha": "^3.0.0",
+    "nyc": "^10.0.0",
+    "rollup": "^0.54.0",
+    "rollup-plugin-commonjs": "^8.0.0",
+    "rollup-plugin-uglify": "^2.0.0",
+    "standard": "^10.0.0",
+    "standard-version": "^4.0.0",
+    "uglify-es": "^3.0.0"
+  },
   "scripts": {
-    "test": "npm run build && npm run lint && npm run coverage",
-    "lint": "jshint lib/ && jscs lib/ -v",
-    "coverage": "istanbul cover --report text --report html --report lcov node_modules/mocha/bin/_mocha",
-    "build": "uglifyjs lib/posthtml-render.js -c \"evaluate=false\" -o posthtml-render.min.js",
-    "preversion": "npm test",
-    "postversion": "git push && git push --tags && rm -rf coverage"
+    "lint": "standard --env mocha",
+    "test": "nyc node_modules/mocha/bin/_mocha",
+    "docs": "jsdoc2md lib/*.js > RENDER.md",
+    "build": "rollup -c",
+    "clean": "rm -rf .nyc_output coverage",
+    "release": "npm run build && standard-version"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/posthtml/posthtml-render.git"
-  },
   "keywords": [
@@ -22,19 +36,7 @@ "posthtml",
     "html",
-    "xml",
-    "posthtml-tree"
+    "xml"
   ],
-  "author": "Ivan Voischev <[e-mail]>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/posthtml/posthtml-render/issues"
-  },
+  "bugs": "https://github.com/posthtml/posthtml-render/issues",
   "homepage": "https://github.com/posthtml/posthtml-render#readme",
-  "devDependencies": {
-    "chai": "^3.3.0",
-    "istanbul": "^0.4.0",
-    "jscs": "^2.3.4",
-    "jshint": "^2.8.0",
-    "mocha": "^2.3.3",
-    "uglify-js": "^3.3.7"
-  }
+  "repository": "https://github.com/posthtml/posthtml-render.git"
 }

README.md

@@ -1,35 +0,60 @@
-# posthtml-render
-[![npm version](https://badge.fury.io/js/posthtml-render.svg)](http://badge.fury.io/js/posthtml-render)
-[![Build Status](https://travis-ci.org/posthtml/posthtml-render.svg?branch=master)](https://travis-ci.org/posthtml/posthtml-render?branch=master)
-[![Coverage Status](https://coveralls.io/repos/posthtml/posthtml-render/badge.svg?branch=master)](https://coveralls.io/r/posthtml/posthtml-render?branch=master)
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![deps][deps]][deps-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![chat][chat]][chat-url]
 
-Render [PostHTML](http://github.com/posthtml/posthtml) Tree to HTML/XML.
-More info for [PostHTMLTree](https://github.com/posthtml/posthtml#posthtml-json-tree-example)
+<div align="center">
+  <a href="https://github.com/posthtml/posthtml">
+    <img width="200" height="200" alt="PostHTML"
+      src="http://posthtml.github.io/posthtml/logo.svg">
+  </a>
+  <h1>PostHTML Render</h1>
+  <p>Renders a PostHTML Tree to HTML/XML</p>
+</div>
 
-## Install
+<h2 align="center">Install</h2>
 
-[NPM](http://npmjs.com) install
+```bash
+npm i -D posthtml-render
 ```
-$ npm install posthtml-render
-```
-is also available for [bower](http://bower.io) and as an AMD, CommonJS, and globals module, uncompressed and compressed.
 
+> ℹ️ This module is also available for [bower](http://bower.io) and as an AMD, CommonJS and IIFE (global) module, uncompressed and compressed
 
-## Usage
+<h2 align="center">Usage</h2>
 
-__In NodeJS__
+### `NodeJS`
 
 ```js
-var render = require('posthtml-render');
-var listObj = { tag: 'ul' };
+const render = require('posthtml-render')
 
-listObj.attrs = { class: 'list' };
-listObj.content = ['one', 'two', 'three'].map(function(text) { return { tag: 'li', content: text }});
+const tree = []
 
-console.log(render(listObj/*, options */));
-// <ul class="list"><li>one</li><li>two</li><li>three</li></ul>
+const node = {}
+
+node.tag = 'ul'
+node.attrs = { class: 'list' }
+node.content = [
+ 'one',
+ 'two',
+ 'three'
+].map((content) => ({ tag: 'li', content }))
+
+tree.push(node)
+
+const html = render(tree, options)
+
 ```
 
-__In Browser__
+```html
+<ul class="list">
+  <li>one</li>
+  <li>two</li>
+  <li>three</li>
+</ul>
+```
 
+### `🌐 Browser`
+
 ```html
@@ -39,62 +64,124 @@ <!DOCTYPE html>
 <head>
-    <title>Title</title>
-    <script type="text/javascript" src="./bower_components/posthtml-render/posthtml-render.min.js"></script>
-    <script type="text/javascript">
-        window.onload = function() {
-            document.body.innerHTML = postHTMLRender({ tag: 'h1', attrs: { style: 'color: red;' }, content: ['Title'] });
-        };
-    </script>
+  <title>Title</title>
+  <script src="./node_modules/posthtml-render/lib/browser.min.js"></script>
+  <script >
+    const tree = {
+      tag: 'h1',
+      attrs: {
+        style: 'color: red;'
+      },
+      content: [ 'Title' ]
+    }
+
+    window.onload = function () {
+      document.body.innerHTML = render(tree)
+    }
+  </script>
 </head>
-<body>
-
-</body>
+<body></body>
 </html>
 ```
 
-## Options
+<h2 align="center">Options</h2>
 
-### singleTags
-Array tags for extend default list single tags. Values can be strings or regular expressions.
+|Name|Type|Default|Description|
+|:--:|:--:|:-----:|:----------|
+|**[`singleTags`](#singletags)**|`{Array<String\|RegExp>}`|`[]`|Specify custom single tags (self closing)|
+|**[`closingSingleTag`](#closingSingleTag)**|`{String}`|[`>`](#default)|Specify the single tag closing format|
 
-__Default__: `[]`
+### `singleTags`
 
-*Options* `{ singleTags: ['rect', 'custom', /^%.*%$/] }`
+Specify custom single tags (self closing)
 
+### `{String}`
+
+```js
+const render = require('posthtml-render')
+
+const tree = [ { tag: 'name' } ]
+const options = { singleTags: [ 'name' ] }
+
+const html = render(tree, options)
+```
+
+**result.html**
 ```html
-...
-<div>
-    ...
-    <rect>
-    <custom>
-    <%=title%>
-</div>
+<name>
 ```
 
+#### `{RegExp}`
 
-### closingSingleTag
-Option to specify version closing single tags.
-Accepts values: `default`, `slash`, `tag`.
+```js
+const render = require('posthtml-render')
 
-__Default__: `default`
+const tree = [ { tag: '%=title%' } ]
+const options = { singleTags: [ '/^%.*%$/' ] }
 
-*Options* `{ closingSingleTag: 'default' }`
+const html = render(tree, options)
+```
 
+**result.html**
 ```html
-<img>
+<%=title%>
 ```
 
-*Options* `{ closingSingleTag: 'slash' }`
+### `closingSingleTag`
 
+Specify the single tag closing format
+
+#### `Formats`
+
+```js
+const render = require('posthtml-render')
+
+const tree = [ { tag: 'img' } ]
+```
+
+##### `'tag'`
+
+```js
+const html = render(tree, { closingSingleTag: 'tag' })
+```
+
 ```html
-<img />
+<custom></custom>
 ```
 
-*Options* `{ closingSingleTag: 'tag' }`
+##### `'slash'`
 
+```js
+const html = render(tree, { closingSingleTag: 'tag' })
+```
+
 ```html
+<custom />
+```
+
+##### `'default' (Default)`
+
+```js
+const html = render(tree)
+```
+
+```html
 <img></img>
 ```
 
-## License
 
-[MIT](LICENSE)
+[npm]: https://img.shields.io/npm/v/posthtml-render.svg
+[npm-url]: https://npmjs.com/package/posthtml-render
+
+[node]: https://img.shields.io/node/v/posthtml-render.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://david-dm.org/posthtml/posthtml-render.svg
+[deps-url]: https://david-dm.org/posthtml/posthtml-render
+
+[tests]: http://img.shields.io/travis/posthtml/posthtml-render.svg
+[tests-url]: https://travis-ci.org/posthtml/posthtml-render
+
+[cover]: https://coveralls.io/repos/github/posthtml/posthtml-render/badge.svg
+[cover-url]: https://coveralls.io/github/posthtml/posthtml-render
+
+[chat]: https://badges.gitter.im/posthtml/posthtml.svg
+[chat-url]: https://gitter.im/posthtml/posthtml

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

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

Total package byte prevSize

15798

increased by34.83%

Lines of code

147

increased by9.7%

Number of lines in readme file

187

increased by87%

Worsened metrics

Dev dependency count

10

increased by66.67%

Number of low maintenance alerts

1

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes