ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-annotations

by SublimeLinter ST3

SublimeLinter 3 plugin that marks annotations such as TODO, FIXME, etc.

Details

Installs

  • Total 63K
  • Win 30K
  • OS X 20K
  • Linux 12K
Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8
Windows 23 21 31 32 27 33 39 53 20 31 37 26 34 49 29 26 15 29 29 33 26 28 18 28 27 40 50 48 38 36 25 40 44 46 43 52 21 35 32 69 52 40 18 23 33 35
OS X 3 13 7 15 24 26 22 24 18 18 13 17 15 26 22 22 12 24 19 15 27 15 10 20 15 19 16 19 29 12 10 13 29 27 28 32 13 18 44 56 42 19 11 9 8 19
Linux 3 16 13 17 14 16 18 17 3 14 9 15 13 7 13 8 11 8 18 22 20 13 10 10 11 15 5 20 14 9 11 13 14 22 24 10 14 8 19 31 15 8 5 5 8 10

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-annotations

Build Status

This linter plugin for SublimeLinter highlights annotations in comments such as FIXME, NOTE, TODO, @todo, XXX, and README. It will be used with all files.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type annotations. Among the entries you should see SublimeLinter-annotations. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-annotations provides its own 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.

You may provide a string with multiple words separated by commas or a list of strings. Matching is case-sensitive and matches whole words.

For example:

"linters": {
    "annotations": {
        "warnings": "[FOO], BAR",
        "errors": ["WHAT?", "OMG!"]
    }
}

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbrevations unless they are very well known.

Thank you for helping out!