https://github.com/csstools/create-stylelint-plugin
Quickly create new stylelint plugins
https://github.com/csstools/create-stylelint-plugin
Last synced: 11 months ago
JSON representation
Quickly create new stylelint plugins
- Host: GitHub
- URL: https://github.com/csstools/create-stylelint-plugin
- Owner: csstools
- License: cc0-1.0
- Archived: true
- Created: 2018-09-25T19:53:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-10T11:44:08.000Z (almost 7 years ago)
- Last Synced: 2025-04-21T21:02:41.734Z (11 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Create Stylelint Plugin [
][PostCSS]
[![NPM Version][npm-img]][npm-url]
[![Build Status][cli-img]][cli-url]
[![Gitter Chat][git-img]][git-url]
[Create Stylelint Plugin] lets you quickly create new [stylelint] plugins.
```sh
npm init stylelint-plugin YOUR_DESTINATION
```
Alternatively, you can use the `npx` command:
```sh
npx create-stylelint-plugin YOUR_DESTINATION
```
After completing the instructions, write your plugin to `src/index.js` and
update `README.md` with further details outlining your plugin functionality.
## Usage
By default, **Create PostCSS Plugin** provides you the following prompts:
```
Plugin Name: [TITLE]
Keywords: [KEYWORDS]
```
Once completed, you will see the following message:
```
Success! Created PostCSS [TITLE] at [DIRECTORY]
We suggest that you begin by typing:
cd [DIRECTORY]
npm test
Happy PostCSS-ing!
```
To skip all prompts, you must at least provide a title and keywords.
```sh
create-stylelint-plugin --title Stuff --keywords comma,separated,keywords
```
If your system cannot access git user information from `.gitconfig`, you must
also provide an author, email, and user.
```sh
create-stylelint-plugin --title Stuff --author "Cee S Esse" --email "stylelint@stylelint.org" --user ceesesse --keywords comma,separated,keywords
```
[create-stylelint-plugin]: https://github.com/csstools/create-stylelint-plugin
[stylelint]: https://github.com/stylelint/stylelint