Skip to content
Node repackaging of the clang-format native binary
Branch: master
Clone or download
devversion and mprobst fix: check-clang-format not working on windows
Currently when someone runs the "check-clang-format"
binary from the "clang-format" package on Windows, the
script will always fail. This is because on Windows, the
shebang cannot be read, and only the "PATHEXT" environment
variable is respected. Therefore we can just explicitly
declare that we want to run the "python" executable in the
"PATH" environment variable. This ensures that the Python
script can be launched properly on windows.
Latest commit 1317a87 Mar 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci build: specify version of circleci config Jan 21, 2019
bin fix: check-clang-format not working on windows Mar 18, 2019
testproject feat: require a specific version. Jun 25, 2015
.clang-format Format clang-format using clang-format (ha!) Mar 17, 2015
.gitignore Initial commit Feb 24, 2015
LICENSE Initial commit Feb 24, 2015
README.md fix: check-clang-format not working on windows Mar 18, 2019
build.sh feat: binaries based on r328768. Mar 29, 2018
index.js
package.json build: switch to circleci Jan 21, 2019
test.sh pushd and popd are not supported on travis. Dec 7, 2017
yarn.lock build: switch to circleci Jan 21, 2019

README.md

Build Status

clang-format

node.js module which wraps the native clang-format executable.

From the command-line:

$ npm install -g clang-format
$ clang-format -help

If your platform isn't yet supported, you can create the native binary from the latest upstream clang sources, make sure it is stripped and optimized (should be about 1.4MB as of mid-2015) and send a pull request to add it.

Checking formatting

Ensuring that changes to your code are properly formatted is an important part of your development workflow. Note that the check-clang-format and git-clang-format commands require Python to be globally available.

We recommend using a git pre-commit hook. You can configure this as follows:

  1. add a precommit script to your package.json file:

    "scripts": {
        "precommit": "check-clang-format"
    }

    By default, the user gets an error instructing them to run ./node_modules/.bin/git-clang-format. You may find it more ergonomic to set up a package.json script, eg. "scripts": { "format": "git-clang-format" }

    In this case, add a second argument to the "precommit" script, giving the error you'd like to print for users, eg.

    "precommit": "check-clang-format \"yarn format\""

  2. Add a devDependency on the husky package, which will add a .git/hooks/pre-commit script, which in turn triggers the precommit package.json script to run whenever someone adds a commit in this repository:

    $ yarn add -D husky

    or

    npm install --save-dev husky

Why do this in a pre-commit hook? For one thing, it's faster to run clang-format only on the changed files, especially as the repository grows. Also, this lets you upgrade clang-format or change your settings without needing to re-format the entire repository, while still enforcing that later changes follow the new style.

Globbing files

$ clang-format --glob=folder/**/*.js

This will run clang-format once per file result, and show the total formatted files at the end. See node-glob for globbing semantics.

Compiling clang-format

For Linux, compile a statically linked MinSizeRel build:

cmake -G Ninja -DCMAKE_BUILD_TYPE=MinSizeRel -DLLVM_BUILD_STATIC=true ..
ninja clang-format

For Mac OS X, static linking is not required.

Windows

Windows snapshot builds to include in the release can be found at the LLVM website.

Configure with:

cmake -G "Visual Studio 12" -DCMAKE_BUILD_TYPE=MinSizeRel ..

In the generated Visual Studio project, search for the clang-format binary in the Solution Explorer window, right click and choose Build.

You can’t perform that action at this time.