https://github.com/connoratherton/node-todo

https://github.com/connoratherton/node-todo

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/connoratherton/node-todo
• Owner: ConnorAtherton
• Created: 2014-08-23T13:49:04.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-30T23:24:23.000Z (over 9 years ago)
• Last Synced: 2024-09-18T19:59:51.458Z (about 2 months ago)
• Language: JavaScript
• Size: 168 KB
• Stars: 3
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This is a small module for collecting all the todos scattered

throughout a project and placing them in one easy to read file.

## Install

```js

npm install -g gen-todos

```

## What is this?

When I finish working for the day I write down what needs to be done

in the project for the next day so I don't forget. This inevitably leads

to wasted time the next day figuring out where to start instead of actually

starting.

Todos creates a single **todo.md** file at the root of a project to enable

individuals or teams to quickly start where they left off. This repo has its

own generated todos file. Go ahead and take a look at the format.

This is not designed to be a replacement for github issues in any way. Just an

easy way to remember little tasks that need to be done.

## Usage

```js

todos

```

There is one ignore flag which comes in useful.

```js

todos --ignore 'test/*'

```

Here is the command I used to generate the todo file for this project

```js

todos --ignore 'test, README.md'

```

## Formatting

Currently, it supports JavaScript/CoffeeScript style comments. These all work:

```js

// TODO example todo

// FIXME example todo

# TODO .coffee .rb comments

/* TODO example todo

 * TODO example todo

 */

/* FIXME example todo

 * FIXME example todo

 */

// Matches are case insensitive so this works too

// todo another todo

# FixMe pretty please

```