Code Monkey home page Code Monkey logo

textlint-rule-no-todo's Introduction

textlint-rule-no-todo Actions Status: test

This 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

textlint-rule-no-todo's People

Contributors

azu avatar davidsonfellipe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

textlint-rule-no-todo's Issues

Incorrectly reporting "todo" item

I have a list in my markdown and one of the list item is like this:

- A `rel` or `path` contains non-supported characters.

    This includes spaces, control characters, and unsafe URI characters, For example: ```$ & + , / : ; = ? @ < > # % { } | \ ^~ [ ] ` ' "``` returns an error.

The above list item gets reported as containing a TODO. It seems the rule is catching this because there's a [ ] in the description paragraph of that list item.

The rule should be looking for [ ] at the beginning of a list item in order for it to be really a TODO item.

Remove peerDependencies

peerDependencies textlint is not needed.
Because, @textlint/kernel run this rule without textlint module

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.