https://github.com/tiaanduplessis/todobru

Scan project for TODOs, FIXMEs, HACKs or whatever
https://github.com/tiaanduplessis/todobru

fixme fs hack readdir too

Last synced: 10 months ago
JSON representation

Scan project for TODOs, FIXMEs, HACKs or whatever

• Host: GitHub
• URL: https://github.com/tiaanduplessis/todobru
• Owner: tiaanduplessis
• License: mit
• Created: 2018-11-17T14:35:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-02T22:44:21.000Z (about 7 years ago)
• Last Synced: 2024-09-30T06:29:25.003Z (over 1 year ago)
• Topics: fixme, fs, hack, readdir, too
• Language: JavaScript
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# todobru

[![package version](https://img.shields.io/npm/v/todobru.svg?style=flat-square)](https://npmjs.org/package/todobru)

[![package downloads](https://img.shields.io/npm/dm/todobru.svg?style=flat-square)](https://npmjs.org/package/todobru)

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

[![package license](https://img.shields.io/npm/l/todobru.svg?style=flat-square)](https://npmjs.org/package/todobru)

[![make a pull request](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> Scan project for TODOs, FIXMEs, HACKs or whatever

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [Contribute](#contribute)

- [License](#License)

## Install

This project uses [node](https://nodejs.org) and [npm](https://www.npmjs.com). 

```sh

$ npm install todobru

$ # OR

$ yarn add todobru

```

## Usage

```js

const todobru = require('todobru')

console.log(todobru())

// [ [ { base: '/Users/tiaan/code/todobru',

//       name: 'parse-flags.js',

//       ext: '.js',

//       size: 1344,

//       content:

//        ,

//       flag: 'FIXME',

//       desc: 'Eat some food',

//       tags: [],

//       pairs: [Object] },

//     { base: '/Users/tiaan/code/todobru',

//       name: 'parse-flags.js',

//       ext: '.js',

//       size: 1344,

//       content:

//        ,

//       flag: 'FIXME',

//       desc: 'Eat some food',

//       tags: [],

//       pairs: [Object] },

//     { base: '/Users/tiaan/code/todobru',

//       name: 'parse-flags.js',

//       ext: '.js',

//       size: 1344,

//       content:

//        ,

//       flag: 'FIXME',

//       desc: 'Eat some food',

//       tags: [],

//       pairs: [Object] },

//     { base: '/Users/tiaan/code/todobru',

//       name: 'parse-flags.js',

//       ext: '.js',

//       size: 1344,

//       content:

//        ,

//       flag: 'FIXME',

//       desc: 'Eat some food',

//       tags: [],

//       pairs: [Object] } ],

//   [ { base: '/Users/tiaan/code/todobru/node_modules/debug/src',

//       name: 'browser.js',

//       ext: '.js',

//       size: 4734,

//       content:

//        ,

//       flag: 'TODO',

//       desc:

//        'add a `localStorage` variable to explicitly enable/disable colors',

//       tags: [],

//       pairs: {} } ] ]

```

## Contribute

1. Fork it and create your feature branch: `git checkout -b my-new-feature`

2. Commit your changes: `git commit -am "Add some feature"`

3. Push to the branch: `git push origin my-new-feature`

4. Submit a pull request

## License

MIT