{"id":16360513,"url":"https://github.com/kynikos/report-todo","last_synced_at":"2025-10-06T15:01:58.268Z","repository":{"id":39788177,"uuid":"245860815","full_name":"kynikos/report-todo","owner":"kynikos","description":"Generate reports of TODO, FIXME, BUG etc. comments across trees of source code or any text files.","archived":false,"fork":false,"pushed_at":"2023-01-12T23:57:16.000Z","size":2875,"stargazers_count":4,"open_issues_count":20,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-02T03:07:39.209Z","etag":null,"topics":["automation","bug","bug-tracker","comments","fixme","javascript","nodejs","parse","productivity","report-generator","reporter","reporting","reporting-tool","source-code","source-code-analysis","todo","todos"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/kynikos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-08T17:49:00.000Z","updated_at":"2024-09-25T12:45:41.000Z","dependencies_parsed_at":"2023-02-09T13:46:53.067Z","dependency_job_id":null,"html_url":"https://github.com/kynikos/report-todo","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/kynikos/report-todo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kynikos%2Freport-todo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kynikos%2Freport-todo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kynikos%2Freport-todo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kynikos%2Freport-todo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kynikos","download_url":"https://codeload.github.com/kynikos/report-todo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kynikos%2Freport-todo/sbom","scorecard":{"id":575548,"data":{"date":"2025-08-11","repo":{"name":"github.com/kynikos/report-todo","commit":"2810a1c84f4ae81c0eccf8480d180ea4c60e4f36"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"71 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-9mvj-f7w8-pvh2","Warn: Project is vulnerable to: GHSA-grw5-g9h2-wpg8","Warn: Project is vulnerable to: GHSA-mw6q-98mp-g8g8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-gxr4-xjj5-5px2","Warn: Project is vulnerable to: GHSA-jpcq-cgw6-v4j6","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-cwx2-736x-mf6w","Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf","Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c","Warn: Project is vulnerable to: GHSA-qvjc-g5vr-mfgr","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v","Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx","Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p","Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T17:36:12.608Z","repository_id":39788177,"created_at":"2025-08-20T17:36:12.609Z","updated_at":"2025-08-20T17:36:12.609Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278416327,"owners_count":25983192,"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-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["automation","bug","bug-tracker","comments","fixme","javascript","nodejs","parse","productivity","report-generator","reporter","reporting","reporting-tool","source-code","source-code-analysis","todo","todos"],"created_at":"2024-10-11T02:11:38.424Z","updated_at":"2025-10-06T15:01:58.230Z","avatar_url":"https://github.com/kynikos.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# report-todo\n\nGenerate reports of TODO, FIXME, BUG etc. comments across trees of text files.\n\n## Features:\n\n* Easy setup, as `report-todo` does not try to understand the grammar of the\n  used programming languages and detect comments, but it simply searches for\n  the configured tags naively, i.e. without regard for the used programming\n  language, and tries to detect the respective comments by looking at how lines\n  start\n* Support for multiline comments\n* Support for comment labels/tags\n* The Markdown report provides links to the files and lines where the comments\n  are found, giving a quick way to open them when using code editors that can\n  preview Markdown documents, for example Vim or Visual Studio Code\n* Both CLI command and Node.js API\n* Highly configurable\n\n------------\n\n## Quick installation and usage\n\n    $ npm install -g report-todo\n    $ report-todo my/project/directory/\n\n### ...but I don't want to install it system-wide!\n\n    $ cd my/project/directory/\n    $ npm install report-todo\n    $ npx report-todo\n\n### I use Arch Linux, can I use pacman?\n\nInstall the [report-todo](https://aur.archlinux.org/packages/report-todo)\npackage with your favorite\n[AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers).\n\nOtherwise follow the\n[manual instructions](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).\n\nThen just run the `report-todo` command.\n\n### I want JSON, not Markdown\n\n    $ report-todo -m json\n\n------------\n\n## Report examples\n\nThese are based on\n[src/DEMO.js](https://github.com/kynikos/report-todo/blob/master/aux/DEMO.js).\n\n### Markdown\n\n    $ report-todo aux/DEMO.js -m markdown\n\n```\n# Table of contents\n\n1. [#45](#1-0)\n2. [[NO LABEL]](#1-1)\n3. [defect](#1-2)\n4. [setup](#1-3)\n\n# #45\u003ca id=\"1-0\"\u003e\u003c/a\u003e\n\n| file path | line # | tag | labels | comment\n|:----------|:-------|:----|:-------|:-------\n| [./aux/DEMO.js](./aux/DEMO.js#L11) | 11 | BUG | defect,#45 | Solve this problem\u003cbr\u003eThis second line adds more details\u003cbr\u003eSo does this third line\n\n# [NO LABEL]\u003ca id=\"1-1\"\u003e\u003c/a\u003e\n\n| file path | line # | tag | labels | comment\n|:----------|:-------|:----|:-------|:-------\n| [./aux/DEMO.js](./aux/DEMO.js#L1) | 1 | TODO |  | Simple comment without labels\n\n# defect\u003ca id=\"1-2\"\u003e\u003c/a\u003e\n\n| file path | line # | tag | labels | comment\n|:----------|:-------|:----|:-------|:-------\n| [./aux/DEMO.js](./aux/DEMO.js#L11) | 11 | BUG | defect,#45 | Solve this problem\u003cbr\u003eThis second line adds more details\u003cbr\u003eSo does this third line\n\n# setup\u003ca id=\"1-3\"\u003e\u003c/a\u003e\n\n| file path | line # | tag | labels | comment\n|:----------|:-------|:----|:-------|:-------\n| [./aux/DEMO.js](./aux/DEMO.js#L6) | 6 | TODO | setup | I can make this do a lot more\u003cbr\u003eIt's all written here\n\n```\n\n### JSON\n\n    $ report-todo aux/DEMO.js -m json\n\n```\n[\n  {\n    \"type\": \"labels\",\n    \"key\": \"#45\",\n    \"matches\": [\n      {\n        \"filePath\": \"./aux/DEMO.js\",\n        \"tag\": \"BUG\",\n        \"startLineNo\": 11,\n        \"lines\": [\n          \"Solve this problem\",\n          \"This second line adds more details\",\n          \"So does this third line\"\n        ],\n        \"labels\": [\n          \"defect\",\n          \"#45\"\n        ]\n      }\n    ]\n  },\n  {\n    \"type\": \"labels\",\n    \"key\": \"[NO LABEL]\",\n    \"matches\": [\n      {\n        \"filePath\": \"./aux/DEMO.js\",\n        \"tag\": \"TODO\",\n        \"startLineNo\": 1,\n        \"lines\": [\n          \"Simple comment without labels\"\n        ],\n        \"labels\": []\n      }\n    ]\n  },\n  {\n    \"type\": \"labels\",\n    \"key\": \"defect\",\n    \"matches\": [\n      {\n        \"filePath\": \"./aux/DEMO.js\",\n        \"tag\": \"BUG\",\n        \"startLineNo\": 11,\n        \"lines\": [\n          \"Solve this problem\",\n          \"This second line adds more details\",\n          \"So does this third line\"\n        ],\n        \"labels\": [\n          \"defect\",\n          \"#45\"\n        ]\n      }\n    ]\n  },\n  {\n    \"type\": \"labels\",\n    \"key\": \"setup\",\n    \"matches\": [\n      {\n        \"filePath\": \"./aux/DEMO.js\",\n        \"tag\": \"TODO\",\n        \"startLineNo\": 6,\n        \"lines\": [\n          \"I can make this do a lot more\",\n          \"It's all written here\"\n        ],\n        \"labels\": [\n          \"setup\"\n        ]\n      }\n    ]\n  }\n]\n```\n\n------------\n\n## Command-line usage\n\nRunning the command without arguments will parse the files in and under the\ncurrent working directory:\n\n    $ report-todo\n\nThe above command is equivalent to:\n\n    $ report-todo ./\n\nPass multiple arguments to parse files under various patterns. Patterns are\nprocessed with [globby](https://github.com/sindresorhus/globby), which for\nexample also supports negative (exclude) matches by prefixing them with an\nexclamation mark. Some patterns are also excluded by default, see also the\n`--no-default-excludes` option. For example:\n\n    $ report-todo ./src ./docs !./test\n\nUse the `--help` option to print a quick usage guide and a list of all the\navailable CLI options:\n\n    $ report-todo --help\n\nOr, if locally installed in a directory:\n\n    $ npx report-todo --help\n\n### Options\n\n| Flag | Description |\n|------|-------------|\n| `-t, --tags \u003cTAG1,TAG2...\u003e` | comma-separated whitelist of tags to parse; default is \"TODO,FIXME,BUG\" |\n| `-l, --labels \u003cLABEL1,LABEL2...\u003e` | comma-separated whitelist of labels to include in the results; using an empty string in the list will also include results without labels; it is enough for a match with multiple labels to have only of them in the whitelist to be included in the results; default is to include all results regardless of their labels |\n| `--labels-delimiters \u003cOPEN,CLOSE\u003e` | two comma-separated strings that are used to enclose labels; default is \"[\" \"]\" |\n| `--labels-separator \u003cSEP\u003e` | string to be used to separate labels; default is \",\" |\n| `-b, --labels-is-blacklist` | treat --labels as a blacklist instead; using an empty string in --labels will exclude results without labels; it is enough for a match with multiple labels to have only of them in the --labels to be excluded from the results; --labels is a whitelist by default |\n| `-i, --case-insensitive` | parse tags and labels case-insensitively; default is to also match letter case |\n| `--ignore-line-comment \u003cCOMMENT\u003e` | the string to be appended to lines to exclude them from the results; default is \"report-todo-ignore-line\" |\n| `-m, --report-mode \u003cMODE\u003e` | the generated report mode; one of \"json\", \"markdown\"; more modes are available through the Node.js API; default is \"markdown\" |\n| `-g, --report-group-by \u003cKEY1,KEY2...\u003e` | comma-separated, ordered list of keys by which results are grouped and (possibly nested) report sections created; one or more of \"filePath\", \"tag\", \"startLineNo\", \"lines\", \"labels\"; default is \"labels\" |\n| `-s, --report-sort-by \u003cKEY1,KEY2...\u003e` | comma-separated, ordered list of keys by which results are sorted within report sections; one or more of \"filePath\", \"tag\", \"startLineNo\", \"lines\", \"labels\"; default is \"filePath,startLineNo\" |\n| `--report-links-prefix \u003cPREFIX\u003e` | reports that create links to the files will prefix their URLs with this string; nothing is prefixed by default |\n\n------------\n\n## Node.js API\n\nRequire the `reportTodo()` function from the `report-todo` module.\n\n```javascript\nconst {reportTodo} = require('report-todo')\n```\n\nThe `reportTodo()` function accepts two arguments:\n\n```javascript\nreportTodo(globs, options)\n```\n\n`globs` is a pattern or array of patterns that indicate the root paths under\nwhich files will be parsed. `globs` is processed by\n[globby](https://github.com/sindresorhus/globby), which for example also\nsupports negative (exclude) matches by prefixing them with an\nexclamation mark.\n\n`options` is an object of *key:value* configuration pairs:\n\n```javascript\nreportTodo(globs, {\n  tags,\n  labels,\n  labelsDelimiters,\n  labelsSeparator,\n  labelsIsBlacklist,\n  caseInsensitive,\n  ignoreLineComment,\n  reportMode,\n  reportGroupBy,\n  reportSortBy,\n  reportLinksPrefix,\n}\n```\n\n### Options\n\n| Key | Default | Description |\n|-----|---------|-------------|\n| `tags` | `[\"TODO\",\"FIXME\",\"BUG\"]` | array of tags to parse |\n| `labels` | `null` | whitelist array of labels to include in the results; adding `null` or an empty string in the array will also include results without labels; setting `labels=false` will only include results without labels; it is enough for a match with multiple labels to have only of them in the whitelist to be included in the results default is to include all results regardless of their labels |\n| `labelsDelimiters` | `[\"[\",\"]\"]` | array of two strings that are used to enclose labels |\n| `labelsSeparator` | `\",\"` | string to be used to separate labels |\n| `labelsIsBlacklist` | `false` | treat `labels` as a blacklist instead; using `null` or an empty string in `labels` will exclude results without labels; it is enough for a match with multiple labels to have only of them in the `labels` to be excluded from the results; `labels` is a whitelist by default |\n| `caseInsensitive` | `false` | parse tags and labels case-insensitively; default is to also match letter case |\n| `ignoreLineComment` | `\"report-todo-ignore-line\"` | the string to be appended to lines to exclude them from the results |\n| `reportMode` | `\"markdown\"` | the generated report mode; one of \"generator\", \"object\", \"json\", \"markdown\"; \"generator\" returns an asynchronous generator that yields results as they are found (files are opened asynchronously, so the order of the results is not guaranteed to be the same at every run); \"object\" returns a grouped and sorted JavaScript object; \"json\" returns a JSON string; \"markdown\" returns a Markdown document |\n| `reportGroupBy` | `[\"labels\"]` | ordered array of keys by which results are grouped and (possibly nested) report sections created; one or more of \"filePath\", \"tag\", \"startLineNo\", \"lines\", \"labels\" |\n| `reportSortBy` | `[\"filePath\",\"startLineNo\"]` | ordered array of keys by which results are sorted within report sections; one or more of \"filePath\", \"tag\", \"startLineNo\", \"lines\", \"labels\" |\n| `reportLinksPrefix` | `null` | reports that create links to the files will prefix their URLs with this string; nothing is prefixed by default |\n\n### Examples\n\nPre-grouped/sorted object:\n\n```javascript\nconst {reportTodo} = require('report-todo')\n\nreportTodo(`./src/`, {reportMode: 'object'}).then((report) =\u003e {\n  console.log(report)\n})\n```\n\nAsynchronous generator:\n\n```javascript\nconst {reportTodo} = require('report-todo')\n\nconst generator = reportTodo(`./src/`, {reportMode: 'generator'})\n\nfor await (const todo of generator) {\n  console.log(todo)\n}\n```\n\n------------\n\n## Todo match objects\n\nSome report modes such as `generator`, `object` and `json` list results\nas objects with the following keys:\n\n| Key             | Description                          |\n|-----------------|--------------------------------------|\n| `filePath`    | the file path                        |\n| `startLineNo` | the match's start line number        |\n| `tag`         | the matched tag                      |\n| `labels`      | array with the match's labels        |\n| `lines`       | array with the match's comment lines |\n\n------------\n\n## Similar projects\n\n* [Leasot](https://github.com/pgilad/leasot): the goal is similar, however\n  Leasot attempts to detect the comments according to the specific syntax of the\n  programming languages used in the parsed files.\n\n------------\n\n## License\n\nMIT, see [LICENSE](https://github.com/kynikos/report-todo/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkynikos%2Freport-todo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkynikos%2Freport-todo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkynikos%2Freport-todo/lists"}