Artichoke clang-format Runner

clang-format runner that operates recursively on a given directory and has output suitable for use in CI and interactive development.

clang-format does not have a pleasant way to output which files are not properly formatted, which is not suitable for CI or code linting. Prior art to address this limitation exists in Sarcasm/run-clang-format.

The Artichoke clang-format runner does not require Python or an existing clang installation. This runner is simpler to distribute because it is invokable with npx.

The Artichoke clang-format runner is used to format C sources in the artichoke/artichoke repository. It will never be published to the npm registry.

Usage

Format sources with:

npx github:artichoke/clang-format path/to/repo

or the current directory with:

npx github:artichoke/clang-format

This runner supports a --check argument which does not format sources and instead exits with an error on bad formatting. This flag is appropriate for running clang-format in CI.

npx github:artichoke/clang-format --check

License

The Artichoke clang-format runner is licensed under the MIT License (c) Ryan Lopopolo.

This tool distributes pre-compiled clang-format binaries which part of the LLVM Project and are subject to the Apache 2.0 License with LLVM exceptions.