From 9f374a00797cb34fb0acc924c485ab97ed29ea83 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Thu, 22 Oct 2026 19:28:42 +0000 Subject: [PATCH] docs: add the npm packages to Get started and the home page --- docs/getting-started.md | 3 ++- docs/overrides/home.html | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 7d189e6..74f5e45 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -107,7 +107,7 @@ is in release candidates. Use the Python package until 2.0 is released. ## Just the clang tools These install `clang-format`, `clang-tidy` and other LLVM tools without building LLVM. clang-tools, -asdf and the Homebrew tap use the same +the npm packages, asdf and the Homebrew tap use the same [static binaries](https://cpp-linter.github.io/clang-tools-static-binaries/). Their download page links every file, shows which versions LLVM, PyPI, conda-forge and Homebrew have, and explains how to check a download. @@ -115,6 +115,7 @@ have, and explains how to check a download. | Package | LLVM | Runs on | Install | | --- | --- | --- | --- | | [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` | +| [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` | | [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` | | [Homebrew tap](https://github.com/cpp-linter/homebrew-tap) | 19 to 23 | macOS only | `brew install cpp-linter/tap/clang-format@21` | | [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 | diff --git a/docs/overrides/home.html b/docs/overrides/home.html index 99a2744..c17f826 100644 --- a/docs/overrides/home.html +++ b/docs/overrides/home.html @@ -165,7 +165,7 @@

}, { "title": "Just the clang tools", "name": "clang-tools", "icon": "octicons/package-24", - "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).", + "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).", "code": "pip install clang-tools\nclang-tools install clang-format clang-tidy --version 21", "href": "https://cpp-linter.github.io/clang-tools-pip/", "cta": "Read the docs", }, @@ -454,6 +454,7 @@

Maintained by two volunteers

Python CLI clang-tools Static binaries + npm packages Docker images