Package rife.bld.extension

Class DetektOperation

java.lang.Object

rife.bld.operations.AbstractOperation<T>

rife.bld.operations.AbstractProcessOperation<DetektOperation>

rife.bld.extension.DetektOperation

public class DetektOperation
extends AbstractProcessOperation<DetektOperation>

Performs static code analysis with Detekt.

Since:

1.0

Author:

Erik C. Thauvin

Field Summary

Fields inherited from class rife.bld.operations.AbstractProcessOperation

DEFAULT_JAVA_TOOL, environment_, errorProcessor_, errorProcessorThread_, javaOptions_, javaTool_, mainClass_, module_, modulePath_, outputProcessor_, outputProcessorThread_, process_, successful_, workDirectory_

Constructor Summary

Constructors

Constructor	Description
DetektOperation()

Method Summary

Modifier and Type	Method	Description
DetektOperation	allRules(boolean allRules)	Activates all available (even unstable) rules.
DetektOperation	autoCorrect(boolean autoCorrect)	Allow rules to autocorrect code if they support it.
String	baseline()	Retrieves the baseline xml file.
DetektOperation	baseline(File baseline)	If a baseline xml file is passed in, only new code smells not in the baseline are printed in the console.
DetektOperation	baseline(String baseline)	If a baseline xml file is passed in, only new code smells not in the baseline are printed in the console.
DetektOperation	baseline(Path baseline)	If a baseline xml file is passed in, only new code smells not in the baseline are printed in the console.
String	basePath()	Retrieves the base path.
DetektOperation	basePath(File path)	Specifies a directory as the base path.
DetektOperation	basePath(String path)	Specifies a directory as the base path.
DetektOperation	basePath(Path path)	Specifies a directory as the base path.
DetektOperation	buildUponDefaultConfig(boolean buildUponDefaultConfig)	Preconfigures detekt with a bunch of rules and some opinionated defaults for you.
Collection<File>	classPath()	Paths where to find user class files and jar dependencies.
DetektOperation	classPath(File... paths)	EXPERIMENTAL: Paths where to find user class files and jar dependencies.
DetektOperation	classPath(String... paths)	EXPERIMENTAL: Paths where to find user class files and jar dependencies.
DetektOperation	classPath(Path... paths)	EXPERIMENTAL: Paths where to find user class files and jar dependencies.
DetektOperation	classPath(Collection<File> paths)	EXPERIMENTAL: Paths where to find user class files and jar dependencies.
DetektOperation	classPathPaths(Collection<Path> paths)	EXPERIMENTAL: Paths where to find user class files and jar dependencies.
DetektOperation	classPathStrings(Collection<String> paths)	EXPERIMENTAL: Paths where to find user class files and jar dependencies.
Collection<File>	config()	Paths to config files.
DetektOperation	config(File... configs)	Paths to the config files (path/to/config.yml).
DetektOperation	config(String... configs)	Paths to the config files (path/to/config.yml).
DetektOperation	config(Path... configs)	Paths to the config files (path/to/config.yml).
DetektOperation	config(Collection<File> configs)	Paths to the config files (path/to/config.yml).
DetektOperation	configPaths(Collection<Path> configs)	Paths to the config files (path/to/config.yml).
String	configResource()	Retrieves the path of the config resource.
DetektOperation	configResource(File resource)	Path to the config resource on detekt's classpath (path/to/config.yml).
DetektOperation	configResource(String resource)	Path to the config resource on detekt's classpath (path/to/config.yml).
DetektOperation	configResource(Path resource)	Path to the config resource on detekt's classpath (path/to/config.yml).
DetektOperation	configStrings(Collection<String> configs)	Paths to the config files (path/to/config.yml).
DetektOperation	createBaseline(boolean createBaseline)	Treats current analysis findings as a smell baseline for future detekt runs.
DetektOperation	debug(boolean debug)	Prints extra information about configurations and extensions.
DetektOperation	disableDefaultRuleSets(boolean disable)	Disables default rule sets.
Collection<String>	excludes()	Returns the globbing patterns describing paths to exclude from the analysis.
DetektOperation	excludes(String... patterns)	Globbing patterns describing paths to exclude from the analysis.
DetektOperation	excludes(Collection<String> patterns)	Globbing patterns describing paths to exclude from the analysis.
void	execute()	Performs the operation.
protected List<String>	executeConstructProcessCommandList()	Part of the execute() operation, constructs the command list to use for building the process.
DetektOperation	fromProject(BaseProject project)	Configures the operation from a BaseProject.
DetektOperation	generateConfig(boolean generate)	Export default config.
Collection<String>	includes()	Returns the globbing patterns describing paths to include in the analysis.
DetektOperation	includes(String... patterns)	Globbing patterns describing paths to include in the analysis.
DetektOperation	includes(Collection<String> patterns)	Globbing patterns describing paths to include in the analysis.
Collection<File>	input()	Returns the input paths to analyze.
DetektOperation	input(File... paths)	Input paths to analyze.
DetektOperation	input(String... paths)	Input paths to analyze.
DetektOperation	input(Path... paths)	Input paths to analyze.
DetektOperation	input(Collection<File> paths)	Input paths to analyze.
DetektOperation	inputPaths(Collection<Path> paths)	Input paths to analyze.
DetektOperation	inputStrings(Collection<String> paths)	Input paths to analyze.
DetektOperation	jdkHome(String path)	EXPERIMENTAL: Use a custom JDK home directory to include into the classpath.
DetektOperation	jvmTarget(String target)	EXPERIMENTAL: Target version of the generated JVM bytecode that was generated during compilation and is now being used for type resolution
DetektOperation	languageVersion(String version)	EXPERIMENTAL: Compatibility mode for Kotlin language version X.Y, reports errors for all language features that came out later.
DetektOperation	maxIssues(int max)	Return exit code 0 only when found issues count does not exceed specified issues count.
DetektOperation	parallel(boolean parallel)	Enables parallel compilation and analysis of source files.
Collection<File>	plugins()	Extra path to plugins jars.
DetektOperation	plugins(File... jars)	Extra paths to plugin jars.
DetektOperation	plugins(String... jars)	Extra paths to plugin jars.
DetektOperation	plugins(Path... jars)	Extra paths to plugin jars.
DetektOperation	plugins(Collection<File> jars)	Extra paths to plugin jars.
DetektOperation	pluginsPaths(Collection<Path> jars)	Extra paths to plugin jars.
DetektOperation	pluginsStrings(Collection<String> jars)	Extra paths to plugin jars.
DetektOperation	report(Report... reports)	Generates a report for given report-id and stores it on given 'path'.

