PostCSS Plugin Boilerplate
Сreate new PostCSS plugins in a few steps:
-
Clone this repository:
git clone https://github.com/postcss/postcss-plugin-boilerplate.git
-
Execute the wizard script. It will ask you a few questions and fill all files with your data.
node ./postcss-plugin-boilerplate/start
Call it with
--yarn
argument, if you prefer yarn package manager:node ./postcss-plugin-boilerplate/start --yarn
Or use
--no-install
if you want to skip dependencies installation. -
Your plugin repository will now have a clean Git history. Create the GitHub repository and push your project there.
-
Add your project to Travis CI.
-
Write some code to
index.js
and tests toindex.test.js
. -
Execute
npm test
command -
Add input and output CSS examples to
README.md
. -
Add options descriptions if your plugin has them.
-
Fill
CHANGELOG.md
with initial version. -
Release by calling
npx clean-publish
(this tool will remove development configs frompackage.json
). -
Fork PostCSS, add your plugin to the Plugins list and send a pull request.
-
Follow @PostCSS to get the latest updates.