rollup-plugin-inline-postcss
v3.0.1
Published
Rollup plugin that transforms inline styling with PostCSS
Downloads
54
Readme
rollup-plugin-inline-postcss
Rollup plugin that transforms inline styling with PostCSS
Install
npm i rollup-plugin-inline-postcss --save-dev
yarn add rollup-plugin-inline-postcss --dev
Usage
import resolve from 'rollup-plugin-node-resolve';
import inlinePostCSS from 'rollup-plugin-inline-postcss';
export default {
input: 'src/main.js',
plugins: [resolve(), inlinePostCSS()],
};
Options
| Property | Description |
| -------------- | ------------------------------------------------------------------------ |
| configPath | Path to directory that contains postcss.config.js |
| env | Environment variable, defaults to process.env.NODE_ENV
where available |
| exclude | Files to exclude |
| failOnError | Allows errors to propagate when true
, otherwise warnings are thrown |
| from | Input file name (usually set by rollup) |
| include | Files to include |
| plugins | Array of PostCSS plugins, defaults to postcss.config.js
|
| styleDelimiter | Custom delimiter for parsing styles in a file, default is /`/ |
| styleRegex | Custom regex for selecting CSS in file |
| to | Output file name (usually set by rollup) |
Template Literals in JavaScript
This plugin by default looks for a template literal in JavaScript (or TypeScript) and will process CSS found inside of the string. This is particularly useful for Web Components or other CSS in JavaScript situations. The default pattern is below. The regex can be configured by passing the styleRegex property in the plugin options.
css`
:host {
display: block;
background: rgba(24, 24, 24, 1);
width: 200px;
height: 200px;
color: white;
padding: 1em;
border-radius: 8px;
}
`
The default regex for selecting template literals in a file is:
/(?:css`)((.|\n)+?)(?=(`(\n|;|,)))/gi;
The lookahead in the above RegExp statement allows for multiple matches of styles in the same file.
Customize the regex that is used to parse inline CSS with the styleRegex
and styleDelimiter
options.
For example, to parse inline <style>
tags:
inlinePostCSS({
styleRegex: /(?:<style>)((.|\n)+?)(?=(<\/style>))/gi,
styleDelimiter: /<\/?style>/g,
});
postcss.config.js
This plugin honors postcss.config.js
in the root directory and will look for environment variables based on the current NODE_ENV
. The example postcss.config.js below demonstrates minifying CSS with the postcss-csso
plugin only when the NODE_ENV is set to prod
.
module.exports = (ctx) => ({
plugins: {
'postcss-csso': ctx.env === 'prod' ? {} : false,
},
});
Development
npm run build
compiles the plugin.
npm run test
runs the tests.
npm run version
versions the package, run with SEMVER
environment variable et to either patch
, minor
, or major
.