https://github.com/sublimelinter/sublimelinter-annotations
SublimeLinter plugin that marks annotations such as TODO, FIXME, etc.
https://github.com/sublimelinter/sublimelinter-annotations
Last synced: 12 months ago
JSON representation
SublimeLinter plugin that marks annotations such as TODO, FIXME, etc.
- Host: GitHub
- URL: https://github.com/sublimelinter/sublimelinter-annotations
- Owner: SublimeLinter
- License: mit
- Created: 2013-12-25T02:36:42.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-09-02T10:58:59.000Z (over 1 year ago)
- Last Synced: 2025-02-26T17:09:27.408Z (12 months ago)
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 106
- Watchers: 11
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SublimeLinter-annotations
=========================
[](https://travis-ci.org/SublimeLinter/SublimeLinter-annotations)
This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) highlights annotations in comments such as FIXME, NOTE, TODO, @todo, XXX, and README.
It will be used with all files.
## Installation
SublimeLinter must be installed in order to use this plugin.
Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
## Settings
- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html
Additional SublimeLinter-annotations settings:
|Setting|Description|
|:------|:----------|
|`warnings`|Comma-delimited list of words that will be highlighted as warnings.|
|`errors`|Comma-delimited list of words that will be highlighted as errors.|
|`infos`|Comma-delimited list of words that will be highlighted as infos.|
|`mark_message`|Whether the rest of the comment line should be marked or just the word.|
|`selector_` (*advanced*)| A scope selector for regions that the word lists will be searched in.|
Matching is case-sensitive and matches whole words.
For example:
```json
"linters": {
"annotations": {
"infos": ["NOTA BENE", "FYI"],
"warnings": ["FOO", "BAR"],
"errors": ["WHAT?", "OMG!"]
}
}
```