Supporting buf format #1207

Activity

1. nedtwigg commented on May 12, 2022

   

   nedtwigg

   on May 12, 2022

   Member

   More actions

   Yes, we have support for two binary tools in Spotless right now, happy to add another one.

   spotless/lib/src/main/java/com/diffplug/spotless/python/BlackStep.java

   Lines 65 to 70 in 21b089f

   	String exeAbsPath = ForeignExe.nameAndVersion("black", version)
   	.pathToExe(pathToExe)
   	.versionRegex(Pattern.compile("(?:black, version|black,|version) (\\S*)"))
   	.fixCantFind("Try running {@code pip install black=={version}}, or else tell Spotless where it is with {@code black().pathToExe('path/to/executable')}" + trackingIssue)
   	.fixWrongVersion("Try running {@code pip install --force-reinstall black=={version}}, or else specify {@code black('{versionFound}')} to Spotless" + trackingIssue)
   	.confirmVersionAndGetAbsolutePath();

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

   Lines 70 to 84 in 21b089f

   	String howToInstall = "" +
   	"You can download clang-format from https://releases.llvm.org and " +
   	"then point Spotless to it with {@code 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)" +
   	"\n github issue to handle this better: https://github.com/diffplug/spotless/issues/673";
   	String exeAbsPath = ForeignExe.nameAndVersion("clang-format", version)
   	.pathToExe(pathToExe)
   	.fixCantFind(howToInstall)
   	.fixWrongVersion(
   	"You can tell Spotless to use the version you already have with {@code clangFormat('{versionFound}')}" +
   	"or you can download the currently specified version, {version}.\n" + howToInstall)
   	.confirmVersionAndGetAbsolutePath();

   I'm fine with making installation of the buf tool a problem for the user (that's how we handle black and clang currently), or it can be automatic.
2. nedtwigg

   added

   enhancement

   on May 12, 2022
3. nedtwigg

   closed this as completedin #1208on Jul 16, 2023