https://github.com/textlint/textlint-rule-template-ts
TEMPLATE repository for textlint rule that is written by TypeScript
https://github.com/textlint/textlint-rule-template-ts
template textlint textlintrule typescript
Last synced: about 1 year ago
JSON representation
TEMPLATE repository for textlint rule that is written by TypeScript
- Host: GitHub
- URL: https://github.com/textlint/textlint-rule-template-ts
- Owner: textlint
- Created: 2019-10-19T15:06:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T05:18:16.000Z (over 1 year ago)
- Last Synced: 2024-10-24T23:14:12.545Z (over 1 year ago)
- Topics: template, textlint, textlintrule, typescript
- Language: TypeScript
- Size: 870 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# textlint-rule template
This is TEMPLATE REPOSITORY for creating textlint rule.
TypeScript version of
## Install
Requirements:
- Git
- Node.js 16+
- npm 8+
Use [create-textlint-rule](https://github.com/textlint/create-textlint-rule):
```
$ npx create-textlint-rule example --typescript
```
Or, Run following steps manually:
```sh
ruleName="textlint-rule-example"
git clone --depth=1 https://github.com/textlint/textlint-rule-template-ts.git ${ruleName}
cd ${ruleName}
# Initialize git
rm -rf .git/
rm -rf .github/
git init
# Initialize npm
npm init
npm install
# Initialize README
# Notice: force update exist README.md
./node_modules/.bin/textlint-scripts init
```
## Usage
See [textlint-scripts](https://github.com/textlint/textlint-scripts "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](https://github.com/textlint/textlint-tester "textlint-tester").
npm test
### Publish
Publish your rule to [npm](https://www.npmjs.com/).
# Update version and git tag `patch` or `minor` or `major`
npm version {patch|minor|major}
npm publish
## How to write textlint rule?
See documentation.
- [Creating Rules · textlint](https://textlint.github.io/docs/rule.html)