https://github.com/lumirlumir/npm-clang-format-node
Node wrapper for LLVM Clang's clang-format and git-clang-format native binaries inspired by angular/clang-format.🐉
https://github.com/lumirlumir/npm-clang-format-node
c checker clang clang-format cli cpp cpplint eslint format formatter git-clang-format lint linter nodejs prettier
Last synced: about 2 months ago
JSON representation
Node wrapper for LLVM Clang's clang-format and git-clang-format native binaries inspired by angular/clang-format.🐉
- Host: GitHub
- URL: https://github.com/lumirlumir/npm-clang-format-node
- Owner: lumirlumir
- License: mit
- Created: 2024-09-01T12:27:13.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-10T07:24:20.000Z (about 2 months ago)
- Last Synced: 2025-04-10T08:29:20.953Z (about 2 months ago)
- Topics: c, checker, clang, clang-format, cli, cpp, cpplint, eslint, format, formatter, git-clang-format, lint, linter, nodejs, prettier
- Language: JavaScript
- Homepage: https://clang-format-node.lumir.page
- Size: 186 MB
- Stars: 22
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- fucking-awesome-angular - npm-clang-format-node - Node wrapper for LLVM Clang's clang-format and git-clang-format native binaries inspired by <b><code> 100⭐</code></b> <b><code> 31🍴</code></b> [angular/clang-format](https://github.com/angular/clang-format)). (Table of contents / Third Party Components)
- awesome-angular - npm-clang-format-node - Node wrapper for LLVM Clang's clang-format and git-clang-format native binaries inspired by [angular/clang-format](https://github.com/angular/clang-format). (Table of contents / Third Party Components)
README
# clang-format-node
&color=83ba63&display_name=release)
[](https://www.npmjs.com/package/clang-format-node)
[](https://github.com/lumirlumir/npm-clang-format-node/actions/workflows/lint.yml)
[](https://github.com/lumirlumir/npm-clang-format-node/actions/workflows/test.yml)
[](https://github.com/lumirlumir/npm-clang-format-node/actions/workflows/test-cross-platform.yml)
[](https://codecov.io/gh/lumirlumir/npm-clang-format-node)
> [!IMPORTANT]
>
> If you like this package, please give it a star on [GitHub](https://github.com/lumirlumir/npm-clang-format-node)!⭐
> 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](https://github.com/angular/clang-format).🐉
## Documentation
For full documentation, see the [official documentation of the `clang-format-node`](https://clang-format-node.lumir.page).
## Included Packages
This repository is maintained as a **monorepo** and includes the following **three** packages.
### `clang-format-node` - [Repository](https://github.com/lumirlumir/npm-clang-format-node/tree/main/packages/clang-format-node) | [npm](https://www.npmjs.com/package/clang-format-node)
[](https://www.npmjs.com/package/clang-format-node)
Node wrapper for `clang-format` native binary inspired by angular/clang-format. (The **CORE** package.)
### `clang-format-git` - [Repository](https://github.com/lumirlumir/npm-clang-format-node/tree/main/packages/clang-format-git) | [npm](https://www.npmjs.com/package/clang-format-git)
[](https://www.npmjs.com/package/clang-format-git)
Node wrapper for `git-clang-format` Python script as a standalone native binary to **allow execution without a Python dependency**.
### `clang-format-git-python` - [Repository](https://github.com/lumirlumir/npm-clang-format-node/tree/main/packages/clang-format-git-python) | [npm](https://www.npmjs.com/package/clang-format-git-python)
[](https://www.npmjs.com/package/clang-format-git-python)
Node wrapper for `git-clang-format` Python script. **This package requires Python3 as a dependency**.
## Supported
See the [supported](https://clang-format-node.lumir.page/docs/get-started/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`](https://github.com/lumirlumir/npm-clang-format-node/blob/main/.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](https://github.com/lumirlumir/npm-clang-format-node/blob/main/CODE_OF_CONDUCT.md) and [Contributing](https://github.com/lumirlumir/npm-clang-format-node/blob/main/CONTRIBUTING.md) Guides before you work on these things. We also recommend you to read the [Guides on LLVM `clang-format`](http://clang-format-node.lumir.page/docs/further-reading/guides-on-llvm-clang-format) mentioned in the documentation before contributing.
## Code of Conduct
See [Code of Conduct](https://github.com/lumirlumir/npm-clang-format-node/blob/main/CODE_OF_CONDUCT.md).
## Change Log
See [Change Log](https://github.com/lumirlumir/npm-clang-format-node/blob/main/CHANGELOG.md).
## Versioning
See [Versioning](http://clang-format-node.lumir.page/docs/community/versioning).
## Security
See [Security](https://github.com/lumirlumir/npm-clang-format-node/blob/main/SECURITY.md).
## License
[MIT](https://github.com/lumirlumir/npm-clang-format-node/blob/main/LICENSE.md) under [LLVM Apache License 2.0](https://github.com/llvm/llvm-project/blob/main/LICENSE.TXT).