Skip to content

Commit

Permalink
Corrected heading
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbn committed Sep 10, 2019
1 parent 033ed22 commit 3f310b3
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions vscode/todo_tree_plugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Todo Tree Extension

This is a really nifty extension for **vscode**.

It lets you define tags in your code like `TODO` and `FIXME` (_the defaults_) which will then be highlighted in your code and will appear in a special sidebar section.

![Todo Tree screenshot example](todo-tree.png)

This is my configuration used for the above example.

```json
{
"todo-tree.autoRefresh": true,
"todo-tree.defaultHighlight": {
"type": "text-and-comment"
},
"todo-tree.customHighlight": {
"TODO": {
"foreground": "black",
"background": "green",
"iconColour": "green",
"icon": "check",
"type": "text"
},
"FIXME": {
"foreground": "black",
"background": "red",
"iconColour": "red",
"icon": "bug"
},
"REVIEW": {
"foreground": "black",
"background": "cyan",
"iconColour": "lightblue",
"icon": "eye"
},
"HACK": {
"foreground": "black",
"background": "#FFA500",
"iconColour": "orange",
"icon": "alert"
},
"REF": {
"foreground": "black",
"background": "grey",
"iconColour": "grey",
"icon": "link",
"type": "tag"
}
},
"todo-tree.tags": [
"TODO",
"FIXME",
"REVIEW",
"HACK",
"REF"
]
}
```

You can define you own tags and can assign, icons and colour schemes, based on your preferences.

## Resources:

- [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)

0 comments on commit 3f310b3

Please sign in to comment.