# rollup-plugin-posthtml

**Repository Path**: mirrors_posthtml/rollup-plugin-posthtml

## Basic Information

- **Project Name**: rollup-plugin-posthtml
- **Description**: PostHTML plugin for Rollup
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2025-09-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rollup-plugin-posthtml [![npm version][npmv-img]][npmv-url] [![github tags][ghtag-img]][ghtag-url] [![mit license][license-img]][license-url]

> PostHTML plugin for Rollup

You might also be interested in [posthtml](https://github.com/posthtml/posthtml).

## Quality 👌

> By using [commitizen][czfriendly-url] and [conventional commit messages][conventional-messages-url], 
maintaining meaningful [ChangeLog][changelogmd-url] 
and commit history based on [global conventions][conventions-url], 
following [StandardJS][standard-url] code style through [ESLint][eslint-url] and
having always up-to-date dependencies through integrations
like [GreenKeeper][gk-integration-url] and [David-DM][daviddm-url] service,
this package has top quality.

[![code climate][codeclimate-img]][codeclimate-url] 
[![code style][standard-img]][standard-url] 
[![commitizen friendly][czfriendly-img]][czfriendly-url] 
[![greenkeeper friendly][gkfriendly-img]][gkfriendly-url] 
[![dependencies][daviddm-deps-img]][daviddm-deps-url] 
<!-- uncomment when need -->
<!-- [![develop deps][daviddm-devdeps-img]][daviddm-devdeps-url] -->

## Stability 💯

> By following [Semantic Versioning][semver-url] through [standard-version][] releasing tool, 
this package is very stable and its tests are passing both on [Windows (AppVeyor)][appveyor-ci-url] 
and [Linux (CircleCI)][circle-ci-url] with results 
from 100% to [400%][absolute-coverage-url] test coverage, reported respectively
by [CodeCov][codecov-coverage-url] and [nyc (istanbul)][nyc-istanbul-url].

[![following semver][following-semver-img]][following-semver-url] 
[![semantic releases][strelease-img]][strelease-url] 
[![linux build][circle-img]][circle-url] 
[![windows build][appveyor-img]][appveyor-url] 
[![code coverage][codecov-img]][codecov-url] 
[![nyc coverage][istanbulcov-img]][istanbulcov-url] 

## Support :clap:

> If you have any problems, consider opening [an issue][open-issue-url],
ping me on twitter ([@tunnckoCore][tunnckocore-twitter-url]),
join the [support chat][supportchat-url] room
or queue a [live session][codementor-url] on CodeMentor with me.
If you don't have any problems, you're using it somewhere or
you just enjoy this product, then please consider [donating some cash][paypalme-url] at PayPal,
since this is [OPEN Open Source][opensource-project-url] project made
with :heart: at [Sofia, Bulgaria][bulgaria-url] 🇧🇬.

[![tunnckoCore support][supportchat-img]][supportchat-url] 
[![code mentor][codementor-img]][codementor-url] 
[![paypal donate][paypalme-img]][paypalme-url] 
[![NPM monthly downloads](https://img.shields.io/npm/dm/rollup-plugin-posthtml.svg?style=flat)](https://npmjs.org/package/rollup-plugin-posthtml) 
[![npm total downloads][downloads-img]][downloads-url] 

## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
  * [rollupPluginPosthtml](#rolluppluginposthtml)
  * [File emission](#file-emission)
- [Related](#related)
- [Contributing](#contributing)
- [Building docs](#building-docs)
- [Running tests](#running-tests)
- [Author](#author)
- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Install
Install with [npm](https://www.npmjs.com/)

```
$ npm install rollup-plugin-posthtml --save
```

or install using [yarn](https://yarnpkg.com)

```
$ yarn add rollup-plugin-posthtml
```

## Usage
> For more use-cases see the [tests](test.js)

```js
const rollupPluginPosthtml = require('rollup-plugin-posthtml')
```

## API

### [rollupPluginPosthtml](index.js#L45)
> A [posthtml] plugin for [rollup][]. The `options` are passed directly to PostHTML's `.process` method, so you can even parse a different parser and etc. You also can give `options.include` and `options.exclude` as usual for any Rollup plugin. The `options.plugins` option is passed to PostHTML directly.

**Params**

* `options` **{Object}**: optional, passed directly to posthtml    
* `returns` **{Object}**: a Rollup plugin  

**Example**

```js
import posthtml from 'rollup-plugin-posthtml'

import sugarml from 'posthtml-sugarml'
import customElements from 'posthtml-custom-elements'

export default {
  entry: 'foo/bar/main.js',
  plugins: [
    posthtml({
      parser: sugarml(),
      plugins: customElements()
    })
  ]
}
```

### File emission

By default, processed code will be emitted as an ES module. In a such way, it will be wrapped with `export default` and provide a string when being imported. Usually it is expected behavior.
However, you may have a need to get an unwrapped result, for example, to pass it to another Rollup plugin. In this case you can simply disable `emitFile` option.
Let's have a look at the chaining PostHTML with a template compiler plugin:

```js
import dot from 'rollup-plugin-dot'
import htmlnano from 'htmlnano'

export default {
  entry: 'foo/bar/main.js',
  plugins: [
    posthtml({
      emitFile: false,
      plugins: [
         htmlnano()
      ]
    }),
    dot({
       templateSettings: {
         strip: false
       }
    })
  ]
}
```

## Related
- [dush-router](https://www.npmjs.com/package/dush-router): A simple regex-based router for `dush`, `base`, `minibase` and anything based on them. Works on Browser and Node.js | [homepage](https://github.com/tunnckocore/dush-router#readme "A simple regex-based router for `dush`, `base`, `minibase` and anything based on them. Works on Browser and Node.js")
- [dush-tap-report](https://www.npmjs.com/package/dush-tap-report): A simple TAP report producer based on event system. A plugin for `dush` event emitter or anything based on it | [homepage](https://github.com/tunnckocore/dush-tap-report#readme "A simple TAP report producer based on event system. A plugin for `dush` event emitter or anything based on it")
- [dush](https://www.npmjs.com/package/dush): Microscopic & functional event emitter in ~260 bytes, extensible through plugins. | [homepage](https://github.com/tunnckocore/dush#readme "Microscopic & functional event emitter in ~260 bytes, extensible through plugins.")
- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.")
- [posthtml-custom-elements](https://www.npmjs.com/package/posthtml-custom-elements): PostHTML plugin. Use HTML Custom Element now. | [homepage](https://github.com/posthtml/posthtml-custom-elements#readme "PostHTML plugin. Use HTML Custom Element now.")
- [posthtml-parser](https://www.npmjs.com/package/posthtml-parser): Parse HTML/XML to PostHTMLTree | [homepage](https://github.com/posthtml/posthtml-parser#readme "Parse HTML/XML to PostHTMLTree")
- [posthtml](https://www.npmjs.com/package/posthtml): HTML/XML processor | [homepage](https://github.com/posthtml/posthtml "HTML/XML processor")
- [sugarml](https://www.npmjs.com/package/sugarml): basic parser for whitespace-significant html | [homepage](https://github.com/reshape/sugarml "basic parser for whitespace-significant html")

## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue][open-issue-url].  
Please read the [contributing guidelines][contributing-url] for advice on opening issues, pull requests, and coding standards.  
If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io][codementor-url] too.

**In short:** If you want to contribute to that project, please follow these things

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md][changelogmd-url] and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.
2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section.
3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

## Building docs
Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that

```
$ npm install verbose/verb#dev verb-generate-readme --global && verb
```

_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._

## Running tests
Clone repository and run the following in that cloned directory

```
$ npm install && npm test
```

## Author
**Charlike Mike Reagent**

+ [github/tunnckoCore](https://github.com/tunnckoCore)
+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License
Copyright © 2017, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 02, 2017._  
_Project scaffolded using [charlike][] cli._

[always-done]: https://github.com/hybridables/always-done
[async-done]: https://github.com/gulpjs/async-done
[base]: https://github.com/node-base/base
[charlike]: https://github.com/tunnckocore/charlike
[commitizen]: https://github.com/commitizen/cz-cli
[dezalgo]: https://github.com/npm/dezalgo
[once]: https://github.com/isaacs/once
[posthtml]: https://github.com/posthtml/posthtml
[rollup]: https://github.com/rollup/rollup
[standard-version]: https://github.com/conventional-changelog/standard-version
[verb-generate-readme]: https://github.com/verbose/verb-generate-readme
[verb]: https://github.com/verbose/verb

[license-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/rollup-plugin-posthtml.svg

[downloads-url]: https://www.npmjs.com/package/rollup-plugin-posthtml
[downloads-img]: https://img.shields.io/npm/dt/rollup-plugin-posthtml.svg

[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/rollup-plugin-posthtml
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/rollup-plugin-posthtml.svg

[circle-url]: https://circleci.com/gh/tunnckoCore/rollup-plugin-posthtml
[circle-img]: https://img.shields.io/circleci/project/github/tunnckoCore/rollup-plugin-posthtml/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/rollup-plugin-posthtml
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/rollup-plugin-posthtml/master.svg?label=windows

[codecov-url]: https://codecov.io/gh/tunnckoCore/rollup-plugin-posthtml
[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/rollup-plugin-posthtml/master.svg?label=codecov

[daviddm-deps-url]: https://david-dm.org/tunnckoCore/rollup-plugin-posthtml
[daviddm-deps-img]: https://img.shields.io/david/tunnckoCore/rollup-plugin-posthtml.svg

[daviddm-devdeps-url]: https://david-dm.org/tunnckoCore/rollup-plugin-posthtml?type=dev
[daviddm-devdeps-img]: https://img.shields.io/david/dev/tunnckoCore/rollup-plugin-posthtml.svg

[ghtag-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/tags
[ghtag-img]: https://img.shields.io/github/tag/tunnckoCore/rollup-plugin-posthtml.svg?label=github%20tag

[npmv-url]: https://www.npmjs.com/package/rollup-plugin-posthtml
[npmv-img]: https://img.shields.io/npm/v/rollup-plugin-posthtml.svg?label=npm%20version

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[paypalme-url]: https://www.paypal.me/tunnckoCore
[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg

[czfriendly-url]: http://commitizen.github.io/cz-cli
[czfriendly-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[gkfriendly-url]: https://greenkeeper.io/
[gkfriendly-img]: https://img.shields.io/badge/greenkeeper-friendly-brightgreen.svg

[codementor-url]: https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github
[codementor-img]: https://img.shields.io/badge/code%20mentor-live%20session-brightgreen.svg

[istanbulcov-url]: https://twitter.com/tunnckoCore/status/841768516965568512
[istanbulcov-img]: https://img.shields.io/badge/istanbul-400%25-brightgreen.svg

[following-semver-url]: http://semver.org
[following-semver-img]: https://img.shields.io/badge/following-semver-brightgreen.svg

[strelease-url]: https://github.com/conventional-changelog/standard-version
[strelease-img]: https://img.shields.io/badge/using-standard%20version-brightgreen.svg

[supportchat-url]: https://gitter.im/tunnckoCore/support
[supportchat-img]: https://img.shields.io/gitter/room/tunnckoCore/support.svg

[bulgaria-url]: https://www.google.bg/search?q=Sofia%2C+Bulgaria "One of the top 10 best places for start-up business in the world, especially in IT technologies"

[changelogmd-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/CHANGELOG.md
[conventions-url]: https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md
[tunnckocore-twitter-url]: https://twitter.com/tunnckoCore
[opensource-project-url]: http://openopensource.org
[nyc-istanbul-url]: https://istanbul.js.org
[circle-ci-url]: https://circleci.com
[appveyor-ci-url]: https://appveyor.com
[codecov-coverage-url]: https://codecov.io
[semver-url]: http://semver.org
[eslint-url]: http://eslint.org
[conventional-messages-url]: https://github.com/conventional-changelog/conventional-changelog
[gk-integration-url]: https://github.com/integration/greenkeeper
[daviddm-url]: https://david-dm.org
[open-issue-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/issues/new
[contributing-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/CONTRIBUTING.md
[absolute-coverage-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/package.json