Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tweekmonster/impsort.vim
Sort and highlight Python imports in Vim
https://github.com/tweekmonster/impsort.vim
highlight-python-imports highlighting import python sort vim vim-plugins
Last synced: 15 days ago
JSON representation
Sort and highlight Python imports in Vim
- Host: GitHub
- URL: https://github.com/tweekmonster/impsort.vim
- Owner: tweekmonster
- License: mit
- Created: 2016-05-31T05:35:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-05T19:12:36.000Z (almost 3 years ago)
- Last Synced: 2023-04-03T12:56:19.528Z (over 1 year ago)
- Topics: highlight-python-imports, highlighting, import, python, sort, vim, vim-plugins
- Language: Vim script
- Homepage:
- Size: 70.3 KB
- Stars: 37
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# impsort.vim
Vim utility for sorting and highlighting Python imports.
## Maintenance notice
This plugin is in maintenance mode. I still personally use this plugin, but I
would be more inclined to create a new plugin using [Tree-sitter][] (either
through Neovim or cli subprocess) before I'd consider fixing an emergent bug in
this plugin.
## Installation
Any modern plugin manager will work. If you are installing manually, you will
have to run `git submodule update --init` since [Jedi][] is included as a
submodule.
## Usage
```vim
:ImpSort[!]
```
The `:ImpSort` command accepts a range and can be used with visual selections.
Using `:Impsort!` (with bang) will separate `from ... import` groups with a
blank line.
You could also have it sort on save:
```vim
autocmd BufWritePre *.py ImpSort!
```
Or use a keymap:
```vim
nnoremap is :ImpSort!
```
The sorting method is configurable. Be sure to read [`:h impsort`][doc]!
There is another command `:ImpSortAuto` which will automatically sort imports
on `InsertLeave`. **Definitely** read [`:h impsort`][doc] if this
interests you.
### Highlighting
By default, imported objects will be highlighted. If your version of Vim is
capable of asynchronous calls (Neovim and Vim 8), the highlighting will
distinguish imported classes and functions. You can read about customizing the
colors in the [documentation][doc].
## Rationale
I wanted to be able to keep my import lines organized, but didn't want to spend
the time sorting them by hand. Using this plugin, you can add a new import and
let the sort do its thing.
I also wanted something more forgiving than [isort][]. This plugin will not
move imports out of their original placement in the script. For example:
```python
import sys
import os
sys.path.insert(0, 'special/path')
import special
```
With `isort`:
```python
import os
import sys
import special
sys.path.insert(0, 'special/path')
```
With `impsort.vim`:
```python
import os
import sys
sys.path.insert(0, 'special/path')
import special
```
[doc]: doc/impsort.txt
[Jedi]: https://github.com/davidhalter/jedi
[isort]: https://github.com/timothycrosley/isort/
[Tree-sitter]: https://tree-sitter.github.io/