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.

Labels linting, SublimeLinter

Details

Installs

  • Total 59K
  • Win 28K
  • OS X 19K
  • Linux 11K
Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6
Windows 3 24 36 30 36 36 31 21 22 33 43 38 34 38 24 20 44 38 42 46 30 24 19 45 43 40 41 38 19 23 35 40 34 41 42 17 22 40 31 33 28 33 28 29 27 36
OS X 6 9 10 22 19 17 22 10 13 16 27 23 20 22 6 11 16 24 23 19 19 14 15 11 13 14 15 20 7 6 12 18 12 19 18 7 12 28 14 27 17 21 10 10 19 14
Linux 3 8 13 10 8 11 18 10 9 8 11 12 8 9 8 9 13 8 17 15 11 6 6 11 15 16 16 14 5 8 13 16 7 19 18 8 5 6 19 9 10 9 11 4 10 16

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!