create-textlint-rule

Create textlint rule with no configuration.

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

Install

Install with npm:

npm install --global create-textlint-rule
# Or
npx create-textlint-rule

Usage

Usage of create-textlint-rule command.

Usage
  $ create-textlint-rule rule-name

Options
  --help  Show help
  --version  Show version
  --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.

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.

• textlint/README.md at master · textlint/textlint

Reference

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.

Changelog

See Releases page.

Running tests

This project uses pnpm. Install devDependencies and run pnpm test:

pnpm install && pnpm test

Release

Releases are published to npm via Trusted Publishing (OIDC).

1. Run the Create Release PR workflow and choose patch, minor, or major
2. Review and merge the created release PR (labeled Type: Release)
3. The Release workflow stages the package on npm and creates a GitHub Release
4. Approve the staged package on npm with 2FA to publish it

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

• github/azu
• twitter/azu_re

License

MIT © azu