todo-tree-config

settings.jsonc

{
	// If true, any subfolders containing a .git file will be ignored when searching.
	"todo-tree.filtering.ignoreGitSubmodules": true,
	// Add VSCode's `files.exclude` and/or `search.exclude` list to the ignored paths.
	//  - none: Don't used any built in excludes
	//  - file excludes: Use the Files:Exclude setting
	//  - search excludes: Use the Search:Exclude setting
	//  - file and search excludes: Use the Files:Exclude and the Search:Exclude setting
	"todo-tree.filtering.useBuiltInExcludes": "file and search excludes",
	// Set to true to enable automatic updates when files in the workspace are created, changed or deleted.
	"todo-tree.general.enableFileWatcher": true,
	// Path to use when exporting the tree. Environment variables will be expanded, e.g `${HOME}` and the path is passed through strftime (see <https://github.com/samsonjs/strftime>). Set the extension to `.json` to export as a JSON record.
	"todo-tree.general.exportPath": "~/todo-tree-%Y%m%d-%H%M.json",
	// Folder in which to run the search (defaults to the workspace folder).
	"todo-tree.general.rootFolder": "${workspaceFolder}",
	// What to show in the status bar - nothing, total count, counts per tag, top three counts per tag or count of tags in the current file.
	//  - none: Only show the scanning status in the status bar
	//  - total: Show the total count of tags in the status bar
	//  - tags: Show a breakdown of the count of each tag in the status bar
	//  - top three: Show the count of the top three tags in the status bar
	//  - current file: Show the count of tags in the current file in the status bar
	"todo-tree.general.statusBar": "current file",
	// A list of colours which is applied to tag highlights in the same order as the tags. Repeats if necessary and is overridden by `todo-tree.highlights.customHighlight`.
	"todo-tree.highlights.backgroundColourScheme": [],
	// Set to false to disable highlighting.
	"todo-tree.highlights.enabled": true,
	// Regular expression for processing the text to the right of the tag, e.g. for extracting a sub tag, or removing unwanted characters.
	"todo-tree.ripgrep.ripgrepArgs": "--max-columns=1000 --no-config",
	// Show a button in the tree view title bar to create a file showing the tree content.
	"todo-tree.tree.buttons.export": true,
	// Show a button in the tree view title bar to reveal the current item (only if track file is not enabled.)
	"todo-tree.tree.buttons.reveal": false,
	// When opening new workspaces, show the tree initially fully expanded.
	"todo-tree.tree.expanded": true,
	// Hide the view if it is empty.
	"todo-tree.tree.hideTreeWhenEmpty": false,
	"todo-tree.tree.tooltipFormat": "${line}, ${tag}",
	// Set highlights per tag (or tag group).
	"todo-tree.highlights.customHighlight": {
		"TODO": {
			"icon": "stop",
			"iconColour": "#B14345",
			"gutterIcon": true,
			"background": "#B14345",
			"foreground": "#CDC7E4",
			"fontWeight": "bold"
		},
		"NOTE": {
			"icon": "note",
			"iconColour": "#0F9CA9",
			"gutterIcon": true,
			"background": "#CDC7E4",
			"foreground": "#0F9CA9",
			"fontWeight": "normal",
			"fontStyle": "italic",
			"opacity": 20
		},
		"FIXME": {
			"icon": "beaker",
			"iconColour": "#E9A620",
			"gutterIcon": true,
			"background": "#E9A620",
			"foreground": "#1A2B34",
			"fontWeight": "bold",
			"opacity": 90
		},
		"BUG": {
			"icon": "bug",
			"iconColour": "#4BE765",
			"gutterIcon": true,
			"background": "#1A2B34",
			"foreground": "#4BE765",
			"fontWeight": "light"
		},
		"[ ]": {
			"background": "#1A2B34",
			"iconColour": "#B14345",
			"gutterIcon": true,
			"foreground": "#B14345",
			"fontWeight": "bold",
			"icon": "alert"
		},
		"[x]": {
			"background": "#CDC7E4",
			"iconColour": "#4BE765",
			"gutterIcon": true,
			"foreground": "#4BE765",
			"fontWeight": "bold",
			"icon": "check",
			"opacity": 40
		}
	},
	// Globs for use in limiting search results by exclusion (applied after **includeGlobs**), e.g. `["**/*.txt"]` to ignore all .txt files.
	"todo-tree.filtering.excludeGlobs": [
		"**/vendor",
		"**/node_modules",
		"**/dist",
		"**/bower_components",
		"**/build",
		"**/.vscode",
		"**/.github",
		"**/_output",
		"**/*.min.*",
		"**/*.map",
		"**/*.txt"
	],
	// Allows similar tags to be grouped under the same type, e.g. `{ "FIX": ["FIXME","FIXIT"] }`. *Note: All tags must also be in the `todo-tree.general.tags` tag list. If a tag group is defined, custom highlights apply to the group, not the tags within the group.*
	"todo-tree.general.tagGroups": {
		"FIXME": [
			"FIXME",
			"FIXIT",
			"FIX",
			"FIXTHIS",
			"FIX!",
			"NEEDSFIX",
			"FIXNOW",
			"MUSTFIX"
		],
		"TODO": ["TODO", "TO-DO", "NEEDSWORK", "DOTHIS", "WILLDO"],
		"BUG": ["BUG", "FOUNDBUG", "ISBUG", "BUGFIX", "ISBUGFIX", "XXX"],
		"NOTE": ["NOTE", "REMINDER", "CHECK", "HACK"],
		"[x]": ["[x]", "[X]"]
	},
	// Format of the TODO item labels. Available placeholders are ${line}, ${column}, ${tag}, ${before} (text from before the tag), ${after} (text from after the tag), ${filename}, ${filepath} and ${afterOrBefore} (use "after" text or "before" text if after is empty).
	"todo-tree.tree.labelFormat": "${line}, ${tag}, ${afterOrBefore}",
	// Set to true to show counts of TODOs in the tree.
	"todo-tree.tree.showCountsInTree": true,
	// Set to true if you want new views with tags only by default.
	"todo-tree.tree.tagsOnly": true,
	// The delay before highlighting (milliseconds).
	"todo-tree.highlights.highlightDelay": 1000,
	// This defines the regex used to locate TODOs. By default, it searches for tags in comments starting with //, #, ;, <!-- or /*. This should cover most languages. However if you want to refine it, make sure that the ($TAGS) is kept as ($TAGS) will be replaced by the expanded tag list. For some of the extension features to work, ($TAGS) should be present in the regex, however, the basic functionality should still work if you need to explicitly expand the tag list. The second part of the expression allows matching of Github markdown task lists.
	"todo-tree.regex.regex": "(//|#|<!--|;|/\\*|^|^\\s*(-|\\d+.))\\s*($TAGS)",
	// This defines the tags which are recognised as TODOs. This list is automatically inserted into the regex.
	"todo-tree.general.tags": [
		"BUG",
		"FOUNDBUG",
		"ISBUG",
		"BUGFIX",
		"ISBUGFIX",
		"XXX",
		"HACK",
		"TODO",
		"TO-DO",
		"NEEDSWORK",
		"DOTHIS",
		"WILLDO",
		"XXX",
		"NOTE",
		"[ ]",
		"[x]",
		"[X]",
		"FIXME",
		"FIXIT",
		"NEEDSFIX",
		"FIX",
		"FIXTHIS",
		"FIX!",
		"FIXNOW",
		"MUSTFIX",
		"NOTE",
		"REMINDER",
		"CHECK",
		"HACK"
	],
	// Editor schemes to find TODOs in. To find TODOs in settings files, for instance, add vscode-userdata or for output windows, add output
	"todo-tree.general.schemes": ["file", "ssh", "untitled", "vscode-userdata"]
}