Create textlint rule with no configuration.
This command line tools generate textlint rule project files by one command.
Install with npm:
npm install --global create-textlint-rule
# Or
npx create-textlint-rule
Usage of create-textlint-rule
command.
Usage
$ create-textlint-rule rule-name
Options
--help Show help
--yarn Use yarn for installing
--typescript Create TypeScript project
--yes Pass --yes all for initializing process
Examples
# create textlint-rule-example directory and install
$ create-textlint-rule example
# install to current directory
$ create-textlint-rule .
# create textlint-rule-example directory is based on TypeScript
$ create-textlint-rule example --typescript
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.
For more details, see textlint-scripts.
Builds source codes for publish to the lib
folder.
You can write ES2015+ source codes in src/
folder.
npm run build
Run test code in test
folder.
Test textlint rule by textlint-tester.
npm test
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.
This Command line tools based on these project.
- textlint/textlint-rule-template: This is TEMPLATE REPOSITORY for creating textlint rule.
- JavaScript Template
- https://github.com/textlint/textlint-rule-template-ts#textlint-rule-template
- TypeScript Template
- textlint/textlint-scripts: textlint npm-run-scripts CLI help to create textlint rule.
- facebookincubator/create-react-app: Create React apps with no build configuration.
See Releases page.
Install devDependencies and Run npm test
:
npm i -d && npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
MIT © azu