{"id":24983637,"url":"https://github.com/posthtml/rollup-plugin-posthtml","last_synced_at":"2025-06-22T11:08:24.422Z","repository":{"id":52654870,"uuid":"86656657","full_name":"posthtml/rollup-plugin-posthtml","owner":"posthtml","description":"PostHTML plugin for Rollup","archived":false,"fork":false,"pushed_at":"2021-08-22T07:18:22.000Z","size":65,"stargazers_count":5,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-14T01:22:30.767Z","etag":null,"topics":["plugins","posthtml","rollup","rollup-plugin"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/posthtml.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-30T03:52:41.000Z","updated_at":"2022-11-13T02:31:27.000Z","dependencies_parsed_at":"2022-08-21T14:00:20.326Z","dependency_job_id":null,"html_url":"https://github.com/posthtml/rollup-plugin-posthtml","commit_stats":null,"previous_names":["tunnckocore/rollup-plugin-posthtml"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/posthtml/rollup-plugin-posthtml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posthtml%2Frollup-plugin-posthtml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posthtml%2Frollup-plugin-posthtml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posthtml%2Frollup-plugin-posthtml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posthtml%2Frollup-plugin-posthtml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/posthtml","download_url":"https://codeload.github.com/posthtml/rollup-plugin-posthtml/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posthtml%2Frollup-plugin-posthtml/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260988379,"owners_count":23093485,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plugins","posthtml","rollup","rollup-plugin"],"created_at":"2025-02-04T09:19:56.575Z","updated_at":"2025-06-22T11:08:24.379Z","avatar_url":"https://github.com/posthtml.png","language":"JavaScript","readme":"# rollup-plugin-posthtml [![npm version][npmv-img]][npmv-url] [![github tags][ghtag-img]][ghtag-url] [![mit license][license-img]][license-url]\n\n\u003e PostHTML plugin for Rollup\n\nYou might also be interested in [posthtml](https://github.com/posthtml/posthtml).\n\n## Quality 👌\n\n\u003e By using [commitizen][czfriendly-url] and [conventional commit messages][conventional-messages-url], \nmaintaining meaningful [ChangeLog][changelogmd-url] \nand commit history based on [global conventions][conventions-url], \nfollowing [StandardJS][standard-url] code style through [ESLint][eslint-url] and\nhaving always up-to-date dependencies through integrations\nlike [GreenKeeper][gk-integration-url] and [David-DM][daviddm-url] service,\nthis package has top quality.\n\n[![code climate][codeclimate-img]][codeclimate-url] \n[![code style][standard-img]][standard-url] \n[![commitizen friendly][czfriendly-img]][czfriendly-url] \n[![greenkeeper friendly][gkfriendly-img]][gkfriendly-url] \n[![dependencies][daviddm-deps-img]][daviddm-deps-url] \n\u003c!-- uncomment when need --\u003e\n\u003c!-- [![develop deps][daviddm-devdeps-img]][daviddm-devdeps-url] --\u003e\n\n## Stability 💯\n\n\u003e By following [Semantic Versioning][semver-url] through [standard-version][] releasing tool, \nthis package is very stable and its tests are passing both on [Windows (AppVeyor)][appveyor-ci-url] \nand [Linux (CircleCI)][circle-ci-url] with results \nfrom 100% to [400%][absolute-coverage-url] test coverage, reported respectively\nby [CodeCov][codecov-coverage-url] and [nyc (istanbul)][nyc-istanbul-url].\n\n[![following semver][following-semver-img]][following-semver-url] \n[![semantic releases][strelease-img]][strelease-url] \n[![linux build][circle-img]][circle-url] \n[![windows build][appveyor-img]][appveyor-url] \n[![code coverage][codecov-img]][codecov-url] \n[![nyc coverage][istanbulcov-img]][istanbulcov-url] \n\n## Support :clap:\n\n\u003e If you have any problems, consider opening [an issue][open-issue-url],\nping me on twitter ([@tunnckoCore][tunnckocore-twitter-url]),\njoin the [support chat][supportchat-url] room\nor queue a [live session][codementor-url] on CodeMentor with me.\nIf you don't have any problems, you're using it somewhere or\nyou just enjoy this product, then please consider [donating some cash][paypalme-url] at PayPal,\nsince this is [OPEN Open Source][opensource-project-url] project made\nwith :heart: at [Sofia, Bulgaria][bulgaria-url] 🇧🇬.\n\n[![tunnckoCore support][supportchat-img]][supportchat-url] \n[![code mentor][codementor-img]][codementor-url] \n[![paypal donate][paypalme-img]][paypalme-url] \n[![NPM monthly downloads](https://img.shields.io/npm/dm/rollup-plugin-posthtml.svg?style=flat)](https://npmjs.org/package/rollup-plugin-posthtml) \n[![npm total downloads][downloads-img]][downloads-url] \n\n## Table of Contents\n- [Install](#install)\n- [Usage](#usage)\n- [API](#api)\n  * [rollupPluginPosthtml](#rolluppluginposthtml)\n  * [File emission](#file-emission)\n- [Related](#related)\n- [Contributing](#contributing)\n- [Building docs](#building-docs)\n- [Running tests](#running-tests)\n- [Author](#author)\n- [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\nInstall with [npm](https://www.npmjs.com/)\n\n```\n$ npm install rollup-plugin-posthtml --save\n```\n\nor install using [yarn](https://yarnpkg.com)\n\n```\n$ yarn add rollup-plugin-posthtml\n```\n\n## Usage\n\u003e For more use-cases see the [tests](test.js)\n\n```js\nconst rollupPluginPosthtml = require('rollup-plugin-posthtml')\n```\n\n## API\n\n### [rollupPluginPosthtml](index.js#L45)\n\u003e 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.\n\n**Params**\n\n* `options` **{Object}**: optional, passed directly to posthtml    \n* `returns` **{Object}**: a Rollup plugin  \n\n**Example**\n\n```js\nimport posthtml from 'rollup-plugin-posthtml'\n\nimport sugarml from 'posthtml-sugarml'\nimport customElements from 'posthtml-custom-elements'\n\nexport default {\n  entry: 'foo/bar/main.js',\n  plugins: [\n    posthtml({\n      parser: sugarml(),\n      plugins: customElements()\n    })\n  ]\n}\n```\n\n### File emission\n\nBy 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.\nHowever, 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.\nLet's have a look at the chaining PostHTML with a template compiler plugin:\n\n```js\nimport dot from 'rollup-plugin-dot'\nimport htmlnano from 'htmlnano'\n\nexport default {\n  entry: 'foo/bar/main.js',\n  plugins: [\n    posthtml({\n      emitFile: false,\n      plugins: [\n         htmlnano()\n      ]\n    }),\n    dot({\n       templateSettings: {\n         strip: false\n       }\n    })\n  ]\n}\n```\n\n## Related\n- [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\")\n- [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\")\n- [dush](https://www.npmjs.com/package/dush): Microscopic \u0026 functional event emitter in ~260 bytes, extensible through plugins. | [homepage](https://github.com/tunnckocore/dush#readme \"Microscopic \u0026 functional event emitter in ~260 bytes, extensible through plugins.\")\n- [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.\")\n- [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.\")\n- [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\")\n- [posthtml](https://www.npmjs.com/package/posthtml): HTML/XML processor | [homepage](https://github.com/posthtml/posthtml \"HTML/XML processor\")\n- [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\")\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue][open-issue-url].  \nPlease read the [contributing guidelines][contributing-url] for advice on opening issues, pull requests, and coding standards.  \nIf you need some help and can spent some cash, feel free to [contact me at CodeMentor.io][codementor-url] too.\n\n**In short:** If you want to contribute to that project, please follow these things\n\n1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md][changelogmd-url] and [.verb.md](.verb.md) files. See [\"Building docs\"](#building-docs) section.\n2. Ensure anything is okey by installing the dependencies and run the tests. See [\"Running tests\"](#running-tests) section.\n3. 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.\n4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.\n\nThanks a lot! :)\n\n## Building docs\nDocumentation 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\n\n```\n$ npm install verbose/verb#dev verb-generate-readme --global \u0026\u0026 verb\n```\n\n_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._\n\n## Running tests\nClone repository and run the following in that cloned directory\n\n```\n$ npm install \u0026\u0026 npm test\n```\n\n## Author\n**Charlike Mike Reagent**\n\n+ [github/tunnckoCore](https://github.com/tunnckoCore)\n+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)\n+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)\n\n## License\nCopyright © 2017, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 02, 2017._  \n_Project scaffolded using [charlike][] cli._\n\n[always-done]: https://github.com/hybridables/always-done\n[async-done]: https://github.com/gulpjs/async-done\n[base]: https://github.com/node-base/base\n[charlike]: https://github.com/tunnckocore/charlike\n[commitizen]: https://github.com/commitizen/cz-cli\n[dezalgo]: https://github.com/npm/dezalgo\n[once]: https://github.com/isaacs/once\n[posthtml]: https://github.com/posthtml/posthtml\n[rollup]: https://github.com/rollup/rollup\n[standard-version]: https://github.com/conventional-changelog/standard-version\n[verb-generate-readme]: https://github.com/verbose/verb-generate-readme\n[verb]: https://github.com/verbose/verb\n\n[license-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/LICENSE\n[license-img]: https://img.shields.io/npm/l/rollup-plugin-posthtml.svg\n\n[downloads-url]: https://www.npmjs.com/package/rollup-plugin-posthtml\n[downloads-img]: https://img.shields.io/npm/dt/rollup-plugin-posthtml.svg\n\n[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/rollup-plugin-posthtml\n[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/rollup-plugin-posthtml.svg\n\n[circle-url]: https://circleci.com/gh/tunnckoCore/rollup-plugin-posthtml\n[circle-img]: https://img.shields.io/circleci/project/github/tunnckoCore/rollup-plugin-posthtml/master.svg?label=linux\n\n[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/rollup-plugin-posthtml\n[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/rollup-plugin-posthtml/master.svg?label=windows\n\n[codecov-url]: https://codecov.io/gh/tunnckoCore/rollup-plugin-posthtml\n[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/rollup-plugin-posthtml/master.svg?label=codecov\n\n[daviddm-deps-url]: https://david-dm.org/tunnckoCore/rollup-plugin-posthtml\n[daviddm-deps-img]: https://img.shields.io/david/tunnckoCore/rollup-plugin-posthtml.svg\n\n[daviddm-devdeps-url]: https://david-dm.org/tunnckoCore/rollup-plugin-posthtml?type=dev\n[daviddm-devdeps-img]: https://img.shields.io/david/dev/tunnckoCore/rollup-plugin-posthtml.svg\n\n[ghtag-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/tags\n[ghtag-img]: https://img.shields.io/github/tag/tunnckoCore/rollup-plugin-posthtml.svg?label=github%20tag\n\n[npmv-url]: https://www.npmjs.com/package/rollup-plugin-posthtml\n[npmv-img]: https://img.shields.io/npm/v/rollup-plugin-posthtml.svg?label=npm%20version\n\n[standard-url]: https://github.com/feross/standard\n[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n\n[paypalme-url]: https://www.paypal.me/tunnckoCore\n[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg\n\n[czfriendly-url]: http://commitizen.github.io/cz-cli\n[czfriendly-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\n\n[gkfriendly-url]: https://greenkeeper.io/\n[gkfriendly-img]: https://img.shields.io/badge/greenkeeper-friendly-brightgreen.svg\n\n[codementor-url]: https://www.codementor.io/tunnckocore?utm_source=github\u0026utm_medium=button\u0026utm_term=tunnckocore\u0026utm_campaign=github\n[codementor-img]: https://img.shields.io/badge/code%20mentor-live%20session-brightgreen.svg\n\n[istanbulcov-url]: https://twitter.com/tunnckoCore/status/841768516965568512\n[istanbulcov-img]: https://img.shields.io/badge/istanbul-400%25-brightgreen.svg\n\n[following-semver-url]: http://semver.org\n[following-semver-img]: https://img.shields.io/badge/following-semver-brightgreen.svg\n\n[strelease-url]: https://github.com/conventional-changelog/standard-version\n[strelease-img]: https://img.shields.io/badge/using-standard%20version-brightgreen.svg\n\n[supportchat-url]: https://gitter.im/tunnckoCore/support\n[supportchat-img]: https://img.shields.io/gitter/room/tunnckoCore/support.svg\n\n[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\"\n\n[changelogmd-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/CHANGELOG.md\n[conventions-url]: https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md\n[tunnckocore-twitter-url]: https://twitter.com/tunnckoCore\n[opensource-project-url]: http://openopensource.org\n[nyc-istanbul-url]: https://istanbul.js.org\n[circle-ci-url]: https://circleci.com\n[appveyor-ci-url]: https://appveyor.com\n[codecov-coverage-url]: https://codecov.io\n[semver-url]: http://semver.org\n[eslint-url]: http://eslint.org\n[conventional-messages-url]: https://github.com/conventional-changelog/conventional-changelog\n[gk-integration-url]: https://github.com/integration/greenkeeper\n[daviddm-url]: https://david-dm.org\n[open-issue-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/issues/new\n[contributing-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/CONTRIBUTING.md\n[absolute-coverage-url]: https://github.com/tunnckoCore/rollup-plugin-posthtml/blob/master/package.json\n\n","funding_links":["https://www.paypal.me/tunnckoCore"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposthtml%2Frollup-plugin-posthtml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fposthtml%2Frollup-plugin-posthtml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposthtml%2Frollup-plugin-posthtml/lists"}