actions
/
setup-cpp
Template
mirror of https://github.com/aminya/setup-cpp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: separate the analyzer/linter category [skip ci]

This commit is contained in:
Amin Yahyaabadi 2024-09-19 14:17:03 -07:00
parent 1e259843db
commit 16c789591a
No known key found for this signature in database
GPG Key ID: F52AF77F636088F0
6 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -14,15 +14,16 @@ Setting up a **cross-platform** environment for building and testing C++/C proje
`setup-cpp` is **modular** and you can choose to install any of these tools: `setup-cpp` is **modular** and you can choose to install any of these tools:
| category | tools | | category | tools |
| --------------------- | --------------------------------------------------------------------------------------------------------------- | | --------------- | ----------------------------------------------------------------------------------------------------------- |
| compiler and analyzer | llvm, gcc, msvc, apple-clang, vcvarsall, cppcheck, clang-tidy, clang-format, cpplint, flawfinder, lizard, infer | | compiler | llvm, gcc, msvc, apple-clang, vcvarsall |
| build system | cmake, ninja, meson, make, task, bazel, cmakelang, cmake-format, cmake-lint | | build system | cmake, ninja, meson, make, task, bazel |
| package manager | vcpkg, conan, choco, brew, nala | | package manager | vcpkg, conan, choco, brew, nala |
| cache | ccache, sccache | | analyzer/linter | clang-tidy, clang-format, cppcheck, cpplint, flawfinder, lizard, infer, cmakelang, cmake-format, cmake-lint |
| documentation | doxygen, graphviz | | cache | ccache, sccache |
| coverage | gcovr, opencppcoverage, kcov | | documentation | doxygen, graphviz |
| other | python, powershell, sevenzip | | coverage | gcovr, opencppcoverage, kcov |
| other | python, powershell, sevenzip |
`setup-cpp` automatically handles the dependencies of the selected tool (e.g., `python` is required for `conan`). `setup-cpp` automatically handles the dependencies of the selected tool (e.g., `python` is required for `conan`).

2
dist/legacy/setup-cpp.js vendored
View File

File diff suppressed because one or more lines are too long

2
dist/legacy/setup-cpp.js.map vendored
View File

File diff suppressed because one or more lines are too long

2
dist/modern/setup-cpp.mjs vendored
View File

File diff suppressed because one or more lines are too long

2
dist/modern/setup-cpp.mjs.map vendored
View File

File diff suppressed because one or more lines are too long

9
src/cli-options.ts
View File

@ -33,13 +33,16 @@ All the available tools:
console.table( console.table(
{ {
"compiler and analyzer": { "compiler and analyzer": {
tools: tools: "--llvm, --gcc, --msvc, --apple-clang, --vcvarsall",
"--llvm, --gcc, --msvc, --apple-clang, --vcvarsall, --cppcheck, --clang-tidy, --clang-format, --cpplint, --flawfinder, --lizard, --infer",
}, },
"build system": { "build system": {
tools: "--cmake, --ninja, --meson, --make, --task, --bazel, --cmakelang, --cmake-lint, --cmake-format", tools: "--cmake, --ninja, --meson, --make, --task, --bazel",
}, },
"package manager": { tools: "--vcpkg, --conan, --choco, --brew, --nala" }, "package manager": { tools: "--vcpkg, --conan, --choco, --brew, --nala" },
"analyzer/linter": {
tools:
"--clang-tidy, --clang-format, --cppcheck, --cpplint, --flawfinder, --lizard, --infer, , --cmakelang, --cmake-lint, --cmake-format",
},
cache: { tools: "--ccache, --sccache" }, cache: { tools: "--ccache, --sccache" },
documentation: { tools: "--doxygen, --graphviz" }, documentation: { tools: "--doxygen, --graphviz" },
coverage: { tools: "--gcovr, --opencppcoverage, --kcov" }, coverage: { tools: "--gcovr, --opencppcoverage, --kcov" },