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

Sublime​Linter-contrib-codespell

by kaste ST3

Adapter for SublimeLinter to codespell

Labels linting, SublimeLinter, codespell

Details

  • 1.0.2
    1.0.1
  • github.​com
  • github.​com
  • 7 months ago
  • 1 month ago
  • 3 years ago

Installs

  • Total 396
  • Win 245
  • Mac 96
  • Linux 55
Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11
Windows 0 0 1 1 0 0 0 0 0 0 0 0 0 1 0 1 0 1 0 1 0 0 2 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 1 0 0 0
Mac 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-codespell

This linter plugin for SublimeLinter provides an interface to codespell.

Installation

SublimeLinter must be installed in order to use this plugin. Install via Package Control or git clone as usual.

Ensure that a codespell is actually installed somewhere on your system. Typically, 

pip install codespell

on the command line will do that.

Notes

This plugin registers codespell for all views. You can restrict that, e.g. you can set

"codespell": {
        "selector": "-text.plain",
    },

in SublimeLinter's main settings (Preferences: SublimeLinter Settings) to ignore plain text files. This can also be set per project or even per view under the setting name SublimeLinter.linters.codespell.selector.

Esp. for this linter I'm used to show the correct/fixed spelling on the ride side of the view. You can enable that via

"codespell": {
        "styles": [
            {
                "scope": "region.redish",  # any color you like
                "annotation": "{msg}",     # configure right hand side annotation
                "phantom": ""              # disable phantoms
            }
        ]
    },

There is also a quick-fix available if (and only if) codespell suggests exactly one other spelling. That means, if you have setup a key-binding, e.g. the one suggested in the SublimeLinter's README

Error: language “jsonc” is not supported
// To trigger a quick action
    // { "keys": ["ctrl+k", "ctrl+f"],
    //   "command": "sublime_linter_quick_actions"
    // },

you can basically fix a misspelled word on the line of the cursor by typing ctrl+k, ctrl+f. (You don't need to be on the word, btw! Handy.)