{"id":15790979,"url":"https://github.com/rohit-gohri/danger-plugin-todos","last_synced_at":"2025-09-13T05:40:08.338Z","repository":{"id":38175364,"uuid":"214980362","full_name":"rohit-gohri/danger-plugin-todos","owner":"rohit-gohri","description":"A danger-js plugin to list all todos/fixmes/etc added/changed in a PR","archived":false,"fork":false,"pushed_at":"2023-01-05T06:14:10.000Z","size":1177,"stargazers_count":7,"open_issues_count":7,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T14:10:14.320Z","etag":null,"topics":["danger","danger-js","danger-js-plugin","danger-plugin","fixme","github-actions","gitlab","hacktoberfest","nodejs","todo","ts","typescript"],"latest_commit_sha":null,"homepage":"https://rohit.page/blog/projects/dangerjs-plugin-todos/?utm_source=github\u0026utm_medium=repo\u0026utm_campaign=hf","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rohit-gohri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-14T07:47:17.000Z","updated_at":"2025-01-07T20:38:50.000Z","dependencies_parsed_at":"2023-02-03T15:15:26.425Z","dependency_job_id":null,"html_url":"https://github.com/rohit-gohri/danger-plugin-todos","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohit-gohri%2Fdanger-plugin-todos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohit-gohri%2Fdanger-plugin-todos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohit-gohri%2Fdanger-plugin-todos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohit-gohri%2Fdanger-plugin-todos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rohit-gohri","download_url":"https://codeload.github.com/rohit-gohri/danger-plugin-todos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252967970,"owners_count":21833243,"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","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":["danger","danger-js","danger-js-plugin","danger-plugin","fixme","github-actions","gitlab","hacktoberfest","nodejs","todo","ts","typescript"],"created_at":"2024-10-04T22:41:22.460Z","updated_at":"2025-05-07T22:40:42.731Z","avatar_url":"https://github.com/rohit-gohri.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# danger-plugin-todos\n\n[![Build Status](https://github.com/rohit-gohri/danger-plugin-todos/workflows/Build/badge.svg?branch=master)](https://github.com/rohit-gohri/danger-plugin-todos/actions?query=branch%3Amaster)\n[![npm version](https://img.shields.io/npm/v/danger-plugin-todos)](https://www.npmjs.com/package/danger-plugin-todos)\n[![npm downloads](https://img.shields.io/npm/dm/danger-plugin-todos)](https://www.npmjs.com/package/danger-plugin-todos)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![License](https://img.shields.io/github/license/rohit-gohri/danger-plugin-todos)](https://github.com/rohit-gohri/danger-plugin-todos/blob/master/LICENSE.md)\n\nA [danger-js](https://danger.systems/js/) plugin to list all todos/fixmes/etc added/changed/removed in a PR.\n\n## Intro to Danger\n\nDanger is a tool to automate common code review practices. It can run as part of your CI pipeline and help maintain standards. Check out their github repo at [danger/danger-js](https://github.com/danger/danger-js). You can configure it using a `dangerfile`, which is a javscript or typescript file in the root of your project. It'll post it's results as a comment in the PRs of your project.\n\n## Usage\n\nTo use you must already have `danger-js` set up in your repo. \n\n### Install\n\n```sh\nyarn add danger-plugin-todos --dev\n# OR\nnpm i --save-dev danger-plugin-todos\n```\n\n### At a glance\n\n```js\n// dangerfile.js\nimport { schedule } from 'danger'\nimport todos from 'danger-plugin-todos'\n\n// Using schedule because this is an async task\nschedule(todos())\n\n\n// Optionally provide options\nschedule(todos({\n    ignore: ['CHANGELOG.md', /test/], // Any files to ignore, can be part of filename or regex pattern to match (default: [])\n    keywords: ['TODO', 'FIXME', 'TO-DO'], // Keywords to find (default: ['TODO', 'FIXME'])\n    repoUrl: 'https://github.com/rohit-gohri/danger-plugin-todos', // If using github provide the repo url (default: true - tries to pick from package.json -\u003e repository.url)\n}))\n\n\n// For other git providers (that don't follow github style links for files) provide a custom function to turn filepaths into links for the specific commit\nschedule(todos({\n    repoUrl: (filepath) =\u003e `https://custom-git-example.com/rohit-gohri/danger-plugin-todos/tree/${danger.git.commits[0].sha}/${filepath}`,\n}))\n\nschedule(todos({\n    repoUrl: false, // for using simple filepaths without links\n}))\n```\n\n### Results Preview\n\n#### Github\n\n![github example](./github-example.png)\n\n#### Gitlab\n\n![gitlab example](./gitlab-example.png)\n\n#### Bitbucket\n\nThis is an example for #4\n\n![bitbucket example](./bitbucket-example.png)\n\n## Changelog\n\nSee the GitHub [release history](https://github.com/rohit-gohri/danger-plugin-todos/releases).\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohit-gohri%2Fdanger-plugin-todos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frohit-gohri%2Fdanger-plugin-todos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohit-gohri%2Fdanger-plugin-todos/lists"}