com.facebook.buck.support.fix

Class FixBuckConfig

java.lang.Object

com.facebook.buck.support.fix.FixBuckConfig

All Implemented Interfaces:

ConfigView<BuckConfig>

public abstract class FixBuckConfig
extends Object
implements ConfigView<BuckConfig>

Configuration that handles how `buck fix` and automatic invocations of fix scripts work

Constructor Summary

Constructors

Constructor and Description
FixBuckConfig()

Method Summary

Modifier and Type	Method and Description
List<String>	getAutofixCommands() List of commands that autofix is enabled for
com.facebook.buck.support.fix.FixBuckConfig.AutofixEnabled	getAutofixEnabled() When running `buck fix` automatically on command failure is enabled
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableList<String>>	getBuckProvidedScripts() Get a mapping of short names to Paths for buck provided fix scripts
abstract BuckConfig	getDelegate()
Optional<com.google.common.collect.ImmutableList<String>>	getFixScript() Get the script to run when buck fix is invoked
Optional<String>	getFixScriptContact() Get the contact to use to tell users who to contact when `buck fix` fails
String	getFixScriptMessage() Get the message to show when invoking `buck fix`
com.google.common.collect.ImmutableList<String>	getInterpolatedFixScript(com.google.common.collect.ImmutableList<String> fixScript, Path repositoryRoot, Path fixSpecPath) Gets the full script to invoke in `buck fix`.
String	getInterpolatedFixScriptMessage(com.google.common.collect.ImmutableList<String> interpolatedFixScript, String fixScriptContact) Gets the message to print to users when `buck fix` is invoked and performs some substitutions
Optional<com.google.common.collect.ImmutableList<String>>	getLegacyFixScript() Get the previous script that JASABI fixes
static FixBuckConfig	of(BuckConfig delegate)
boolean	shouldPrintFixScriptMessage() Determine whether to show a custom message when `buck fix` is invoked
boolean	shouldRunAutofix(boolean isInteractive, String subcommand) Whether or not to run `buck fix` automatically
boolean	shouldUseLegacyFixScript() Determine whether to use the legacy script, or the new fix script system

Methods inherited from class java.lang.Object

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

Constructor Detail

FixBuckConfig

public FixBuckConfig()

Method Detail

getDelegate

public abstract BuckConfig getDelegate()

Specified by:

getDelegate in interface ConfigView<BuckConfig>

of

public static FixBuckConfig of(BuckConfig delegate)

getFixScript

@Value.Lazy
public Optional<com.google.common.collect.ImmutableList<String>> getFixScript()

Get the script to run when buck fix is invoked

getLegacyFixScript

@Value.Lazy
public Optional<com.google.common.collect.ImmutableList<String>> getLegacyFixScript()

Get the previous script that JASABI fixes

getFixScriptContact

@Value.Lazy
public Optional<String> getFixScriptContact()

Get the contact to use to tell users who to contact when `buck fix` fails

getFixScriptMessage

@Value.Lazy
public String getFixScriptMessage()

Get the message to show when invoking `buck fix`

getAutofixEnabled

public com.facebook.buck.support.fix.FixBuckConfig.AutofixEnabled getAutofixEnabled()

When running `buck fix` automatically on command failure is enabled

getAutofixCommands

public List<String> getAutofixCommands()

List of commands that autofix is enabled for

shouldRunAutofix

public boolean shouldRunAutofix(boolean isInteractive,
                                String subcommand)

Whether or not to run `buck fix` automatically

shouldPrintFixScriptMessage

@Value.Lazy
public boolean shouldPrintFixScriptMessage()

Determine whether to show a custom message when `buck fix` is invoked

shouldUseLegacyFixScript

@Value.Lazy
public boolean shouldUseLegacyFixScript()

Determine whether to use the legacy script, or the new fix script system

getInterpolatedFixScript

public com.google.common.collect.ImmutableList<String> getInterpolatedFixScript(com.google.common.collect.ImmutableList<String> fixScript,
                                                                                Path repositoryRoot,
                                                                                Path fixSpecPath)

Gets the full script to invoke in `buck fix`.

`{fix_spec_path}` is replaced with the path to the json file that contains details about the last run. `{repository_root}` is replaced with the absolute path to the repository root.

Parameters:

fixScript - The script to run (generally from the config file) that has not been interpolated

repositoryRoot - The path to use for `{repository_root}`

fixSpecPath - The path to use for `{fix_spec_path}`

Returns:

The interpolated command to run

getInterpolatedFixScriptMessage

public String getInterpolatedFixScriptMessage(com.google.common.collect.ImmutableList<String> interpolatedFixScript,
                                              String fixScriptContact)

Gets the message to print to users when `buck fix` is invoked and performs some substitutions

`{command}` is replaced with interpolatedFixScript `{contact}` is replaced with fixScriptContact

Parameters:

interpolatedFixScript - The fix script per getInterpolatedFixScript(ImmutableList, Path, Path)

fixScriptContact - The contact to use in the message

Returns:

A string to be printed before the fix script is invoked, with template parameters substituted

getBuckProvidedScripts

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableList<String>> getBuckProvidedScripts()

Get a mapping of short names to Paths for buck provided fix scripts