Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test updates for #72 #75

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ dist/
.vsixmanifest
vsc-todo-highlight.code-workspace
todo-highlight.code-workspace
.vscode-test-web/
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Change Log
To update to the latest version, please use VSCode's own Extensions user interface.

## 2.1.0 beta - 2023-04-21
- a private beta release to check changes made for issue [#72](https://github.com/jgclark/vscode-todo-highlight/issues/72):
- `todohighlight.include` is now dropped.
- `todohighlight.includedLanguages` is now included as an optional list of languageIds where highlighting will be turned on (e.g. `["typescript", "go"]`). If empty, then all open files will be highlighted.
- `todohighlight.exclude` is now called `todohighlight.excludedFiles`. It remains an array of strings of glob pattern that defines files and folders where highlighting will not be turned on.

## 2.0.8 - 2023-04-12
- an interim release that bundles up existing merged PRs, mostly from security updates in dependencies. Including
- Include and exclude options (issue #42, thanks to PR #66 by @yuriykis)
Expand Down
33 changes: 5 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The [source code is available on GitHub](https://github.com/jgclark/vscode-todo-

To customize the keywords and other settings, <kbd>command</kbd> + <kbd>,</kbd> (or on Windows / Linux: File -> Preferences -> User Settings) to open the VSCode file `settings.json`.

| | type | default | description |
| Setting | Type | Default | Description |
| ------------------------------- | ------- | --------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| todohighlight.isEnable | boolean | true | Toggle the highlight, default is true. |
| todohighlight.enableDiagnostics | boolean | true | Enable creating diagnostic entries for open files in the problems view. Default is false. |
Expand All @@ -46,16 +46,8 @@ To customize the keywords and other settings, <kbd>command</kbd> + <kbd>,</kbd>
| 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/docs/extensionAPI/vscode-api) |
| todohighlight.maxFilesForSearch | number | 5120 | Max files for searching, mostly you don't need to configure this. |
| todohighlight.toggleURI | boolean | false | If the file path within the output channel is not clickable, set this to true to toggle the path pattern between `<path>#<line>` and `<path>:<line>:<column>`. |

<br/>

**Note:** Explicitly specifying `include` or `exclude` patterns will override the default settings, so if you want to add new patterns, and also use the defaults, you will need to include the default patterns as well. Better way to accomplish this would be to open Settings (UI) and "Add Item" in these fields from there at least once, before changing in Settings (JSON).
<br/>

| | type | default | description |
| ------------------------------- | ------- | --------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| todohighlight.include | array | [<br>`"**/*.js"`,<br>`"**/*.jsx"`,<br>`"**/*.ts"`,<br>`"**/*.tsx",`<br>`"**/*.html"`,<br>`"**/*.php"`,<br>`"**/*.css",`<br>`"**/*.scss"`<br>] | Glob patterns that defines the files to search for. **Please add other file types you need,** but for performance reasons and to avoid binary files do **not** use `{**/*.*}`. <br> Keep in mind the above note. |
| todohighlight.exclude | array | [<br>`"**/node_modules/**"`,<br>`"**/dist/**",`<br>`"**/bower_components/**"`,<br>`"**/build/**",`<br>`"**/.vscode/**"`,<br>`"**/.github/**"`,<br>`"**/_output/**"`,<br>`"**/*.min.*"`,<br>`"**/*.map"`<br>] | Glob pattern that defines files and folders to exclude while listing annotations. <br> Keep in mind the above note. |
| todohighlight.includedLanguages | array | [] | Optional list of language ids where highlighting will be turned on. If empty, then all open files will be highlighted. (E.g. `["typescript", "go"]`.) |
| todohighlight.excludedFiles | array | [<br>`"**/node_modules/**"`,<br>`"**/dist/**",`<br>`"**/bower_components/**"`,<br>`"**/build/**",`<br>`"**/.vscode/**"`,<br>`"**/.github/**"`,<br>`"**/_output/**"`,<br>`"**/*.min.*"`,<br>`"**/*.map"`<br>] | Glob pattern that defines files and folders where highlighting will not be turned on.<br> **Note:** Explicitly specifying `excludedFiles` patterns will override the default settings, so if you want to add new patterns, and also use the defaults, you will need to include the default patterns as well. The better way to accomplish this is to open Settings (UI) and "Add Item" in these fields from there at least once, before changing in Settings (JSON). |

An example of a custom configuration, showing a range of the different features:

Expand Down Expand Up @@ -127,24 +119,9 @@ An example of a custom configuration, showing a range of the different features:
"isWholeLine": false,
//other styling properties goes here ...
},
"todohighlight.include": [
"**/*.js",
"**/*.jsx",
"**/*.ts",
"**/*.tsx",
"**/*.html",
"**/*.php",
"**/*.css",
"**/*.scss",
"**/*.md",
"**/*.mmd",
"**/*.markdown",
"**/*.mdown",
"**/*.txt",
"**/*.rb",
"**/*.go"
"todohighlight.includedLanguages": [
],
"todohighlight.exclude": [
"todohighlight.excludedFiles": [
"**/node_modules/**",
"**/bower_components/**",
"**/dist/**",
Expand Down
Loading