mirror of
https://github.com/EsotericSoftware/spine-runtimes.git
synced 2025-12-20 01:06:00 +08:00
11 lines
1.0 KiB
Markdown
11 lines
1.0 KiB
Markdown
# Formatters
|
|
This folder contains formatter configuration files to be used with IDEs as well as the [spotless](https://github.com/diffplug/spotless/blob/main/plugin-gradle/README.md) formatter expressed in the Gradle project in this directory.
|
|
|
|
You will need the following on your `PATH`:
|
|
|
|
- JDK 10+
|
|
- clang-format 13.0.1 (i.e. `brew install clang-format`). Also set the environment variable `CLANGFORMAT` to the path of the `clang-format` executable. If you have another version installed, you can get it (here)[https://releases.llvm.org/download.html#13.0.1]. For Apple silicon get `clang+llvm-13.0.1-x86_64-apple-darwin.tar.xz` from github pages.
|
|
- dotnet format (i.e. `dotnet tool install -g dotnet-format`, comes with dotnet 6 out of the box)
|
|
- tsfmt, (i.e. `npm install -g typescript-formatter`)
|
|
|
|
To run the formatter, invoke the `format.sh` script. This will shuffle around the Gradle config files, invoke spotless, then undo the config file shuffling. Invoking `./gradlew spotlessApply` from the `formatters/` directory will not work. |