Skip to content

Commit

Permalink
Add some usability notes to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
kaste committed Oct 9, 2024
1 parent 61038f1 commit d252274
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,46 @@ 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

```jsonc
// 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.)

0 comments on commit d252274

Please sign in to comment.