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
  • 1 year ago
  • 3 hours ago
  • 4 years ago

Installs

  • Total 454
  • Win 280
  • Mac 109
  • Linux 65
Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17
Windows 0 0 0 0 0 0 0 3 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 1 0 0 0 0 0 0 1 0 0 1
Mac 0 0 0 0 0 0 0 0 0 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 0 0 0 0 0 0 0
Linux 0 0 0 1 0 0 0 0 0 1 0 0 1 0 1 0 0 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

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.)