Package Exports
- clang-format-node
- clang-format-node/build/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (clang-format-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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 repackaging(wrapping) of the LLVM Clang's clang-format
and git-clang-format
native binary 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 packages.
clang-format-node
: Node repackaging of the
clang-format
native binary. (The CORE package.) 『Docs』, 『Repository』, 『npm』clang-format-git
: Node repackaging of the
git-clang-format
Python script as a standalone native binary to allow execution without a Python dependency. 『Docs』, 『Repository』, 『npm』clang-format-git-python
: Node repackaging of the
git-clang-format
Python script. This package requires Python3 as a dependency. 『Docs』, 『Repository』, 『npm』
Supported
See the supported documentation, which lists the supported 'OS Platforms and Architectures', 'Node.js Versions', 'GitHub Actions Runner Images', and 'Docker(Build) Images'.
Releases
Each package intends to release a new npm package for every latest release of the clang-format
and git-clang-format
. It checks for the latest LLVM release every week, builds all packages using its own pipeline, and makes a pull request. All processes are run automatically. If you are interested in the build process, take a look at .github/workflows/llvm-build-bump-pr.yml
.
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 Code of Conduct and Contributing Guides 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.
Documentation
For full documentation, see the official documentation of the clang-format-node
or docs
directory of clang-format-node
repository.
Versioning
See Versioning.
Change Log
See Change Log.
Code of Conduct
See Code of Conduct.
License
MIT under LLVM Apache License 2.0.