Methods inherited from class rife.bld.operations.AbstractProcessOperation

classpath, classpath, classpath, environment, environment, environment, errorProcessor, errorProcessor, executeStartProcess, javaOptions, javaOptions, javaTool, javaTool, mainClass, mainClass, module, module, modulePath, modulePath, modulePath, outputProcessor, outputProcessor, process, workDirectory, workDirectory

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent

Methods inherited from class java.lang.Object

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

Constructor Details

DetektOperation

public DetektOperation()

Method Details

allRules

public DetektOperation allRules(boolean allRules)

Activates all available (even unstable) rules.

Parameters:

allRules - true or false

Returns:

this operation instance

autoCorrect

public DetektOperation autoCorrect(boolean autoCorrect)

Allow rules to autocorrect code if they support it. The default rule sets do NOT support autocorrecting and won't change any line in the users code base. However, custom rules can be written to support autocorrecting. The additional 'formatting' rule set, added with Plugins, does support it and needs this flag.

Parameters:

autoCorrect - true or false

Returns:

this operation instance

basePath

public DetektOperation basePath(String path)

Specifies a directory as the base path. Currently, it impacts all file paths in the formatted reports. File paths in console output and txt report are not affected and remain as absolute paths.

Parameters:

path - the directory path

Returns:

