Lint tool for Vim script Language
Project description
Vint is a Vim script Language Lint. The goal to reach for Vint is:
Highly extensible
Highly customizable
High performance
But now, Vint is under development. We hope you develop a policy to help us.
Quick start
You can install with pip.
$ pip install vim-vint
You can use Vint with scrooloose/syntastic:
let g:syntastic_vim_checkers = ['vint']
Configure
Vint will read config files on the following priority order:
e.g. ~/.vintrc.yaml (the filename can be .vintrc.yml or .vintrc)
e.g. path/to/proj/.vintrc.yaml (the filename can be .vintrc.yml or .vintrc)
e.g. $ vint --error, $ vint --max-violations 10
Comment config (highest priority):
e.g. " vint: -ProhibitAbbreviationOption +ProhibitSetNoCompatible
You can see all options on Wiki.
The default configuration is defined in default_config.yaml.
User config
You can configure global Vint config by ~/.vintrc.yaml as following:
cmdargs:
# Checking more strictly
severity: style_problem
# Enable coloring
color: true
# Enable Neovim syntax
env:
neovim: true
policies:
# Disable a violation
ProhibitSomethingEvil:
enabled: false
# Enable a violation
ProhibitSomethingBad:
enabled: true
You can see all policy names on Vint linting policy summary.
Project config
You can configure project local Vint config by .vintrc.yaml as following:
cmdargs:
# Checking more strictly
severity: style_problem
# Enable coloring
color: true
# Enable Neovim syntax
env:
neovim: true
policies:
# Disable a violation
ProhibitSomethingEvil:
enabled: false
# Enable a violation
ProhibitSomethingBad:
enabled: true
You can see all policy names on Vint linting policy summary.
Command line config
You can configure linting severity, max errors, … as following:
$ vint --color --style ~/.vimrc
And you can see all available options by using –help:
$ vint --help usage: vint [-h] [-v] [-V] [-e] [-w] [-s] [-m MAX_VIOLATIONS] [-c] [--no-color] [-j] [-t] [--enable-neovim] [-f FORMAT] [--stdin-display-name STDIN_DISPLAY_NAME] [files [files ...]] Lint Vim script positional arguments: files file or directory path to lint optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit -V, --verbose output verbose message -e, --error report only errors -w, --warning report errors and warnings -s, --style-problem report errors, warnings and style problems -m MAX_VIOLATIONS, --max-violations MAX_VIOLATIONS limit max violations count -c, --color colorize output when possible --no-color do not colorize output -j, --json output json style -t, --stat output statistic info --enable-neovim enable Neovim syntax -f FORMAT, --format FORMAT set output format --stdin-display-name STDIN_DISPLAY_NAME specify a file path that is used for reporting when linting standard inputs
Code health
License
Acknowledgement
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for vim_vint-0.4a3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b57acc2165b9d0ce81b23623a1073a8bb8c8d0c273b4c6049ef745143a505e0b |
|
MD5 | 83f86550cccba638a4456c6093bc524f |
|
BLAKE2b-256 | f2ccb5f823a3c944eb0abfadc22f02a9a17587197797193f6b26390bcb0269ab |
Comment config
You can enable/disable linting policies by a comment as following:
And you can use line config comments. It can enable/disable linting policies in only one line by the postfix comment:
This syntax is: “ vint: [next-line] [+-]<PolicyName> [+-]<PolicyName> …. You can see all policy names on Vint linting policy summary.