Skip to main content

Lint tool for Vim script Language

Project description

logo

Development Status Latest Version Supported Python versions Supported Python implementations Build Status

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:

  • User config:

  • e.g. ~/.vintrc.yaml (the filename can be .vintrc.yml or .vintrc)

  • Project config:

  • e.g. path/to/proj/.vintrc.yaml (the filename can be .vintrc.yml or .vintrc)

  • Command line config:

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

  • Comment config (highest priority):

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

You can see all options on Wiki.

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

Comment config

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> ....

You can see all policy names on Vint linting policy summary.

Code health

Coverage Status Code Health Dependency Status

License

MIT

Acknowledgement

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vim-vint-0.3.12.tar.gz (61.8 kB view details)

Uploaded Source

File details

Details for the file vim-vint-0.3.12.tar.gz.

File metadata

  • Download URL: vim-vint-0.3.12.tar.gz
  • Upload date:
  • Size: 61.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vim-vint-0.3.12.tar.gz
Algorithm Hash digest
SHA256 f5198f8e02b7c138ea3cfec6743f76cf3d782559bb5b2ef5930cc7a74fa16946
MD5 d628a23112f2ff2ed60521e63e0e4f67
BLAKE2b-256 367c2a372a7d494d6fa88809ca57e695626f6b3f820514df7cac5a1584f3b38b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page