this operation instance

basePath

public DetektOperation basePath(File path)

Specifies a directory as the base path. Currently, it impacts all file paths in the formatted reports. File paths in console output and txt report are not affected and remain as absolute paths.

Parameters:

path - the directory path

Returns:

this operation instance

basePath

public String basePath()

Retrieves the base path.

Returns:

the directory path

basePath

public DetektOperation basePath(Path path)

Specifies a directory as the base path. Currently, it impacts all file paths in the formatted reports. File paths in console output and txt report are not affected and remain as absolute paths.

Parameters:

path - the directory path

Returns:

this operation instance

baseline

public DetektOperation baseline(String baseline)

If a baseline xml file is passed in, only new code smells not in the baseline are printed in the console.

Parameters:

baseline - the baseline xml file

Returns:

this operation instance

baseline

public DetektOperation baseline(File baseline)

If a baseline xml file is passed in, only new code smells not in the baseline are printed in the console.

Parameters:

baseline - the baseline xml file

Returns:

this operation instance

baseline

public DetektOperation baseline(Path baseline)

If a baseline xml file is passed in, only new code smells not in the baseline are printed in the console.

Parameters:

baseline - the baseline xml file

Returns:

this operation instance

baseline

public String baseline()

Retrieves the baseline xml file.

Returns:

the baseline xml file

buildUponDefaultConfig

public DetektOperation buildUponDefaultConfig(boolean buildUponDefaultConfig)

Preconfigures detekt with a bunch of rules and some opinionated defaults for you. Allows additional provided configurations to override the defaults.

Parameters:

buildUponDefaultConfig - true or false

Returns:

this operation instance

classPath

public DetektOperation classPath(File... paths)

EXPERIMENTAL: Paths where to find user class files and jar dependencies. Used for type resolution.

Parameters:

paths - one or more files

Returns:

this operation instance

See Also:

• classPath(Collection)

classPath

public DetektOperation classPath(Path... paths)

EXPERIMENTAL: Paths where to find user class files and jar dependencies. Used for type resolution.

Parameters:

paths - one or more files

Returns:

this operation instance

See Also:

• classPathPaths(Collection)

classPath

public DetektOperation classPath(String... paths)

EXPERIMENTAL: Paths where to find user class files and jar dependencies. Used for type resolution.

Parameters:

paths - one or more files

Returns:

this operation instance

See Also:

• classPathStrings(Collection)

classPath

public DetektOperation classPath(Collection<File> paths)

EXPERIMENTAL: Paths where to find user class files and jar dependencies. Used for type resolution.

Parameters:

paths - the paths

Returns:

this operation instance

See Also:

• classPath(File...)

classPath

public Collection<File> classPath()

Paths where to find user class files and jar dependencies.

Returns:

the paths

classPathPaths

public DetektOperation classPathPaths(Collection<Path> paths)

EXPERIMENTAL: Paths where to find user class files and jar dependencies. Used for type resolution.

Parameters:

paths - the paths

Returns:

this operation instance

See Also:

• classPath(Path...)

classPathStrings

public DetektOperation classPathStrings(Collection<String> paths)

EXPERIMENTAL: Paths where to find user class files and jar dependencies. Used for type resolution.

Parameters:

paths - the paths

Returns:

this operation instance

See Also:

• classPath(String...)

config

