Ⅰ. 插件描述
Check for coding style issues in CMake filesⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'richq/cmake-lint'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'richq/cmake-lint'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'richq/cmake-lint'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/richq/cmake-lint
Ⅳ. 文档说明
cmakelint parses CMake files and reports style issues.
cmakelint requires Python.
Installation
sudo pip install cmakelint
Usage
Syntax: cmakelint [--config=file] [--filter=-x,+y] <file> [file] ...
filter=-x,+y,...
Specify a comma separated list of filters to apply
config=file
Use the given file for configuration. By default the file
$HOME/.cmakelintrc is used if it exists. Use the value "None" to use no
configuration file (./None for a file called literally None)
Only the option "filter=" is currently supported in this file.
Run the --filter= option with no filter to see available options. Currently
these are:
convention/filename
linelength
package/consistency
readability/logic
readability/mixedcase
readability/wonkycase
syntax
whitespace/eol
whitespace/extra
whitespace/indent
whitespace/mismatch
whitespace/newline
whitespace/tabs
An example .cmakelintrc file would be as follows:
filter=-whitespace/indent
With this file in your home directory, running these commands would have the
same effect:
cmakelint.py CMakeLists.txt
cmakelint.py --filter=-whitespace/indent CMakeLists.txt
Output status codes
The program should exit with the following status codes:
- 0 if everything went fine
- 1 if an error message was issued
- 32 on usage error
Changes
1.4
- Add --quiet flag to suppress "Total Errors: 0"
- Add --linelength=N flag to allow longer default lines (default remains 80)
1.3.4
- fix false positives in indented blocks
1.3.3
- fix crash on invalid
# lint_cmake: pragmaline - fix deprecation warning with Python 3.4
- fix false positive warnings related to non-CMake quoted chunks (Issue #2)
1.3.2
- return error code 0, 1, 32 on error
1.3.1
- fix version number
1.3
- individual CMake files can control filters with
# lint_cmake: pragmacomment - improved
SetFiltersfunction to allow spaces around the commas - use
${XDG_CONFIG_HOME}for the cmakelintrc file, with backwards compatible check for~/.cmakelintrc
1.2.01
- Published on pypi
1.2
- Moved to github