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
class	ProtobufExtension.BufFormatExtension

Nested classes/interfaces inherited from class com.diffplug.gradle.spotless.FormatExtension

FormatExtension.BiomeGeneric, FormatExtension.ClangFormatConfig, FormatExtension.EclipseWtpConfig, FormatExtension.IdeaConfig, FormatExtension.LicenseHeaderConfig, FormatExtension.NpmStepConfig<T extends FormatExtension.NpmStepConfig<?>>, FormatExtension.PrettierConfig

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

Modifier and Type	Method	Description
ProtobufExtension.BufFormatExtension	buf()
ProtobufExtension.BufFormatExtension	buf(String version)	Adds the specified version of buf.
FormatExtension.LicenseHeaderConfig	licenseHeader(String licenseHeader)
FormatExtension.LicenseHeaderConfig	licenseHeaderFile(Object licenseHeaderFile)
protected void	setupTask(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, forbidRegex, getEncoding, getExistingStepIdx, getLineEndings, getProject, getRatchetFrom, idea, ignoreErrorForPath, ignoreErrorForStep, indentWithSpaces, indentWithSpaces, indentWithTabs, indentWithTabs, isLicenseHeaderStep, leadingSpacesToTabs, leadingSpacesToTabs, leadingTabsToSpaces, leadingTabsToSpaces, licenseHeader, licenseHeaderFile, nativeCmd, noDefaultTargetException, parseTarget, prettier, prettier, prettier, provisioner, ratchetFrom, replace, replaceRegex, replaceStep, setEncoding, setEncoding, setLineEndings, setRatchetFrom, suppressLintsFor, target, targetExclude, targetExcludeIfContentContains, targetExcludeIfContentContainsRegex, toggleOffOn, toggleOffOn, toggleOffOnDisable, toggleOffOnRegex, trimTrailingWhitespace, withinBlocks, withinBlocks, withinBlocksRegex, withinBlocksRegex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProtobufExtension

@Inject
public ProtobufExtension(SpotlessExtension spotless)

Method Details

licenseHeader

public FormatExtension.LicenseHeaderConfig licenseHeader(String licenseHeader)

Specified by:

licenseHeader in interface HasBuiltinDelimiterForLicense

Parameters:

licenseHeader - Content that should be at the top of every file.

licenseHeaderFile

public FormatExtension.LicenseHeaderConfig licenseHeaderFile(Object licenseHeaderFile)

Specified by:

licenseHeaderFile in interface HasBuiltinDelimiterForLicense

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:

setupTask in class FormatExtension

buf

public ProtobufExtension.BufFormatExtension buf(String version)

Adds the specified version of buf.

buf

public ProtobufExtension.BufFormatExtension buf()