\n\n- Install\n- API Usage\n- CLI Usage\n\n[https://whatodo.io](https://whatodo.io) (coming soon)\n\nA TODO collector, organizer, and task manager\n\nDo you write `TODO` comments all over your code?\n\nI certainly do.\n\nWouldn't it be nice to pull those TODOs out and have priorities, links to where to your code, all ready to go?\n\n### Install\n\n`npm i -g whatodo`\n\nList priorities:\n\n- `// TODO: low priority`\n- `// TODO:: mid priority`\n- `// TODO::: high priority`\n\nNPM Problems?\n\nTry this: `sudo npm install -g whatodo --unsafe-perm --allow-root`\n\n### API Usage\n\nOptions:\n- `input` - input file or directory\n- `ignore` - array of files or directories to ignore\n- `ignoreExts` - array of extensions to ignore\n- `todoPattern` - regex pattern to search for (default: `'\\\\/\\\\/ ?TODO:?:?:? ?'`)\n- `outputFile` - specify the file where the todos are saved\n- `outputFormat` - format to export todos (`JSON`, `STDOUT`)\n- `maximumFileSize` - maximum file size to search (`1 KiB`, `1 Megabyte`, `2 MB`)\n\n```\n'use strict';\n\nconst Whatodo = require( 'whatodo' );\n\nnew Whatodo( {\n input: 'index.js',\n ignore: [ 'node_modules', '.git', '.idea', 'docs', 'build' ],\n ignoreExts: [ 'json', 'html', 'css', 'md' ],\n todoPattern: '\\\\/\\\\/ ?TODO:?:?:? ?',\n outputFile: 'todos.json',\n outputFormat: 'JSON',\n maximumFileSize: '1 MiB'\n} )\n .initialize()\n\t.then( inst => inst.run() )\n\t.then( inst => inst.save() )\n\t.catch( console.error );\n```\n\n### CLI Usage\n\nWrite your TODO comments throughout your code\n\nWhen ready, run the `todo` cli to collect your comments:\n\n### `todo -h`\n```\n \n Whatodo v0.3.0\n \n Whatodo is a NPM Module designed to quickly and efficiently extract your\n TODO comments from your code and organize them in a simple & readable format\n \n Usage:\n \n todo [input file/folder] [...options]\n \n Options:\n \n -h, --help show this help menu\n -v, --version show package version\n -i, --input directory or file to check TODOs (default: ./)\n -o, --output file to save TODOs (default: STDOUT)\n -f, --format format to save/print TODOs (default: STDOUT, JSON)\n -p, --pattern pattern to capture TODOs (default: \"\\/\\/ ?TODO:?:?:? ?\")\n -m, --maximum maximum file size allowed (default: \"1 MB\", 512KiB)\n \n```\n\n#### CLI usage print STDOUT\n\n##### `todo ./ -m 1KiB -p \"\\/\\/ ?TEST:?:?:? ?\"`\n\n```\nwhatodo/test/test.cc (118 μs - 182 bytes)\n [low] line: 1 - todo low priority\n [mid] line: 2 - todo mid priority\n [high] line: 3 - todo high priority\n\nTotal: 3\nHigh: 1\nMid: 1\nLow: 1\n```\n\n#### CLI usage print JSON format and save to file\n\n##### `todo ./ -f JSON -o todos.json -m 1KiB -p \"\\/\\/ ?TEST:?:?:? ?\"`\n\nSpecify:\n- JSON formatted output\n- Output file `todos.json`\n- Set a maximum search of 1 Kibibyte files\n- TODO search regex `\"\\/\\/ ?TEST:?:?:? ?\"`\n\nCreates a `TODOS.json` file:\n\n```\n[\n {\n \"file\": \"whatodo/test/test.cc\",\n \"timing\": \"120.263 μs\",\n \"todos\": [\n {\n \"priority\": \"LOW\",\n \"line\": 1,\n \"position\": 0,\n \"comment\": \"todo low priority\"\n },\n {\n \"priority\": \"MID\",\n \"line\": 2,\n \"position\": 0,\n \"comment\": \"todo mid priority\"\n },\n {\n \"priority\": \"HIGH\",\n \"line\": 3,\n \"position\": 0,\n \"comment\": \"todo high priority\"\n }\n ],\n \"size\": 182\n }\n]\n```\n\n#### Add todos to your `package.json -> \"scripts\"`\n\n```\n{\n\t\"scripts\": {\n\t\t\"todo\": \"./node_modules/whatodo/cli.js -i ./ -o TODOS.json -f JSON && ./node_modules/whatodo/cli.js\"`\n\t}\n}\n```\n\nThen run `npm run todo`!","maintainers":[{"name":"iskore","email":"development@dreamthegame.com"}],"time":{"modified":"2022-05-24T10:55:02.965Z","created":"2018-02-05T15:27:47.570Z","0.0.2":"2018-02-05T15:27:47.570Z","0.0.3":"2018-02-05T15:55:46.464Z","0.0.4":"2018-02-05T16:18:29.053Z","0.1.1":"2018-02-06T13:21:18.870Z","0.1.2":"2018-02-06T15:56:17.154Z","0.1.3":"2018-02-06T15:59:05.551Z","0.1.4":"2018-02-06T16:09:30.736Z","0.3.0":"2018-03-13T13:31:34.123Z","0.3.1":"2018-03-13T22:45:15.268Z","0.3.2":"2018-03-13T22:47:30.367Z","0.3.3":"2018-03-13T23:17:17.531Z","0.3.4":"2018-03-14T12:21:23.731Z","0.3.5":"2018-03-14T20:50:13.106Z","0.3.6":"2018-03-26T18:43:04.997Z","0.4.0":"2018-03-26T20:04:33.413Z","0.4.1":"2018-03-26T20:15:17.317Z","0.4.2":"2018-03-26T20:39:24.796Z","0.4.3":"2018-03-26T21:12:08.324Z","0.4.4":"2018-03-26T21:17:55.763Z","0.4.5":"2018-03-26T21:25:49.799Z","0.4.6":"2018-03-26T21:32:36.908Z","0.4.8":"2018-03-29T19:45:36.586Z","0.4.9":"2018-03-29T19:52:52.096Z","0.4.10":"2018-03-29T20:58:43.233Z","0.4.11":"2018-03-29T22:59:11.537Z","0.4.13":"2018-03-29T23:06:35.185Z","0.4.15":"2018-04-05T21:30:29.328Z","0.4.16":"2018-04-06T01:35:46.629Z","0.4.17":"2018-06-14T21:40:21.697Z","0.4.18":"2018-06-14T21:42:02.576Z","0.4.19":"2018-06-14T21:44:28.580Z","0.4.20":"2018-06-14T21:45:51.951Z","0.4.21":"2019-03-04T13:04:15.419Z"},"homepage":"https://github.com/Parellin-Technologies-LLC/whatodo#readme","keywords":["whatodo","todo","comments","tasks","organization"],"repository":{"type":"git","url":"git+https://github.com/Parellin-Technologies-LLC/whatodo.git"},"author":{"name":"Parellin Technologies LLC"},"bugs":{"url":"https://github.com/Parellin-Technologies-LLC/whatodo/issues"},"license":"MIT","readmeFilename":"README.md"}
![\"whatodo\"\n](\"./todo.png\")
\n \n