{"id":13437323,"url":"https://github.com/lavifb/todo_r","last_synced_at":"2025-03-19T06:31:00.370Z","repository":{"id":57670008,"uuid":"153329398","full_name":"lavifb/todo_r","owner":"lavifb","description":"Find all your TODO notes with one command!","archived":false,"fork":false,"pushed_at":"2022-05-13T15:49:53.000Z","size":417,"stargazers_count":36,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T11:45:59.635Z","etag":null,"topics":["cli","command-line","rust","tools"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/lavifb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-10-16T17:50:22.000Z","updated_at":"2024-11-01T17:31:29.000Z","dependencies_parsed_at":"2022-09-26T20:40:42.981Z","dependency_job_id":null,"html_url":"https://github.com/lavifb/todo_r","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavifb%2Ftodo_r","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavifb%2Ftodo_r/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavifb%2Ftodo_r/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lavifb%2Ftodo_r/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lavifb","download_url":"https://codeload.github.com/lavifb/todo_r/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244370952,"owners_count":20442319,"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":["cli","command-line","rust","tools"],"created_at":"2024-07-31T03:00:55.982Z","updated_at":"2025-03-19T06:30:58.430Z","avatar_url":"https://github.com/lavifb.png","language":"Rust","funding_links":[],"categories":["Applications","应用","应用 Applications","Rust"],"sub_categories":["Text processing","文本处理","文本处理 Text processing"],"readme":"Todo_r\n======\n[![Actions Status](https://github.com/lavifb/todo_r/workflows/Test%20Master/badge.svg)](https://github.com/lavifb/todo_r/actions)\n[![Build Status](https://travis-ci.com/lavifb/todo_r.svg?branch=master)](https://travis-ci.org/lavifb/todo_r)\n\n### Find all your notes with one command!\n\nTodo_r is a simple rust command line utility that keeps track of your todo items in code.\nIt is pronounced \"todoer\" like someone that does todos.\n\nFind all your TODO notes with one command!\n\nA lot is adapted from [leasot](https://github.com/pgilad/leasot) but runs much faster.\n\n## Installation\n\nThe latest release can be downloaded from the releases page.\n\nIf you use macOS Homebrew or Linuxbrew you can currently install the latest version using\n```console\n$ brew tap lavifb/todo_r https://github.com/lavifb/todo_r.git\n$ brew install todor\n```\n\n## Features\n\n- Reads TODO comments that are on their own line.\n```rust\n// TODO: do this\n/* TODO: do that */\n```\nNote: comments that are not on their own line are __not__ supported.\n\n- User references are tracked and can be found using `--user` flag.\n```rust\n// TODO(user1): item\n// TODO: tagging @user2 and @user3\n// TODO(user1): @user3 both are also found!\n```\nComments 1 and 3 are found with `todor -u user1`.\n\n- Custom tags can be searched using the `-t` flag.\n- Interactive mode for deleting comments is launched using the `-d` flag.\n- If files are not provided for input, todo_r searches the entire git repository.\n    - `.gitignore` files are respected\n    - More ignores can be added using `.todorignore` files that use the same syntax\n    - If you are not using git, you can instead use a `.todor` file in the root directory\n\n## Config files\nCreate a `.todor` file in the root of your workspace with `todor init`.\n\n`.todor` files can also used as a config file to set custom tags, comments types, output styles, etc.\n\nTodo_r also supports a global config file at `$XDG_CONFIG_HOME/todor/todor.conf` (default `~/.config/todor/todor.conf`) for Mac/Linux and `~\\AppData\\Roaming\\lavifb\\todor\\todor.conf` on Windows.\n\nA deeper explanation of config files can be found at [config.md](https://github.com/lavifb/todo_r/blob/master/config.md).\n\n## Default Language Support\nThese common languages are supported by default.\nMore support can be added using config files above.\n\n| Filetype    | Extensions          | Comment Types |\n|-------------|---------------------|---------------|\n|C/C++        |`.c`,`.h`,`.cpp`     |`//`,`/* */`   |\n|C#           |`.cs`                |`//`,`/* */`   |\n|CoffeeScript |`.coffee`            |`#`            |\n|Go           |`.go`                |`//`,`/* */`   |\n|Haskell      |`.hs`                |`--`           |\n|HTML         |`.html`,`.htm`       |`\u003c!-- --\u003e`     |\n|Java         |`.java`              |`//`,`/* */`   |\n|JavaScript   |`.js`,`.es`,`.es6`   |`//`,`/* */`   |\n|Obj-C/C++    |`.m`,`.mm`           |`//`,`/* */`   |\n|Less         |`.less`              |`//`,`/* */`   |\n|Markdown     |`.md`                |`\u003c!-- --\u003e`     |\n|Perl         |`.pl`,`.pm`          |`#`            |\n|PHP          |`.php`               |`//`,`/* */`   |\n|Python       |`.py`                |`#`,`\"\"\" \"\"\"`  |\n|Ruby         |`.rb`                |`#`            |\n|Rust         |`.rs`                |`//`,`/* */`   |\n|Sass         |`.sass`,`scss`       |`//`,`/* */`   |\n|Scala        |`.scala`             |`//`,`/* */`   |\n|Shell        |`.sh`,`.bash`,`.zsh` |`#`            |\n|SQL          |`.sql`               |`--`,`/* */`   |\n|Stylus       |`.styl`              |`//`,`/* */`   |\n|Swift        |`.swift`             |`//`,`/* */`   |\n|TeX          |`.tex`               |`%`            |\n|TypeScript   |`.ts`,`.tsx`         |`//`,`/* */`   |\n|YAML         |`.yaml`,`.yml`       |`#`            |\n\nIf there are any more languages/extensions that you feel should supported by default, feel free to submit an issue/pull request.\n\n---\nwritten by Lavi Blumberg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flavifb%2Ftodo_r","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flavifb%2Ftodo_r","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flavifb%2Ftodo_r/lists"}