mirror of
https://github.com/raimon49/requirements.txt.vim.git
synced 2025-12-06 10:04:23 +08:00
112 lines
3.3 KiB
Markdown
112 lines
3.3 KiB
Markdown
requirements.txt.vim
|
|
====================
|
|
|
|
[](https://github.com/raimon49/requirements.txt.vim/actions?query=workflow%3AVimScript)
|
|
[](https://github.com/raimon49/requirements.txt.vim/releases)
|
|
[](LICENSE.txt)
|
|
[](https://github.com/raimon49/requirements.txt.vim/graphs/contributors)
|
|
[](https://snyk.io/test/github/raimon49/requirements.txt.vim)
|
|
|
|
[the Requirements File Format](https://pip.pypa.io/en/stable/reference/requirements-file-format/) syntax support for Vim.
|
|
|
|
|
|
|
|
Table of Contents
|
|
-----------------
|
|
|
|
* [Installation](#installation)
|
|
* [Plugin manager](#plugin-manager-recommended)
|
|
* [Pathogen](#pathogen-httpsgithubcomtpopevim-pathogen)
|
|
* [Manually](#manually)
|
|
* [File detection](#file-detection)
|
|
* [Customize](#customize)
|
|
* [Support for make](#support-for-make)
|
|
* [License](#license)
|
|
* [Similar Projects](#similar-projects)
|
|
|
|
Installation
|
|
------------
|
|
|
|
### Plugin manager (**recommended**)
|
|
|
|
e.g.) [vim-plug](https://github.com/junegunn/vim-plug), [dein.vim](https://github.com/Shougo/dein.vim), [NeoBundle](https://github.com/Shougo/neobundle.vim), [Vundle](https://github.com/VundleVim/Vundle.vim) [and more](https://dotfiles.github.io/)
|
|
|
|
```vim
|
|
" vim-plug
|
|
Plug 'raimon49/requirements.txt.vim'
|
|
|
|
" vim-plug with on-demand
|
|
Plug 'raimon49/requirements.txt.vim', {'for': 'requirements'}
|
|
|
|
" dein.vim
|
|
call dein#add('raimon49/requirements.txt.vim')
|
|
|
|
" dein.vim with lazy
|
|
call dein#add('raimon49/requirements.txt.vim', {'lazy': 1, 'on_ft': 'requirements'})
|
|
|
|
" NeoBundle
|
|
NeoBundle 'raimon49/requirements.txt.vim'
|
|
|
|
" Vundle
|
|
Plugin 'raimon49/requirements.txt.vim'
|
|
```
|
|
|
|
### Pathogen (https://github.com/tpope/vim-pathogen)
|
|
|
|
```sh
|
|
$ git clone https://github.com/raimon49/requirements.txt.vim.git ~/.vim/bundle/requirements.txt.vim
|
|
```
|
|
|
|
### Manually
|
|
|
|
Deploy all files under `$VIMRUNTIME`.
|
|
|
|
File detection
|
|
--------------
|
|
|
|
`requirements.txt.vim` detects filename automatically.
|
|
|
|
* `requirements.txt`
|
|
* `constraints.txt`
|
|
* `dev-requirements.txt`
|
|
* `requirements/dev.txt`
|
|
* `requires/tests.txt`
|
|
* `requirements.in`
|
|
* Use for [pip-tools](https://github.com/jazzband/pip-tools) (a.k.a. Better dependency management tool).
|
|
* `*.pip`
|
|
|
|
### Customize
|
|
|
|
If you want to customize it.
|
|
|
|
```vim
|
|
" Add 'freeze' to your .vimrc as a detection pattern
|
|
let g:requirements#detect_filename_pattern = 'freeze'
|
|
```
|
|
|
|
```sh
|
|
$ pip freeze > my-freeze.txt
|
|
# You can edit it as a 'Requirements File Format'
|
|
$ vim my-freeze.txt
|
|
```
|
|
|
|
### Support for make
|
|
|
|
When the `pip-compile` command is detected, make will behave more intelligently while editing the `requirements.in` file.
|
|
|
|
You can get support with the following commands:
|
|
|
|
* `:make`
|
|
* `:make -U`
|
|
|
|
License
|
|
-------
|
|
|
|
[MIT License](LICENSE.txt)
|
|
|
|
Similar Projects
|
|
----------------
|
|
|
|
* [bat: A cat(1) clone with wings.](https://github.com/sharkdp/bat)
|
|
* Beautiful syntax highlighting of requirements file is supported
|