Package com.diffplug.gradle.spotless

Class BaseKotlinExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

com.diffplug.gradle.spotless.BaseKotlinExtension

Direct Known Subclasses:

KotlinExtension, KotlinGradleExtension

public abstract class BaseKotlinExtension
extends FormatExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	BaseKotlinExtension.DiktatConfig
final class	BaseKotlinExtension.KtfmtConfig
final class	BaseKotlinExtension.KtlintConfig
final class	BaseKotlinExtension.TableTestFormatterConfig

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

Modifier	Constructor	Description
protected	BaseKotlinExtension(SpotlessExtension spotless)

Method Summary

Modifier and Type	Method	Description
BaseKotlinExtension.DiktatConfig	diktat()
BaseKotlinExtension.DiktatConfig	diktat(String version)	Adds the specified version of diktat.
protected abstract boolean	isScript()
BaseKotlinExtension.KtfmtConfig	ktfmt()	Uses the ktfmt jar to format source code.
BaseKotlinExtension.KtfmtConfig	ktfmt(String version)	Uses the given version of ktfmt and applies the dropbox style option to format source code.
BaseKotlinExtension.KtlintConfig	ktlint()
BaseKotlinExtension.KtlintConfig	ktlint(String version)	Adds the specified version of ktlint.
BaseKotlinExtension.TableTestFormatterConfig	tableTestFormatter()	Formats @TableTest annotation tables using tabletest-formatter.
BaseKotlinExtension.TableTestFormatterConfig	tableTestFormatter(String version)	Formats @TableTest annotation tables using the given version of tabletest-formatter.

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, p2Provisioner, parseTarget, prettier, prettier, prettier, provisioner, ratchetFrom, replace, replaceRegex, replaceStep, setEncoding, setEncoding, setLineEndings, setRatchetFrom, setupTask, 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

BaseKotlinExtension

protected BaseKotlinExtension(SpotlessExtension spotless)

Method Details

diktat

public BaseKotlinExtension.DiktatConfig diktat()

diktat

public BaseKotlinExtension.DiktatConfig diktat(String version)

Adds the specified version of diktat.

ktlint

public BaseKotlinExtension.KtlintConfig ktlint()
                                        throws IOException

Throws:

IOException

ktlint

public BaseKotlinExtension.KtlintConfig ktlint(String version)
                                        throws IOException

Adds the specified version of ktlint.

Throws:

IOException

ktfmt

public BaseKotlinExtension.KtfmtConfig ktfmt()

Uses the ktfmt jar to format source code.

ktfmt

public BaseKotlinExtension.KtfmtConfig ktfmt(String version)

Uses the given version of ktfmt and applies the dropbox style option to format source code.

tableTestFormatter

public BaseKotlinExtension.TableTestFormatterConfig tableTestFormatter()

Formats @TableTest annotation tables using tabletest-formatter.

tableTestFormatter

public BaseKotlinExtension.TableTestFormatterConfig tableTestFormatter(String version)

Formats @TableTest annotation tables using the given version of tabletest-formatter.

isScript

protected abstract boolean isScript()