Package com.diffplug.gradle.spotless
Class ProtobufExtension
- java.lang.Object
-
- com.diffplug.gradle.spotless.FormatExtension
-
- com.diffplug.gradle.spotless.ProtobufExtension
-
- All Implemented Interfaces:
HasBuiltinDelimiterForLicense
public class ProtobufExtension extends FormatExtension implements HasBuiltinDelimiterForLicense
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classProtobufExtension.BufFormatExtension-
Nested classes/interfaces inherited from class com.diffplug.gradle.spotless.FormatExtension
FormatExtension.BiomeGeneric, FormatExtension.ClangFormatConfig, FormatExtension.EclipseWtpConfig, FormatExtension.LicenseHeaderConfig, FormatExtension.NpmStepConfig<T extends FormatExtension.NpmStepConfig<?>>, FormatExtension.PrettierConfig, FormatExtension.RomeGeneric
-
-
Field Summary
-
Fields inherited from class com.diffplug.gradle.spotless.FormatExtension
steps, target, targetExclude, targetExcludeContentPattern
-
-
Constructor Summary
Constructors Constructor Description ProtobufExtension(SpotlessExtension spotless)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProtobufExtension.BufFormatExtensionbuf()ProtobufExtension.BufFormatExtensionbuf(java.lang.String version)Adds the specified version of buf.FormatExtension.LicenseHeaderConfiglicenseHeader(java.lang.String licenseHeader)FormatExtension.LicenseHeaderConfiglicenseHeaderFile(java.lang.Object licenseHeaderFile)protected voidsetupTask(SpotlessTask task)If the user hasn't specified files, assume all protobuf files should be checked.-
Methods inherited from class com.diffplug.gradle.spotless.FormatExtension
addStep, addStep, biome, biome, bumpThisNumberIfACustomStepChanges, clangFormat, clangFormat, clearSteps, createIndependentApplyTask, createIndependentApplyTaskLazy, custom, custom, eclipseWtp, eclipseWtp, encoding, endWithNewline, getEncoding, getExistingStepIdx, getLineEndings, getProject, getRatchetFrom, ignoreErrorForPath, ignoreErrorForStep, indentWithSpaces, indentWithSpaces, indentWithTabs, indentWithTabs, isLicenseHeaderStep, licenseHeader, licenseHeaderFile, nativeCmd, noDefaultTargetException, parseTarget, prettier, prettier, prettier, provisioner, ratchetFrom, replace, replaceRegex, replaceStep, rome, rome, setEncoding, setEncoding, setLineEndings, setRatchetFrom, target, targetExclude, targetExcludeIfContentContains, targetExcludeIfContentContainsRegex, toggleOffOn, toggleOffOn, toggleOffOnDisable, toggleOffOnRegex, trimTrailingWhitespace, withinBlocks, withinBlocks, withinBlocksRegex, withinBlocksRegex
-
-
-
-
Constructor Detail
-
ProtobufExtension
@Inject public ProtobufExtension(SpotlessExtension spotless)
-
-
Method Detail
-
licenseHeader
public FormatExtension.LicenseHeaderConfig licenseHeader(java.lang.String licenseHeader)
- Specified by:
licenseHeaderin interfaceHasBuiltinDelimiterForLicense- Parameters:
licenseHeader- Content that should be at the top of every file.
-
licenseHeaderFile
public FormatExtension.LicenseHeaderConfig licenseHeaderFile(java.lang.Object licenseHeaderFile)
- Specified by:
licenseHeaderFilein interfaceHasBuiltinDelimiterForLicense- Parameters:
licenseHeaderFile- Content that should be at the top of every file.
-
setupTask
protected void setupTask(SpotlessTask task)
If the user hasn't specified files, assume all protobuf files should be checked.- Overrides:
setupTaskin classFormatExtension
-
buf
public ProtobufExtension.BufFormatExtension buf(java.lang.String version)
Adds the specified version of buf.
-
buf
public ProtobufExtension.BufFormatExtension buf()
-
-