At least one of the above static code analyzers must be installed on your machine(s).
The extension should support any versions of the listed static code
analyzers; and will attempt to locate them within your PATH
environment variable.
If a tool is not automatically found, the appropriate
c-cpp-flylint.*.executable
configuration must be specified manually.
Once all requirements are met, the extension may be installed through one of the available marketplaces:
After the extension is installed, one must then decide on how to best
implement the necessary configuration changes to best meet their project
and/or environment needs. For instance, would cppcheck
best be
configured globally, for all projects; or configured for a whole workspace;
or configured for a specific project.
Once an above choice is made, open the appropriate configuration window. See VSCode documentation for help on accessing user, workspace, and project configuration windows.
It is then recommended to narrow in to the extension's configuration; to view, and decide upon each and every setting. Start with enabling the linters desired and disabling those not, along with mapping any necessary build/compiler flags, as needed by most of the linters.
It is a huge help if the linters being configured are in working order on the command-line, prior to an attempt at configuring the extension within VSCode.
This extension runs a few third-party command-line tools found from the
locations determined by the PATH
or Path
environment variable, and
the settings such as "c-cpp-flylint.clang.executable"
or
"c-cpp-flylint.cppcheck.executable"
. Configuring them in workspace
settings allows users to conveniently select a different set of tools
based on project's need, but also allows attackers to run arbitrary
binaries on your machine if they successfully convince you to open a
random repository. In order to reduce the security risk, this extension
reads the settings from user settings, by default. If the repository can
be trusted and workspace settings must be used, you can mark the
workspace as a trusted workspace using the
"C/C++ Flylint: Toggle Workspace Trust Flag"
command.
Due to the large quantity of configuration options -- in tandem with the ever growing number of supported static code analyzers -- all configuration options are not documented here.
However, every configuration option is well documented within File -> Preferences -> Settings [alternatively, one of the keybindings: Command+, or Ctrl+,].
npm install
inside the project rootcd server && npm run test && cd ..
to execute the unit-tests for all linters.npm run compile
or npm run watch
to build the server
and it will compile it into the client/out
folder.Both the source code and issue tracker are hosted at GitHub.
For support purposes, please visit the above URL and select from the Issue and/or Pull Request areas.
Copyright (C) 2017-2022 The VSCode C/C++ Flylint Authors.
Licensed under the MIT License. We check with support for the REUSE specification!