requirements.txt.vim

the Requirements File Format syntax support for Vim.

Note: Depending on the version of Vim/Neovim you are using, the syntax highlighting feature of this plugin may be bundled.

• vim/vim/commit/f9f5424
• vim-patch:9.1.0326: filetype: some requirements files are not recognized by zeertzjq · neovim/neovim

Table of Contents

• Installation
  • Plugin manager
  • Pathogen
  • Manually
• File detection
  • Customize
  • Support for make
• License
• Similar Projects

Installation

Plugin manager (recommended)

e.g.) vim-plug, dein.vim, NeoBundle, Vundle and more

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

$ 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 (a.k.a. Better dependency management tool).
• *.pip

Customize

If you want to customize it.

" Add 'freeze' to your .vimrc as a detection pattern
let g:requirements#detect_filename_pattern = 'freeze'

$ 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

Similar Projects

• bat: A cat(1) clone with wings.
  • Beautiful syntax highlighting of requirements file is supported