https://github.com/tensorworks/ue-clang-format
Unreal Engine Clang-Format configuration and instructions.
https://github.com/tensorworks/ue-clang-format
Last synced: 2 months ago
JSON representation
Unreal Engine Clang-Format configuration and instructions.
- Host: GitHub
- URL: https://github.com/tensorworks/ue-clang-format
- Owner: TensorWorks
- License: mit
- Created: 2021-11-20T00:38:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T14:37:00.000Z (almost 2 years ago)
- Last Synced: 2025-09-16T19:48:04.371Z (9 months ago)
- Size: 559 KB
- Stars: 134
- Watchers: 2
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clang Format for Unreal Engine C++
Automatically format your Unreal Engine C++ as per [Epic's Coding Standard](https://docs.unrealengine.com/4.27/en-US/ProductionPipelines/DevelopmentSetup/CodingStandard/).
The purpose of this repository is to provide a Clang-Format configuration for Unreal Engine C++ and instructions for how to use it.
## Get the .clang-format file
[.clang-format file](./.clang-format)
## VS Code
1. Put the `.clang-format` file in the root of your project (or the engine root if you are working on the engine itself).
2. As long as you have [Microsoft's C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) installed in VSCode you can now format with `Shift+Alt+F`. (If not, [read here](https://code.visualstudio.com/docs/cpp/cpp-ide#_code-formatting)).
**Optional:** You can enable `format on save` for C++ by adding the following to your `*.code-workspace` file:
```
"settings": {
"[c++]": {
"editor.formatOnSave": true
}
},
```
## Visual Studio
1. Go to the root of you project, `File->Add New Item->ClangFormat File`.
2. Copy+Paste the contents of the .clang-format from this repository into the newly generated `.clang-format` file.
3. You can now format files with `Ctrl+K+D`
**Optional:** You can enable `format on save` by installing [this extension](https://marketplace.visualstudio.com/items?itemName=mynkow.FormatdocumentonSave).
## Limitations
1. Method chaining is not supported by clang-format and offers inconsistent results, especially inside of square brackets (`[`, `]`) such as used extensively by Slate.
2. Single-line lambdas are incompatible with Allman-style brace wrapping and cannot be supported with the currently available ruleset.