SublimeLinter-contrib-clang-tidy
A linter for clang-tidy
Details
Installs
- Total 4K
- Win 2K
- Mac 710
- Linux 1K
Jul 26 | Jul 25 | Jul 24 | Jul 23 | Jul 22 | Jul 21 | Jul 20 | Jul 19 | Jul 18 | Jul 17 | Jul 16 | Jul 15 | Jul 14 | Jul 13 | Jul 12 | Jul 11 | Jul 10 | Jul 9 | Jul 8 | Jul 7 | Jul 6 | Jul 5 | Jul 4 | Jul 3 | Jul 2 | Jul 1 | Jun 30 | Jun 29 | Jun 28 | Jun 27 | Jun 26 | Jun 25 | Jun 24 | Jun 23 | Jun 22 | Jun 21 | Jun 20 | Jun 19 | Jun 18 | Jun 17 | Jun 16 | Jun 15 | Jun 14 | Jun 13 | Jun 12 | Jun 11 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 2 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
SublimeLinter-contrib-clang-tidy
This linter plugin for SublimeLinter provides an interface to clang-tidy. It will be used with files that have the C, C++, Objective-C or Objective-C++ syntax.
Installation
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Linter installation
Before using this plugin, you must ensure that clang-tidy
is installed on your system. To install clang-tidy
, do the following:
Install
clang-tidy
by typing the following in a terminal:$ brew install llvm # OSX
or:
```bash
$ sudo apt install clang-tidy # Ubuntu 16.04
```
This plugin is untested on Windows.
Make sure you have a compilation database for your project (see the section Settings)
Make sure you have a
.clang-tidy
configuration file for your project. The.clang-tidy
file should live at the root of your project. Please read this blog post to learn how to create a.clang-tidy
file.
Note: This plugin requires clang-tidy
1.0 or later.
Linter configuration
In order for clang-tidy
to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once you have installed and configured clang-tidy
, you can proceed to install the SublimeLinter-contrib-clang-tidy plugin if it is not yet installed.
Plugin installation
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type
install
. Among the commands you should seePackage Control: Install Package
. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.When the plugin list appears, type
clang-tidy
. Among the entries you should seeSublimeLinter-contrib-clang-tidy
. If that entry is not highlighted, use the keyboard or mouse to select it.
Settings
For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.
In order for linting to work, you need a compilation database. This is a JSON
file with the name compile_commands.json. It can be generated by CMake
by specifying -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
on the command-line when
you invoke cmake
.
In order to let this plugin know where the compilation database is, add the
following entry to your .sublime-project
:
{
"folders":
[
// ...
],
"settings":
{
// ...
"SublimeLinter.linters.clangtidy.compile_commands": "${project_path}/PATH/TO/YOUR/BUILD/DIR"
// ...
}
}
The plugin will not work if this setting is not present.
Remember: header files are never compiled. Therefore, header files are not in the compilation database (by default). So, clang-tidy will not work with header files. You may try to use this python package to enhance your existing compile_commands.json with additional header files.
Usage
Upon opening a suitable file, and given that the compilation database as well
as the .clang-tidy
file are present in the right locations, SublimeLinter
will run the clang-tidy linter. Note that this means that the source file is
being compiled by clang-tidy. So it may take a while before messages start to
show up.
Since clang-tidy works on source files, the clang-tidy linter will only run when
you open a source file or when you save a source file. The clang-tidy linter
will not lint when you edit the file. It will only lint during load and
save.
Recommended Other Plugins
Contributing
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
master
. - Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are very well known.
Thank you for helping out!