Skip to content

Better method for managing clang-format binaries #673

New issue
New issue
Open
Open
Better method for managing clang-format binaries#673
Labels
enhancement
@nedtwigg

Description

@nedtwigg
nedtwigg
opened on Aug 25, 2020

We are able to call clang-format by shelling out to it on the system path, and we are able to cache its results by enforcing a version check on the binary. However, if it isn't on the path, or the version is wrong, we just show a helpful error message and let the user figure it out from there:

spotless/lib/src/main/java/com/diffplug/spotless/cpp/ClangFormatStep.java

Lines 70 to 83 in 608e128

String howToInstall = "" +
"You can download clang-format from https://releases.llvm.org and " +
"then point Spotless to it with `pathToExe('/path/to/clang-format')` " +
"or you can use your platform's package manager:" +
"\n win: choco install llvm --version {version} (try dropping version if it fails)" +
"\n mac: brew install clang-format (TODO: how to specify version?)" +
"\n linux: apt install clang-format (try clang-format-{version} with dropped minor versions)";
String exeAbsPath = ForeignExe.nameAndVersion("clang-format", version)
.pathToExe(pathToExe)
.fixCantFind(howToInstall)
.fixWrongVersion(
"You can tell Spotless to use the version you already have with `clangFormat('{versionFound}')`" +
"or you can download the currently specified version, {version}.\n" + howToInstall)
.confirmVersionAndGetAbsolutePath();

It would be nice if we could handle this better, or at least have better instructions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions