Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 754 Bytes

README.md

File metadata and controls

31 lines (22 loc) · 754 Bytes
Raw

todo-md

A tool for the TODO.md standard

npx todomd lint
Linting TODO.md

[warn] Found todos in file!

Section
[warn] - [ ] This task is open @owner
[warn]   - [ ] And it has a subtask!
BACKLOG
[warn] - [ ] This task is postponed

Usage

  • npx todomd lint - lints TODO.md
  • npx todomd help - help
  • npx todomd help lint - help on linting
  • npx todomd lint -f README.md - find open tasks in README.md instead
  • npx todomd lint -f TODO.md -g npm-tasks.junit.xml - only use -f and -g together: compiles a gitlab report
  • npx todomd init - create an example TODO.md

Development

  • node index.mjs lint - lint the TODO.md
  • node index.mjs init - create an example TODO.md