Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/postcss/postcss-plugin-boilerplate
PostCSS Plugin Boilerplate
https://github.com/postcss/postcss-plugin-boilerplate
Last synced: 5 days ago
JSON representation
PostCSS Plugin Boilerplate
- Host: GitHub
- URL: https://github.com/postcss/postcss-plugin-boilerplate
- Owner: postcss
- License: mit
- Created: 2015-02-10T07:06:08.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2023-12-03T05:41:19.000Z (about 1 year ago)
- Last Synced: 2024-10-29T14:38:23.341Z (4 months ago)
- Language: JavaScript
- Size: 244 KB
- Stars: 223
- Watchers: 12
- Forks: 53
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# PostCSS Plugin Boilerplate
Сreate new PostCSS plugins in a few steps:
1. Execute the wizard script. It will ask you a few questions
and fill all files with your data.
```sh
npx postcss-plugin-boilerplate
```
Call it with `--npm` argument, if you have [yarn](https://yarnpkg.com/) installed, but prefer to use npm as the package manager
(by default, it will automatically decide whether to use yarn or npm):
```sh
node postcss-plugin-boilerplate --npm
```
Or use `--no-install` if you want to skip dependencies installation.
2. Your plugin repository will now have a clean Git history.
[Create the GitHub repository](https://github.com/new)
and push your project there.
3. Add your project to [Travis CI](https://travis-ci.org).
4. Write some code to `index.js` and tests to `index.test.js`.
5. Execute `npm test` command
6. Add input and output CSS examples to `README.md`.
7. Add options descriptions if your plugin has them.
8. Fill `CHANGELOG.md` with initial version.
9. Release by calling `npx clean-publish`
(this tool will remove development configs from `package.json`).
10. Fork [PostCSS](https://github.com/postcss/postcss), add your plugin to the
[Plugins list](https://github.com/postcss/postcss/blob/main/docs/plugins.md)
and send a pull request.
11. Follow [@PostCSS](https://twitter.com/postcss) to get the latest updates.