Package com.diffplug.gradle.spotless

Class TypescriptExtension

java.lang.Object

com.diffplug.gradle.spotless.FormatExtension

com.diffplug.gradle.spotless.TypescriptExtension

public class TypescriptExtension
extends FormatExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TypescriptExtension.BiomeTs	Biome formatter step for TypeScript.
class	TypescriptExtension.RomeTs	Deprecated. Rome has transitioned to Biome.
class	TypescriptExtension.TypescriptEslintConfig
class	TypescriptExtension.TypescriptFormatExtension
class	TypescriptExtension.TypescriptPrettierConfig	Overrides the parser to be set to typescript, no matter what the user's config says.

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
TypescriptExtension(SpotlessExtension spotless)

Method Summary

Modifier and Type	Method	Description
TypescriptExtension.BiomeTs	biome()	Defaults to downloading the default Biome version from the network.
TypescriptExtension.BiomeTs	biome(java.lang.String version)	Downloads the given Biome version from the network.
TypescriptExtension.TypescriptEslintConfig	eslint()
TypescriptExtension.TypescriptEslintConfig	eslint(java.lang.String version)
TypescriptExtension.TypescriptEslintConfig	eslint(java.util.Map<java.lang.String,java.lang.String> devDependencies)
FormatExtension.PrettierConfig	prettier()	Uses the default version of prettier.
FormatExtension.PrettierConfig	prettier(java.lang.String version)	Uses the specified version of prettier.
FormatExtension.PrettierConfig	prettier(java.util.Map<java.lang.String,java.lang.String> devDependencies)	Uses exactly the npm packages specified in the map.
TypescriptExtension.RomeTs	rome()	Deprecated. Use biome().
TypescriptExtension.RomeTs	rome(java.lang.String version)	Deprecated. Use biome(String).
protected void	setupTask(SpotlessTask task)	Sets up a format task according to the values in this extension.
TypescriptExtension.TypescriptFormatExtension	tsfmt()	Uses the default version of typescript-format.
TypescriptExtension.TypescriptFormatExtension	tsfmt(java.lang.String version)	Uses the specified version of typescript-format.
TypescriptExtension.TypescriptFormatExtension	tsfmt(java.util.Map<java.lang.String,java.lang.String> devDependencies)	Creates a TypescriptFormatExtension using exactly the specified npm packages.

Methods inherited from class com.diffplug.gradle.spotless.FormatExtension

addStep, addStep, 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, provisioner, ratchetFrom, replace, replaceRegex, replaceStep, setEncoding, setEncoding, setLineEndings, setRatchetFrom, 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 Detail

TypescriptExtension

@Inject
public TypescriptExtension(SpotlessExtension spotless)

Method Detail

tsfmt

public TypescriptExtension.TypescriptFormatExtension tsfmt()

Uses the default version of typescript-format.

tsfmt

public TypescriptExtension.TypescriptFormatExtension tsfmt(java.lang.String version)

Uses the specified version of typescript-format.

tsfmt

public TypescriptExtension.TypescriptFormatExtension tsfmt(java.util.Map<java.lang.String,java.lang.String> devDependencies)

Creates a TypescriptFormatExtension using exactly the specified npm packages.

prettier

public FormatExtension.PrettierConfig prettier()

Uses the default version of prettier.

Overrides:

prettier in class FormatExtension

prettier

public FormatExtension.PrettierConfig prettier(java.lang.String version)

Uses the specified version of prettier.

Overrides:

prettier in class FormatExtension

prettier

public FormatExtension.PrettierConfig prettier(java.util.Map<java.lang.String,java.lang.String> devDependencies)

Uses exactly the npm packages specified in the map.

Overrides:

prettier in class FormatExtension

eslint

public TypescriptExtension.TypescriptEslintConfig eslint()

eslint

public TypescriptExtension.TypescriptEslintConfig eslint(java.lang.String version)

eslint

public TypescriptExtension.TypescriptEslintConfig eslint(java.util.Map<java.lang.String,java.lang.String> devDependencies)

biome

public TypescriptExtension.BiomeTs biome()

Defaults to downloading the default Biome version from the network. To work offline, you can specify the path to the Biome executable via biome().pathToExe(...).

Overrides:

biome in class FormatExtension

biome

public TypescriptExtension.BiomeTs biome(java.lang.String version)

Downloads the given Biome version from the network.

Overrides:

biome in class FormatExtension

rome

@Deprecated
public TypescriptExtension.RomeTs rome()

Deprecated.

Use biome().

Defaults to downloading the default Rome version from the network. To work offline, you can specify the path to the Rome executable via rome().pathToExe(...).

Overrides:

rome in class FormatExtension

rome

@Deprecated
public TypescriptExtension.RomeTs rome(java.lang.String version)

Deprecated.

Use biome(String).

Downloads the given Rome version from the network.

Overrides:

rome in class FormatExtension

setupTask

protected void setupTask(SpotlessTask task)

Description copied from class: FormatExtension

Sets up a format task according to the values in this extension.

Overrides:

setupTask in class FormatExtension