https://github.com/textlint-rule/textlint-rule-no-todo

textlint rule that check TODO text.
https://github.com/textlint-rule/textlint-rule-no-todo

textlintrule

Last synced: 2 months ago
JSON representation

textlint rule that check TODO text.

• Host: GitHub
• URL: https://github.com/textlint-rule/textlint-rule-no-todo
• Owner: textlint-rule
• License: mit
• Created: 2015-08-27T13:26:30.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-05-17T22:15:56.000Z (about 3 years ago)
• Last Synced: 2025-04-23T01:16:50.022Z (2 months ago)
• Topics: textlintrule
• Language: JavaScript
• Homepage:
• Size: 41 KB
• Stars: 13
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# textlint-rule-no-todo [![Actions Status: test](https://github.com/textlint-rule/textlint-rule-no-todo/workflows/test/badge.svg)](https://github.com/textlint-rule/textlint-rule-no-todo/actions?query=workflow%3A"test")

This [textlint](https://github.com/textlint-rule/textlint "textlint") rule check `todo` mark.

**OK**:

```

This is text.

```

**NG**:

```

TODO: this is TODO

- [ ] TODO

```

## Installation

    npm install textlint-rule-no-todo

## Usage

    $ npm install textlint-rule-no-todo

    $ textlint --rule no-todo README.md

## Tests

    npm test

## Contributing

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

## License

MIT