Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexmurray/flycheck-clang-analyzer
Integrate Clang Static Analyzer with flycheck for on-the-fly static analysis in Emacs
https://github.com/alexmurray/flycheck-clang-analyzer
c c-plus-plus ccls clang cquery emacs flycheck irony-mode rtags static-analysis
Last synced: 3 months ago
JSON representation
Integrate Clang Static Analyzer with flycheck for on-the-fly static analysis in Emacs
- Host: GitHub
- URL: https://github.com/alexmurray/flycheck-clang-analyzer
- Owner: alexmurray
- Created: 2017-05-19T07:20:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-14T06:49:26.000Z (almost 3 years ago)
- Last Synced: 2024-04-26T01:33:02.100Z (7 months ago)
- Topics: c, c-plus-plus, ccls, clang, cquery, emacs, flycheck, irony-mode, rtags, static-analysis
- Language: Emacs Lisp
- Size: 140 KB
- Stars: 35
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flycheck Clang Static Analyzer (scan-build) Checker
[](http://www.gnu.org/licenses/gpl-3.0.txt)
[](http://melpa.org/#/flycheck-clang-analyzer)
[](https://travis-ci.org/alexmurray/flycheck-clang-analyzer)
Integrate [Clang Static Analyzer](https://clang-analyzer.llvm.org/)
(aka. scan-build) with [flycheck](http://www.flycheck.org) to automatically
perform on-the-fly static analysis *as you code*.
This package leverages the configuration of the existing `c/c++-clang` flycheck
checker, or either
[emacs-cquery](https://github.com/cquery-project/emacs-cquery),
[emacs-ccls](https://github.com/MaskRay/emacs-ccls),
[irony-mode](https://github.com/Sarcasm/irony-mode/) or
[rtags](https://github.com/Andersbakken/rtags) to provide the appropriate
compiler flags for clang - and so requires zero extra setup. This checker also
automatically chains itself as the next `flycheck` checker after `c/c++-clang`,
[lsp-ui](https://github.com/emacs-lsp/lsp-ui)
[flycheck-irony](https://github.com/Sarcasm/flycheck-irony/) and
[flycheck-rtags](https://github.com/Andersbakken/rtags) so that it only runs
when the corresponding previous checker returns without warnings. This avoids
trying to perform the analysis when there are syntactic errors etc.
## Installation
### MELPA
The preferred way to install `flycheck-clang-analyzer` is via
[MELPA](http://melpa.org) - then you can just M-x package-install RET
flycheck-clang-analyzer RET
To enable then simply add the following to your init file:
```emacs-lisp
(with-eval-after-load 'flycheck
(require 'flycheck-clang-analyzer)
(flycheck-clang-analyzer-setup))
```
We recommend to use [use-package](https://github.com/jwiegley/use-package) to
make this automatic:
```emacs-lisp
(use-package flycheck-clang-analyzer
:ensure t
:after flycheck
:config (flycheck-clang-analyzer-setup))
```
### Manual
If you would like to install the package manually, download or clone it and
place it within Emacs' `load-path`, then you can require it in your init file
like this:
```emacs-lisp
(require 'flycheck-clang-analyzer)
(flycheck-clang-analyzer-setup)
```
NOTE: This will also require the manual installation of `flycheck` if you have
not done so already.
## Configuration
This should work with zero configuration, since we try and leverage the
configuration of existing clang-based Flycheck checkers.
The only configuration option is `flycheck-clang-analyzer-executable` which is
the path to the clang executable - this defaults to `clang`. However if you
need to change this to something else, simply `setq` it as appropriate before
calling `(flycheck-clang-analyzer-setup)` - so to set to use `clang-3.8`
instead of `clang`:
```emacs-lisp
(setq flycheck-clang-analyzer-executable "clang-3.8")
(flycheck-clang-analyzer-setup)
```
## License
Copyright © 2018 Alex Murray
Distributed under GNU GPL, version 3.