public DetektOperation config(File... configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - one or more config files

Returns:

this operation instance

See Also:

• config(Collection)

config

public DetektOperation config(Path... configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - one or more config files

Returns:

this operation instance

See Also:

• configPaths(Collection)

config

public DetektOperation config(String... configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - one or more config files

Returns:

this operation instance

See Also:

• configStrings(Collection)

config

public DetektOperation config(Collection<File> configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - the config files

Returns:

this operation instance

See Also:

• config(File...)

config

public Collection<File> config()

Paths to config files.

Returns:

the config files paths.

configPaths

public DetektOperation configPaths(Collection<Path> configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - the config files

Returns:

this operation instance

See Also:

• config(Path...)

configResource

public DetektOperation configResource(String resource)

Path to the config resource on detekt's classpath (path/to/config.yml).

Parameters:

resource - the config resource path

Returns:

this operation instance

configResource

public DetektOperation configResource(File resource)

Path to the config resource on detekt's classpath (path/to/config.yml).

Parameters:

resource - the config resource path

Returns:

this operation instance

configResource

public DetektOperation configResource(Path resource)

Path to the config resource on detekt's classpath (path/to/config.yml).

Parameters:

resource - the config resource path

Returns:

this operation instance

configResource

public String configResource()

Retrieves the path of the config resource.

Returns:

the config resource path

configStrings

public DetektOperation configStrings(Collection<String> configs)

Paths to the config files (path/to/config.yml).

Parameters:

configs - the config files

Returns:

this operation instance

See Also:

• config(String...)

createBaseline

public DetektOperation createBaseline(boolean createBaseline)

Treats current analysis findings as a smell baseline for future detekt runs.

Parameters:

createBaseline - true or false

Returns:

this operation instance

debug

public DetektOperation debug(boolean debug)

Prints extra information about configurations and extensions.

Parameters:

debug - true or false

Returns:

this operation instance

disableDefaultRuleSets

public DetektOperation disableDefaultRuleSets(boolean disable)

Disables default rule sets.

Parameters:

disable - true or false

Returns:

this operation instance

excludes

public DetektOperation excludes(String... patterns)

Globbing patterns describing paths to exclude from the analysis.

Parameters:

patterns - one or more pattern

Returns:

this operation instance

excludes

public DetektOperation excludes(Collection<String> patterns)

Globbing patterns describing paths to exclude from the analysis.

Parameters:

patterns - a collection of patterns

Returns:

this operation instance

excludes

public Collection<String> excludes()

Returns the globbing patterns describing paths to exclude from the analysis.

Returns:

the globbing patterns

execute

public void execute()
             throws IOException,
InterruptedException,
ExitStatusException

Performs the operation.

Overrides:

execute in class AbstractProcessOperation<DetektOperation>

Throws:

InterruptedException - when the operation was interrupted

IOException - when an exception occurred during the execution of the process

ExitStatusException - when the exit status was changed during the operation

executeConstructProcessCommandList

protected List<String> executeConstructProcessCommandList()

Part of the execute() operation, constructs the command list to use for building the process.

Specified by:

executeConstructProcessCommandList in class AbstractProcessOperation<DetektOperation>

fromProject

public DetektOperation fromProject(BaseProject project)

Configures the operation from a BaseProject.

Sets the following:

• baseline to detekt-baseline.xml, if it exists
• excludes to exclude build and resources directories

Specified by:

fromProject in class AbstractProcessOperation<DetektOperation>

Parameters:

project - the project to configure the operation from

Returns:

this operation instance

generateConfig

public DetektOperation generateConfig(boolean generate)

Export default config. Path can be specified with config option.

Default path: default-detekt-config.yml

Parameters:

generate - true or false

Returns:

this operation instance

includes

public DetektOperation includes(String... patterns)

Globbing patterns describing paths to include in the analysis. Useful in combination with excludes patterns.

Parameters:

patterns - one or more patterns

Returns:

this operation instance

includes

public DetektOperation includes(Collection<String> patterns)

Globbing patterns describing paths to include in the analysis. Useful in combination with excludes patterns.

Parameters:

patterns - a collection of patterns

Returns:

this operation instance

includes

public Collection<String> includes()

Returns the globbing patterns describing paths to include in the analysis.

Returns:

the globbing patterns

input

public DetektOperation input(Collection<File> paths)

Input paths to analyze. If not specified the current working directory is used.

Parameters:

paths - the paths

Returns:

this operation instance

See Also:

• input(Collection)

input

public DetektOperation input(String... paths)

Input paths to analyze. If not specified the current working directory is used.

Parameters:

paths - one or more paths

Returns:

this operation instance

See Also:

• inputStrings(Collection)

input

public DetektOperation input(File... paths)

Input paths to analyze. If not specified the current working directory is used.

Parameters:

paths - one or more paths

Returns:

this operation instance

See Also:

• input(Collection)

input

public DetektOperation input(Path... paths)

Input paths to analyze. If not specified the current working directory is used.

Parameters:

paths - one or more paths

Returns:

this operation instance

See Also:

• inputPaths(Collection)

input

public Collection<File> input()

Returns the input paths to analyze.

Returns:

the input paths

inputPaths

public DetektOperation inputPaths(Collection<Path> paths)

Input paths to analyze. If not specified the current working directory is used.

Parameters:

paths - the paths

Returns:

this operation instance

See Also:

• input(Path...)

inputStrings

public DetektOperation inputStrings(Collection<String> paths)

Input paths to analyze. If not specified the current working directory is used.

Parameters:

paths - the paths

Returns:

this operation instance

See Also:

• input(String...)

jdkHome

public DetektOperation jdkHome(String path)

EXPERIMENTAL: Use a custom JDK home directory to include into the classpath.

Parameters:

path - the JDK home directory path

Returns:

this operation instance

jvmTarget

public DetektOperation jvmTarget(String target)

EXPERIMENTAL: Target version of the generated JVM bytecode that was generated during compilation and is now being used for type resolution

Default: 1.8

Parameters:

target - the target version

Returns:

this operation instance

languageVersion

public DetektOperation languageVersion(String version)

EXPERIMENTAL: Compatibility mode for Kotlin language version X.Y, reports errors for all language features that came out later.

Possible Values: [1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2.0, 2.1]

Parameters:

version - the version

Returns:

this operation instance

maxIssues

public DetektOperation maxIssues(int max)

Return exit code 0 only when found issues count does not exceed specified issues count.

Parameters:

max - the issues code

Returns:

this operation instance

parallel

public DetektOperation parallel(boolean parallel)

Enables parallel compilation and analysis of source files. Do some benchmarks first before enabling this flag. Heuristics show performance benefits starting from 2000 lines of Kotlin code.

Parameters:

parallel - true or false

Returns:

this operation instance

plugins

public DetektOperation plugins(String... jars)

Extra paths to plugin jars.

Parameters:

jars - one or more jars

Returns:

this operation instance

See Also:

• pluginsStrings(Collection)

plugins

public DetektOperation plugins(File... jars)

Extra paths to plugin jars.

Parameters:

jars - one or more jars

Returns:

this operation instance

See Also:

• plugins(Collection)

plugins

public DetektOperation plugins(Path... jars)

Extra paths to plugin jars.

Parameters:

jars - one or more jars

Returns:

this operation instance

See Also:

• pluginsPaths(Collection)

plugins

public DetektOperation plugins(Collection<File> jars)

Extra paths to plugin jars.

Parameters:

jars - the jars paths

Returns:

this operation instance

See Also:

• input(File...)

plugins

public Collection<File> plugins()

Extra path to plugins jars.

Returns:

the jars paths

pluginsPaths

public DetektOperation pluginsPaths(Collection<Path> jars)

Extra paths to plugin jars.

Parameters:

jars - the jars paths

Returns:

this operation instance

See Also:

• plugins(Path...)

pluginsStrings

public DetektOperation pluginsStrings(Collection<String> jars)

Extra paths to plugin jars.

Parameters:

jars - the jars paths

Returns:

this operation instance

See Also:

• plugins(String...)

report

public DetektOperation report(Report... reports)

Generates a report for given report-id and stores it on given 'path'.

Parameters:

reports - one or more reports

Returns:

this operation instance