npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

posthtml-loader-2

v1.0.0

Published

PostHTML for Webpack

Downloads

3

Readme

npm node deps tests coverage code style chat

npm i -D html-loader posthtml-loader
import html from './file.html'

webpack.config.js

module: {
  rules: [
    {
      test: /\.html$/,
      use: [
        {
          loader: 'posthtml-loader',
          options: {
            parser: 'PostHTML Parser'
            plugins: [ /* PostHTML Plugins */ ]
            template: true
          }
        }
      ]
    }
  ]
},

|Name|Type|Default|Description| |:--:|:--:|:-----:|:----------| |parser|{String/Function}|undefined|PostHTML Parser| |render|{String/Function}|undefined|PostHTML Render| |config|{Object}|undefined|PostHTML Config posthtml.config.js| |plugins|{Array/Function}|[]|PostHTML Plugins| |template |{Boolean/String}|false|Export HTML Template {Function}|

Parser

If you want to use a custom parser, you can pass it in under the parser key in the loader options e.g SugarML

webpack.config.js

module: {
  rules: [
    {
      test: /\.ssml$/,
      use: [
        {
          loader: 'posthtml-loader',
          options: { parser: 'posthtml-sugarml' }
        }
      ]
    }
  ]
}

Plugins

Plugins are specified under the plugins key in the loader options

webpack.config.js

module: {
  rules: [
    {
      test: /\.html$/,
      use: [
        'html-loader',
        {
          loader: 'posthtml-loader',
          options: {
            plugins: () => [
              require('posthtml-plugin')()
            ]
          }
        }
      ]
    }
  ]
}

Config

If you want to use are shareable config file instead of inline options in your webpack.config.js create a posthtml.config.js file and placed it somewhere down the file tree in your project. The nearest config relative to dirname(file) currently processed by the loader applies. This enables Config Cascading. Despite some edge cases the config file will be loaded automatically and no additional setup is required. If you don't intend to use Config Cascading, it's recommended to place posthtml.config.js in the Root ./ of your project

|– src
|   |– components
|   |   |– component.html
|   |   |– posthtml.config.js (components)
|   |– index.html
|
|– posthtml.config.js (index)
|– webpack.config.js

posthtml.config.js

module.exports = ({ file, options, env }) => ({
  parser: 'posthttml-sugarml'
  plugins: {
    'posthtml-include': options.include
    'posthtml-content': options.content
    'htmlnano': env === 'production' ? {} : false
  }
})

webpack.config.js

{
  loader: 'posthtml-loader',
}

Path

If you normally place all your config files in a separate folder e.g './config' it is nessescary to explicitly set the config path in webpack.config.js

webpack.config.js

{
  loader: 'posthtml-loader',
  options: {
    config: { path: 'path/to/posthtml.config.js' }
  }
}

Context

|Name|Type|Default|Description| |:--:|:--:|:-----:|:----------| |env|{String}|'development'|process.env.NODE_ENV| |file|{Object}|dirname, basename, extname|File| |options|{Object}|{}|Plugin Options (Context)|

webpack.config.js

{
  loader: 'posthtml-loader',
  options: {
    ctx: {
      include: {...options}
      content: {...options}
    }
  }
}

posthtml.config.js

module.exports = ({ file, options, env }) => ({
  parser: 'posthttml-sugarml'
  plugins: {
    'posthtml-include': options.include
    'posthtml-content': options.content
    'htmlnano': env === 'production' ? {} : false
  }
})

Templates

By setting the template option the loader will export a {Function} instead of a {String} to enable templating via ES2015 Template Literals. By default locals/literals must are declared with an _ inside your HTML Templates, it is possible to override the selctor with a custom one by passing a string to the template option e.g { template: '$' }

template.html

<div>${ _.hello }</div>

webpack.config.js

{
  loader: 'posthtml-loader',
  options: {
    template: true
  }
}

template.js

import template from './template.html'

document.body.innerHTML = template({ hello: 'Hello World!' })