{"id":23763592,"url":"https://github.com/tomashubelbauer/todo","last_synced_at":"2025-07-22T23:04:04.182Z","repository":{"id":56005122,"uuid":"313429090","full_name":"TomasHubelbauer/todo","owner":"TomasHubelbauer","description":"A utility to print to-do comments in the current directory recursively.","archived":false,"fork":false,"pushed_at":"2022-04-15T22:08:45.000Z","size":87,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-25T08:40:14.916Z","etag":null,"topics":["todo","todo-comment"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TomasHubelbauer.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-16T21:16:30.000Z","updated_at":"2022-04-16T23:16:28.000Z","dependencies_parsed_at":"2022-08-15T11:10:51.434Z","dependency_job_id":null,"html_url":"https://github.com/TomasHubelbauer/todo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TomasHubelbauer/todo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomasHubelbauer%2Ftodo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomasHubelbauer%2Ftodo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomasHubelbauer%2Ftodo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomasHubelbauer%2Ftodo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TomasHubelbauer","download_url":"https://codeload.github.com/TomasHubelbauer/todo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TomasHubelbauer%2Ftodo/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266586905,"owners_count":23952205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["todo","todo-comment"],"created_at":"2024-12-31T22:13:04.882Z","updated_at":"2025-07-22T23:04:04.143Z","avatar_url":"https://github.com/TomasHubelbauer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# To-Do\r\n\r\n[svg]: https://github.com/tomashubelbauer/todo/workflows/github-actions/badge.svg\r\n[![][svg]](https://github.com/TomasHubelbauer/todo/actions)\r\n\r\nA simple utility to print code to-do comments and unchecked MarkDown checkboxes.\r\n\r\n## Installation\r\n\r\n`npm i -g tomashubelbauer/todo` or `npx tomashubelbauer/todo`\r\n\r\n## Usage\r\n\r\n### CLI\r\n\r\n`todo`\r\n\r\n**This will read all files in the directory, including binary files, read on!**\r\n\r\nSample output:\r\n\r\n```\r\n./test.md:10 MarkDown checkbox\r\n./test.md:20 MarkDown sub-heading of \"To-Do\" heading\r\n./test.js:10 JavaScript comment\r\n./test.ps1:10 PowerShell comment\r\n```\r\n\r\nPass a regex to match paths against as a CLI argument. Prefix with a bang (`!`)\r\nto reverse the logic.\r\n\r\n`todo \"regex\"` or `todo \"!regex\"`\r\n\r\n- `!(\\.git$|node_modules)`: ignore `.git` and `node_modules` (default)\r\n- `.md$`: inspect only MarkDown files\r\n- `.(md|js)$`: inspect only MarkDown and JavaScript files\r\n- `!(\\.git$|node_modules|png$|jpg$|gif$)`: ignore default and images\r\n\r\nEscape the bang if you want to use a regex starting with one. This trade-off has\r\nbeen made to not force using negative lookahead syntax which is too confusing.\r\n\r\n### Node\r\n\r\n```\r\ngit submodule add https://github.com/tomashubelbauer/todo\r\n```\r\n\r\n```js\r\nimport todo from './todo/index.js';\r\n\r\nfor await (const item of todo()) {\r\n  console.log(item);\r\n}\r\n```\r\n\r\n## Development\r\n\r\n`npm test` to run tests or `node .` to run the app.\r\n\r\n### To-Do\r\n\r\n#### Allow ignoring specific lines\r\n\r\nThis should enable weeding out any false positives we encounter.\r\n\r\n#### Warn on unused ignore rules (maybe opt-in)\r\n\r\nThis should highlight ignore rules which are no longer needed.\r\n\r\n#### Reserve the MarkDown checkbox detection only for MarkDown files\r\n\r\nAt current, it also captures MarkDown fragments in JavaScript which I'm not 100%\r\nsure is what I want.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomashubelbauer%2Ftodo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomashubelbauer%2Ftodo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomashubelbauer%2Ftodo/lists"}