/posthtml-postcss-modules

PostCSS CSS Modules Plugin

Primary LanguageJavaScriptMIT LicenseMIT

NPM Deps Tests Coverage XO Code Style

PostCSS Modules Plugin

A plugin to modules resources with ease

Install

npm i -D posthtml-postcss-modules

Usage

options = {
  root: './', // root path for links lookup
  from: '' // pathname to resolving file (it's always better to provide it)
  plugins: [], // postcss plugins to apply for every link
  generateScopedName: genericNames // function to process css names or string
};

Related

CSS Modules

Example

<!-- header.html -->
<link href="header.css" module/>

<style module>
  .navigation {height: 100px;}
</style>

<header classname="root">
  <nav classname="root navigation">
  </nav>
</header>
/* header.css */
.root {background-color: white;}
const { readFileSync } = require('fs')
const posthtml = require('posthtml')

posthtml()
  .use(require('posthtml-postcss-modules')({
    generateScopedName: '[hash:base64:5]'
  }))
  .process(readFileSync('header.html', 'utf8'))
  .then((result) => result)
  })
 <style>.wqroe {background-color: white;}</style>
 <style>._32Lja {height: 100px;}</style>

 <header class="wqroe">
    <nav class="wqroe _32Lja"></nav>
 </header>

LICENSE

MIT License (MIT)

Copyright (c) 2016 PostHTML Aleksandr Yakunichev

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.