{"id":13702498,"url":"https://github.com/wayou/vscode-todo-highlight","last_synced_at":"2025-04-04T06:08:35.958Z","repository":{"id":14813592,"uuid":"77147863","full_name":"wayou/vscode-todo-highlight","owner":"wayou","description":"a vscode extension to highlighting todos, fixmes, and any annotations...","archived":false,"fork":false,"pushed_at":"2024-05-30T13:20:54.000Z","size":22318,"stargazers_count":532,"open_issues_count":118,"forks_count":104,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-28T05:09:54.261Z","etag":null,"topics":["annotation-processor","todo","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight","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/wayou.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-22T13:45:18.000Z","updated_at":"2025-03-20T20:04:29.000Z","dependencies_parsed_at":"2024-05-10T14:44:23.143Z","dependency_job_id":"718d6aa4-3ddc-42b1-a2f3-f241a863a3f9","html_url":"https://github.com/wayou/vscode-todo-highlight","commit_stats":{"total_commits":214,"total_committers":19,"mean_commits":"11.263157894736842","dds":"0.14018691588785048","last_synced_commit":"a6bbfce7f0ed7d271fa10baa115b995528a88570"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Fvscode-todo-highlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Fvscode-todo-highlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Fvscode-todo-highlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Fvscode-todo-highlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wayou","download_url":"https://codeload.github.com/wayou/vscode-todo-highlight/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128746,"owners_count":20888235,"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":["annotation-processor","todo","vscode-extension"],"created_at":"2024-08-02T21:00:36.619Z","updated_at":"2025-04-04T06:08:35.941Z","avatar_url":"https://github.com/wayou.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"VSCODE-TODO-HIGHLIGHT\n===\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/wayou/vscode-todo-highlight.svg?branch=master)](https://travis-ci.org/wayou/vscode-todo-highlight) [![Version](https://vsmarketplacebadge.apphb.com/version-short/wayou.vscode-todo-highlight.svg)](https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight) [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/wayou.vscode-todo-highlight.svg)](https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight) [![Ratings](https://vsmarketplacebadge.apphb.com/rating-short/wayou.vscode-todo-highlight.svg)](https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight)\n\nHighlight `TODO`, `FIXME` and other annotations within your code.\n\nSometimes you forget to review the TODOs you've added while coding before you publish the code to production.\nSo I've been wanting an extension for a long time that highlights them and reminds me that there are notes or things not done yet.\n\nHope this extension helps you as well.\n\n*NOTICE*\n\nMany report that the `List highlighted annotations` command is not working, make sure you have the file types included via `todohighlight.include`.\n\n\n### Preview\n\n- with `material night` color theme:\n![](https://github.com/wayou/vscode-todo-highlight/raw/master/assets/material-night.png)\n\n- with `material night eighties` color theme:\n![](https://github.com/wayou/vscode-todo-highlight/raw/master/assets/material-night-eighties.png)\n\n### Config\n\n`TODO:`,`FIXME:` are built-in keywords. You can override the look by customizing the setting.\n\nTo customize the keywords and other stuff, \u003ckbd\u003ecommand\u003c/kbd\u003e + \u003ckbd\u003e,\u003c/kbd\u003e (Windows / Linux: File -\u003e Preferences -\u003e User Settings) open the vscode file `settings.json`.\n\n| | type | default | description |\n|---|---|---|---|\n| todohighlight.isEnable | boolean | true | Toggle the highlight, default is true. |\n| todohighlight.isCaseSensitive  | boolean | true | Whether the keywords are case sensitive or not. |\n| todohighlight.keywords | array | N/A | An array of keywords that will be hilighted. You can also specify the style for each keywords here. See example below for more infomation. |\n| todohighlight.keywordsPattern  | string | N/A | Specify keywords via RegExp instead of `todohighlight.keywords` one by one. NOTE that if this presents, `todohighlight.keywords` will be ignored. And REMEMBER to escapse the back slash if there's any in your regexp (using \\\\ instead of signle back slash). |\n| todohighlight.defaultStyle | object | N/A | Specify the default style for custom keywords, if not specified, build in default style will be applied. [See all available properties on VSCode doc DecorationRenderOptions section](https://code.visualstudio.com/api/references/vscode-api#DecorationRenderOptions) |\n| todohighlight.include | array | [\u003cbr\u003e`\"**/*.js\"`,\u003cbr\u003e`\"**/*.jsx\"`,\u003cbr\u003e`\"**/*.ts\"`,\u003cbr\u003e`\"**/*.tsx\",`\u003cbr\u003e`\"**/*.html\"`,\u003cbr\u003e`\"**/*.php\"`,\u003cbr\u003e`\"**/*.css\",`\u003cbr\u003e`\"**/*.scss\"`\u003cbr\u003e] | Glob patterns that defines the files to search for. Only include files you need, DO NOT USE `{**/*.*}` for both permormance and avoiding binary files reason. \u003cbr\u003e For backwards compatability, a string combine all the patterns is also valid `\"{**/*.js,**/*.jsx,**/*.ts,**/*.tsx,**/*.html,**/*.php,**/*.css,**/*.scss}\"` |\n| todohighlight.exclude | array | [\u003cbr\u003e`\"**/node_modules/**\"`,\u003cbr\u003e`\"**/dist/**\",`\u003cbr\u003e`\"**/bower_components/**\"`,\u003cbr\u003e`\"**/build/**\",`\u003cbr\u003e`\"**/.vscode/**\"`,\u003cbr\u003e`\"**/.github/**\"`,\u003cbr\u003e`\"**/_output/**\"`,\u003cbr\u003e`\"**/*.min.*\"`,\u003cbr\u003e`\"**/*.map\"`\u003cbr\u003e] | Glob pattern that defines files and folders to exclude while listing annotations. \u003cbr\u003e For backwards compatability, a string combine all the patterns is also valid `\"{**/node_modules/**,**/bower_components/**,**/dist/**,**/build/**,**/.vscode/**,**/_output/**,**/*.min.*,**/*.map}\"` |\n| todohighlight.maxFilesForSearch | number | 5120 | Max files for searching, mostly you don't need to configure this. |\n| todohighlight.toggleURI | boolean | false | If the file path within the output channel not clickable, set this to true to toggle the path patten between `\u003cpath\u003e#\u003cline\u003e` and `\u003cpath\u003e:\u003cline\u003e:\u003ccolumn\u003e`. |\n\n\nan example of customizing configuration:\n\n```js\n{\n    \"todohighlight.isEnable\": true,\n    \"todohighlight.isCaseSensitive\": true,\n    \"todohighlight.keywords\": [\n        \"DEBUG:\",\n        \"REVIEW:\",\n        {\n            \"text\": \"NOTE:\",\n            \"color\": \"#ff0000\",\n            \"backgroundColor\": \"yellow\",\n            \"overviewRulerColor\": \"grey\"\n        },\n        {\n            \"text\": \"HACK:\",\n            \"color\": \"#000\",\n            \"isWholeLine\": false,\n        },\n        {\n            \"text\": \"TODO:\",\n            \"color\": \"red\",\n            \"border\": \"1px solid red\",\n            \"borderRadius\": \"2px\", //NOTE: using borderRadius along with `border` or you will see nothing change\n            \"backgroundColor\": \"rgba(0,0,0,.2)\",\n            //other styling properties goes here ... \n        }\n    ],\n    \"todohighlight.keywordsPattern\": \"TODO:|FIXME:|\\\\(([^)]+)\\\\)\", //highlight `TODO:`,`FIXME:` or content between parentheses\n    \"todohighlight.defaultStyle\": {\n        \"color\": \"red\",\n        \"backgroundColor\": \"#ffab00\",\n        \"overviewRulerColor\": \"#ffab00\",\n        \"cursor\": \"pointer\",\n        \"border\": \"1px solid #eee\",\n        \"borderRadius\": \"2px\",\n        \"isWholeLine\": true,\n        //other styling properties goes here ... \n    },\n    \"todohighlight.include\": [\n        \"**/*.js\",\n        \"**/*.jsx\",\n        \"**/*.ts\",\n        \"**/*.tsx\",\n        \"**/*.html\",\n        \"**/*.php\",\n        \"**/*.css\",\n        \"**/*.scss\"\n    ],\n    \"todohighlight.exclude\": [\n        \"**/node_modules/**\",\n        \"**/bower_components/**\",\n        \"**/dist/**\",\n        \"**/build/**\",\n        \"**/.vscode/**\",\n        \"**/.github/**\",\n        \"**/_output/**\",\n        \"**/*.min.*\",\n        \"**/*.map\",\n        \"**/.next/**\"\n    ],\n    \"todohighlight.maxFilesForSearch\": 5120,\n    \"todohighlight.toggleURI\": false\n}\n```\n\n### Commands\n\nThis extension contributes the following commands to the Command palette.\n\n- `Toggle highlight` : turn on/off the highlight\n![](https://github.com/wayou/vscode-todo-highlight/raw/master/assets/toggle-highlight.gif)\n- `List highlighted annotations` : list annotations and reveal from corresponding file\n![](https://github.com/wayou/vscode-todo-highlight/raw/master/assets/list-annotations.gif)\n\n\n### Known issue\n\n The clickable file pattern within the output channel differs from OS platform(`\u003cpath\u003e#\u003cline\u003e` for Mac/Windows and `\u003cpath\u003e:\u003cline\u003e:\u003ccolumn\u003e` for Linux, for details see this [issue](https://github.com/Microsoft/vscode/issues/586) ). \n\n Basically the extension auto detects the OS platform.\n\n If you find that the file path is not clickable, set `todohighlight.toggleURI` to `true` to toggle the file pattern.\n  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayou%2Fvscode-todo-highlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwayou%2Fvscode-todo-highlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayou%2Fvscode-todo-highlight/lists"}