Vint is a Vim script Language Lint. The goal to reach for vint is:

• Highly extensible lint
• Highly customizable lint
• High performance lint

But now, Vint is under development. We hope you develop a policy to help us.

You can install with pip.

$ pip install vim-vint

vint will read config files on the following priority order:

• User config:

  • e.g. ~/.vintrc.yaml

• Project config:

  • e.g. path/to/proj/.vintrc.yaml

• Command line config:

  • e.g. $ vint --error, $ vint --max-violations 10

• Comment config (highest priority):

  • e.g. " vint: -ProhibitAbbreviationOption +ProhibitSetNoCompatible

You can configure global vint config by ~/.vintrc.yaml as following:

cmdargs:
  # Checking more strictly
  severity: style_problem

  # Enable coloring
  color: true

policies:
  # Disable a violation
  ProhibitSomethingEvil:
    enabled: false

  # Enable a violation
  ProhibitSomethingBad:
    enabled: true

You can configure project local vint config by .vintrc.yaml as following:

cmdargs:
  # Checking more strictly
  severity: style_problem

  # Enable coloring
  color: true

policies:
  # Disable a violation
  ProhibitSomethingEvil:
    enabled: false

  # Enable a violation
  ProhibitSomethingBad:
    enabled: true

You can configure linting severity, max errors, ... as following:

$ vint --color --style ~/.vimrc

You can enable/disable linting policies by a comment as following:

" vint: -ProhibitAbbreviationOption

let s:save_cpo = &cpo
set cpo&vim

" vint: +ProhibitAbbreviationOption

" do something...

" vint: -ProhibitAbbreviationOption

let &cpo = s:save_cpo
unlet s:save_cpo

This syntax is: " vint: [+-]<PolicyName> [+-]<PolicyName> ...

MIT

• ynkdir/vim-vimlparser
• Google Vimscript Style Guide