rollup-plugin-posthtml

    1.1.0 • Public • Published

    rollup-plugin-posthtml npm version github tags mit license

    PostHTML plugin for Rollup

    You might also be interested in posthtml.

    Quality 👌

    By using commitizen and conventional commit messages, maintaining meaningful ChangeLog and commit history based on global conventions, following StandardJS code style through ESLint and having always up-to-date dependencies through integrations like GreenKeeper and David-DM service, this package has top quality.

    code climate code style commitizen friendly greenkeeper friendly dependencies

    Stability 💯

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

    following semver semantic releases linux build windows build code coverage nyc coverage

    Support 👏

    If you have any problems, consider opening an issue, ping me on twitter (@tunnckoCore), join the support chat room or queue a live session 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 at PayPal, since this is OPEN Open Source project made with ❤️ at Sofia, Bulgaria 🇧🇬.

    tunnckoCore support code mentor paypal donate NPM monthly downloads npm total downloads

    Table of Contents

    (TOC generated by verb using markdown-toc)

    Install

    Install with npm

    $ npm install rollup-plugin-posthtml --save
    

    or install using yarn

    $ yarn add rollup-plugin-posthtml
    

    Usage

    For more use-cases see the tests

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

    API

    rollupPluginPosthtml

    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

    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:

    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

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
    Please read the contributing guidelines 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 too.

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

    1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
    2. Ensure anything is okey by installing the dependencies and run the tests. See "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.

    Running tests

    Clone repository and run the following in that cloned directory

    $ npm install && npm test
    

    Author

    Charlike Mike Reagent

    License

    Copyright © 2017, Charlike Mike Reagent. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.
    Project scaffolded using charlike cli.

    Install

    npm i rollup-plugin-posthtml

    DownloadsWeekly Downloads

    9

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    20.8 kB

    Total Files

    6

    Last publish

    Collaborators

    • scrum
    • vanchoy
    • tunnckocore