Create textlint rule project with no configuration.
JavaScript Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test feat(cli): add --yes Dec 13, 2016
.gitignore
.travis.yml Initial Commit Dec 13, 2016
LICENSE
README.md
package.json

README.md

create-textlint-rule Build Status

Create textlint rule with no configuration.

This command line tools generate textlint rule project files by one command.

Install

Install with npm:

npm install create-textlint-rule -g

Usage

Usage of create-textlint-rule command.

$ create-textlint-rule --help
Usage
  $ create-textlint-rule rule-name

Options
  --help  Show help
  --yarn  Use yarn for installing
  --yes   Pass --yes all for initializing process

Examples
  $ create-textlint-rule awesome-rule

Create textlint rule project by following command:

$ create-textlint-rule no-todo
#`textlint-rule-no-todo` project is created in current dir

You can start to develop textlint rule. (See textlint-scripts for more details.)

Build

Builds source codes for publish to the lib folder. You can write ES2015+ source codes in src/ folder.

npm run build

Tests

Run test code in test folder. Test textlint rule by textlint-tester.

npm test

Publish

Publish your rule to npm.

# Update version and git tag `patch` or `minor` or `major`
npm version {patch|minor|major}
npm publish

Next

You can learn to create textlint rule.

Reference

This Command line tools based on these project.

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu