Skip to content

Commit b91f372

Browse files
authored
docs: add the npm packages to Get started and the home page (#88)
<!-- claude-projects-attribution: {"github_login":"shenxianpeng"} --> ## Summary `@cpp-linter/clang-format` and `@cpp-linter/clang-tidy` are now on npm for LLVM 12 to 23 ([clang-tools-npm](https://github.com/cpp-linter/clang-tools-npm)). - Get started, "Just the clang tools": a new row for the npm packages, and the intro names them among the tools that use the static binaries. - Home page: the "Just the clang tools" card says "via pip, npm or asdf", and the footer's Tools list links the npm packages. ## Related Issues None. Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
1 parent 1972bed commit b91f372

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

‎docs/getting-started.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,15 @@ is in release candidates. Use the Python package until 2.0 is released.
107107
## Just the clang tools
108108

109109
These install `clang-format`, `clang-tidy` and other LLVM tools without building LLVM. clang-tools,
110-
asdf and the Homebrew tap use the same
110+
the npm packages, asdf and the Homebrew tap use the same
111111
[static binaries](https://cpp-linter.github.io/clang-tools-static-binaries/). Their
112112
download page links every file, shows which versions LLVM, PyPI, conda-forge and Homebrew
113113
have, and explains how to check a download.
114114

115115
| Package | LLVM | Runs on | Install |
116116
| --- | --- | --- | --- |
117117
| [clang-tools](https://cpp-linter.github.io/clang-tools-pip/) | 12 to 23 | Linux, macOS, Windows | `pip install clang-tools`, then `clang-tools install clang-format clang-tidy --version 21` |
118+
| [npm packages](https://github.com/cpp-linter/clang-tools-npm) | 12 to 23 | Linux, macOS, Windows on x86-64 and ARM64 | `npm install --save-dev @cpp-linter/clang-format@21 @cpp-linter/clang-tidy@21`, then `npx clang-tidy` |
118119
| [asdf plugin](https://github.com/cpp-linter/asdf-clang-tools) | 12 to 23 | wherever asdf runs | `asdf plugin add clang-format https://github.com/cpp-linter/asdf-clang-tools.git` |
119120
| [Homebrew tap](https://github.com/cpp-linter/homebrew-tap) | 19 to 23 | macOS only | `brew install cpp-linter/tap/clang-format@21` |
120121
| [Static binaries](https://cpp-linter.github.io/clang-tools-static-binaries/) | 12 to 23 | Linux, macOS, Windows on x86-64 and ARM64 | download one file from the download page |

‎docs/overrides/home.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h1 class="cl-hero__title">
165165
},
166166
{
167167
"title": "Just the clang tools", "name": "clang-tools", "icon": "octicons/package-24",
168-
"text": "clang-format, clang-tidy and friends for LLVM 12 to 23 via pip or asdf, plus Docker images (up to 22) and a macOS Homebrew tap (19 to 23).",
168+
"text": "clang-format, clang-tidy and friends for LLVM 12 to 23 via pip, npm or asdf, plus Docker images (up to 22) and a macOS Homebrew tap (19 to 23).",
169169
"code": "pip install clang-tools\nclang-tools install clang-format clang-tidy --version 21",
170170
"href": "https://cpp-linter.github.io/clang-tools-pip/", "cta": "Read the docs",
171171
},
@@ -454,6 +454,7 @@ <h2>Maintained by two volunteers</h2>
454454
<a href="https://cpp-linter.github.io/cpp-linter/">Python CLI</a>
455455
<a href="https://cpp-linter.github.io/clang-tools-pip/">clang-tools</a>
456456
<a href="https://cpp-linter.github.io/clang-tools-static-binaries/">Static binaries</a>
457+
<a href="https://github.com/cpp-linter/clang-tools-npm">npm packages</a>
457458
<a href="https://hub.docker.com/r/xianpengshen/clang-tools">Docker images</a>
458459
</nav>
459460
<nav aria-label="Learn">

0 commit comments

Comments
 (0)