https://github.com/jonchurch/print-todo

Print todos in code comments to console
https://github.com/jonchurch/print-todo

Last synced: 22 days ago
JSON representation

Print todos in code comments to console

• Host: GitHub
• URL: https://github.com/jonchurch/print-todo
• Owner: jonchurch
• License: mit
• Created: 2017-09-15T08:41:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-14T20:22:14.000Z (about 7 years ago)
• Last Synced: 2024-10-06T14:41:21.215Z (3 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Print TODO

Command line tool for formatting and outputting all TODO comments left in your code.

Currently the search string is `TODO`, taking the entire line after TODO

**`node_modules` and `.git` folders are currently ignored!**

![console output example](https://i.imgur.com/ncmiSx2.png)

### Setup

**In your code, leave TODO comments like this:**

```javascript

//TODO: Remove hardcoded api root before going into prod

var api_root = 'https://example.com'

function halfBaked() {} //TODO: flesh out halfBaked function

```

Install globally from NPM:

`npm i -g print`

### Usage

Run in current working directory without a directory arguement, or specify a folder to search through. Searches through folders recursively under the starting point, ignoring `node_modules` and `.git` folders

```bash

$ cd project-folder

$ printTodo

$ printTodo ~/Projects/project-folder

```

### Credit

This is based off of a [gist](https://gist.github.com/julianburr/5fa7d4e3e22773f035ee7a62e97f1d59) by [Julian Burr](https://github.com/julianburr). Thank you Julian!