clang-format-node

⭐If you like this package, please give it a star on GitHub!⭐
Your support helps us improve and maintain the project.

Node wrapper for LLVM Clang's clang-format and git-clang-format native binaries inspired by angular/clang-format.🐉

Important

Please participate in the issue regarding the introduction of a glob pattern. Click here.

Included Packages

This repository is maintained as a monorepo and includes the following three packages.

clang-format-node

Docs | Repository | npm

Node wrapper for clang-format native binary inspired by angular/clang-format. (The CORE package.)

clang-format-git

Docs | Repository | npm

Node wrapper for git-clang-format Python script as a standalone native binary to allow execution without a Python dependency.

clang-format-git-python

Docs | Repository | npm

Node wrapper for git-clang-format Python script. This package requires Python3 as a dependency.

Supported

See the supported section of the documentation, which lists the following:

• OS Platforms and Architectures
• Node.js Version
• GitHub Actions Runner Images
• Docker Build Images

Releases

Each package intends to release a new npm package for every latest release of clang-format and git-clang-format. Automated GitHub Actions check for the latest LLVM release every week, builds all packages using their own pipeline, and makes a pull request. All processes are automated. If you are interested in the build process, take a look at .github/workflows/llvm-build-bump-pr.yml.

Documentation

For full documentation, see the official documentation of the clang-format-node or docs directory of clang-format-node repository.

Contributing (Issues & Pull Requests)

Thanks for having attention to this package🙇‍♂️. We appreciate you spending the time to work on these things. Every issue and pull request about bugs, suggestions and the other topics is always welcome!

Please read our Contributing Guides and Code of Conduct before you work on these things. We also recommend you to read the Guides on LLVM and clang-format mentioned in the documentation before contributing.

Code of Conduct

See Code of Conduct.

Change Log

See Change Log.

Versioning

See Versioning.

Security

See Security.

License

MIT under LLVM Apache License 2.0.