INSTALL.md
3.66 KB
Installing PostCSS HWB Function
PostCSS HWB Function runs in all Node environments, with special instructions for:
Node | PostCSS CLI | Webpack | Create React App | Gulp | Grunt |
---|
Node
Add PostCSS HWB Function to your project:
npm install postcss @csstools/postcss-hwb-function --save-dev
Use it as a PostCSS plugin:
const postcss = require('postcss');
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
postcss([
postcssHWBFunction(/* pluginOptions */)
]).process(YOUR_CSS /*, processOptions */);
PostCSS CLI
Add PostCSS CLI to your project:
npm install postcss-cli @csstools/postcss-hwb-function --save-dev
Use PostCSS HWB Function in your postcss.config.js
configuration file:
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
module.exports = {
plugins: [
postcssHWBFunction(/* pluginOptions */)
]
}
Webpack
Webpack version 5
Add PostCSS Loader to your project:
npm install postcss-loader @csstools/postcss-hwb-function --save-dev
Use PostCSS HWB Function in your Webpack configuration:
module.exports = {
module: {
rules: [
{
test: /\.css$/i,
use: [
"style-loader",
{
loader: "css-loader",
options: { importLoaders: 1 },
},
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
[
"@csstools/postcss-hwb-function",
{
// Options
},
],
],
},
},
},
],
},
],
},
};
Create React App
Add React App Rewired and React App Rewire PostCSS to your project:
npm install react-app-rewired react-app-rewire-postcss @csstools/postcss-hwb-function --save-dev
Use React App Rewire PostCSS and PostCSS HWB Function in your
config-overrides.js
file:
const reactAppRewirePostcss = require('react-app-rewire-postcss');
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
module.exports = config => reactAppRewirePostcss(config, {
plugins: () => [
postcssHWBFunction(/* pluginOptions */)
]
});
Gulp
Add Gulp PostCSS to your project:
npm install gulp-postcss @csstools/postcss-hwb-function --save-dev
Use PostCSS HWB Function in your Gulpfile:
const postcss = require('gulp-postcss');
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
gulp.task('css', function () {
var plugins = [
postcssHWBFunction(/* pluginOptions */)
];
return gulp.src('./src/*.css')
.pipe(postcss(plugins))
.pipe(gulp.dest('.'));
});
Grunt
Add Grunt PostCSS to your project:
npm install grunt-postcss @csstools/postcss-hwb-function --save-dev
Use PostCSS HWB Function in your Gruntfile:
const postcssHWBFunction = require('@csstools/postcss-hwb-function');
grunt.loadNpmTasks('grunt-postcss');
grunt.initConfig({
postcss: {
options: {
processors: [
postcssHWBFunction(/* pluginOptions */)
]
},
dist: {
src: '*.css'
}
}
});