Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
40 changed files
with
8,958 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
website/versioned_docs/version-1.22.0/gettingstarted/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Getting Started", | ||
| "position": 3 | ||
| } |
10 changes: 10 additions & 0 deletions
10
website/versioned_docs/version-1.22.0/gettingstarted/_cli-generator-options.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ``` | ||
| Usage: java -jar detekt-generator-[detekt_version]-all.jar [options] | ||
| Options: | ||
| --generate-custom-rule-config, -gcrc | ||
| Generate custom rules configuration files. The files will be | ||
| placed under 'resources' folder of each rule respectively | ||
| (e.g. 'custom-rule/src/main/resources/config/config.yml'). | ||
| --input, -i | ||
| Input paths to rules to analyze. Multiple paths are separated by comma. | ||
| ``` |
89 changes: 89 additions & 0 deletions
89
website/versioned_docs/version-1.22.0/gettingstarted/_cli-options.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| ``` | ||
| Usage: detekt [options] | ||
| Options: | ||
| --all-rules | ||
| Activates all available (even unstable) rules. | ||
| Default: false | ||
| --auto-correct, -ac | ||
| Allow rules to auto correct code if they support it. The default rule | ||
| sets do NOT support auto correcting and won't change any line in the | ||
| users code base. However custom rules can be written to support auto | ||
| correcting. The additional 'formatting' rule set, added with | ||
| '--plugins', does support it and needs this flag. | ||
| Default: false | ||
| --base-path, -bp | ||
| 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. | ||
| --baseline, -b | ||
| If a baseline xml file is passed in, only new code smells not in the | ||
| baseline are printed in the console. | ||
| --build-upon-default-config | ||
| Preconfigures detekt with a bunch of rules and some opinionated defaults | ||
| for you. Allows additional provided configurations to override the | ||
| defaults. | ||
| Default: false | ||
| --classpath, -cp | ||
| EXPERIMENTAL: Paths where to find user class files and depending jar | ||
| files. Used for type resolution. | ||
| --config, -c | ||
| Path to the config file (path/to/config.yml). Multiple configuration | ||
| files can be specified with ',' or ';' as separator. | ||
| --config-resource, -cr | ||
| Path to the config resource on detekt's classpath (path/to/config.yml). | ||
| --create-baseline, -cb | ||
| Treats current analysis findings as a smell baseline for future detekt | ||
| runs. | ||
| Default: false | ||
| --debug | ||
| Prints extra information about configurations and extensions. | ||
| Default: false | ||
| --disable-default-rulesets, -dd | ||
| Disables default rule sets. | ||
| Default: false | ||
| --excludes, -ex | ||
| Globbing patterns describing paths to exclude from the analysis. | ||
| --generate-config, -gc | ||
| Export default config. Path can be specified with --config option | ||
| (default path: default-detekt-config.yml) | ||
| Default: false | ||
| --help, -h | ||
| Shows the usage. | ||
| --includes, -in | ||
| Globbing patterns describing paths to include in the analysis. Useful in | ||
| combination with 'excludes' patterns. | ||
| --input, -i | ||
| Input paths to analyze. Multiple paths are separated by comma. If not | ||
| specified the current working directory is used. | ||
| --jdk-home | ||
| EXPERIMENTAL: Use a custom JDK home directory to include into the | ||
| classpath | ||
| --jvm-target | ||
| EXPERIMENTAL: Target version of the generated JVM bytecode that was | ||
| generated during compilation and is now being used for type resolution | ||
| (1.6, 1.8, 9, 10, 11, 12, 13, 14, 15, 16 or 17) | ||
| Default: 1.8 | ||
| --language-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] | ||
| --max-issues | ||
| Return exit code 0 only when found issues count does not exceed | ||
| specified issues count. | ||
| --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. | ||
| Default: false | ||
| --plugins, -p | ||
| Extra paths to plugin jars separated by ',' or ';'. | ||
| --report, -r | ||
| Generates a report for given 'report-id' and stores it on given 'path'. | ||
| Entry should consist of: [report-id:path]. Available 'report-id' values: | ||
| 'txt', 'xml', 'html', 'md', 'sarif'. These can also be used in | ||
| combination with each other e.g. '-r txt:reports/detekt.txt -r | ||
| xml:reports/detekt.xml' | ||
| --version | ||
| Prints the detekt CLI version. | ||
| Default: false | ||
| ``` |
61 changes: 61 additions & 0 deletions
61
website/versioned_docs/version-1.22.0/gettingstarted/cli.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| title: "Run detekt using Command Line Interface" | ||
| keywords: [cli] | ||
| sidebar: | ||
| permalink: cli.html | ||
| folder: gettingstarted | ||
| summary: | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| import CliOptions from "./_cli-options.md"; | ||
| import CliGeneratorOptions from "./_cli-generator-options.md"; | ||
|
|
||
| ## Install the cli | ||
|
|
||
| There are different ways to install the Command Line Interface (CLI): | ||
|
|
||
| ### MacOS, with [Homebrew](https://brew.sh/): | ||
|
|
||
| ```sh | ||
| brew install detekt | ||
| detekt [options] | ||
| ``` | ||
|
|
||
| ### Windows, with [Scoop](https://scoop.sh/) | ||
|
|
||
| ```powershell | ||
| scoop install detekt | ||
| detekt [options] | ||
| ``` | ||
|
|
||
| ### Any OS: | ||
|
|
||
| ```sh | ||
| curl -sSLO https://github.com/detekt/detekt/releases/download/v[detekt_version]/detekt-cli-[detekt_version].zip | ||
| unzip detekt-cli-[detekt_version].zip | ||
| ./detekt-cli-[detekt_version]/bin/detekt-cli --help | ||
| ``` | ||
|
|
||
| ## Use the cli | ||
|
|
||
| detekt will exit with one of the following exit codes: | ||
|
|
||
| | Exit code | Description | | ||
| | --------- | ------------------------------------------------------------------------------ | | ||
| | 0 | detekt ran normally and maxIssues count was not reached in BuildFailureReport. | | ||
| | 1 | An unexpected error occurred | | ||
| | 2 | MaxIssues count was reached in BuildFailureReport. | | ||
| | 3 | Invalid detekt configuration file detected. | | ||
|
|
||
| The following parameters are shown when `--help` is entered. | ||
|
|
||
| <CliOptions /> | ||
|
|
||
| ## Use the cli to generate configuration for custom rules | ||
|
|
||
| <CliGeneratorOptions /> | ||
|
|
||
| ```sh | ||
| java -jar detekt-generator-[detekt_version]-all.jar -gcrc -i /path/to/rule1, /path/to/rule2 | ||
| ``` |
82 changes: 82 additions & 0 deletions
82
website/versioned_docs/version-1.22.0/gettingstarted/git-pre-commit-hook.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| --- | ||
| title: "Run detekt using a Git pre-commit hook" | ||
| keywords: [detekt, static, analysis, code, kotlin] | ||
| sidebar: | ||
| permalink: git-pre-commit-hook.html | ||
| folder: gettingstarted | ||
| summary: | ||
| sidebar_position: 6 | ||
| --- | ||
|
|
||
| Detekt can be integrated into your development workflow by using a Git pre-commit hook. | ||
| For that reason Git supports to run custom scripts automatically, when a specific action occurs. | ||
| The mentioned pre-commit hook can be setup locally on your dev-machine. | ||
| The following client-side detekt hook is triggered by a commit operation, and checks all files via the gradle task. | ||
|
|
||
| ```bash | ||
| #!/usr/bin/env bash | ||
| echo "Running detekt check..." | ||
| OUTPUT="/tmp/detekt-$(date +%s)" | ||
| ./gradlew detekt > $OUTPUT | ||
| EXIT_CODE=$? | ||
| if [ $EXIT_CODE -ne 0 ]; then | ||
| cat $OUTPUT | ||
| rm $OUTPUT | ||
| echo "***********************************************" | ||
| echo " Detekt failed " | ||
| echo " Please fix the above issues before committing " | ||
| echo "***********************************************" | ||
| exit $EXIT_CODE | ||
| fi | ||
| rm $OUTPUT | ||
| ``` | ||
|
|
||
| The shell script can be installed by copying the content over to `<<your-repo>>/.git/hooks/pre-commit`. | ||
| This pre-commit hook needs to be executable, so you may need to change the permission (`chmod +x pre-commit`). | ||
| More information about Git hooks and how to install them can be found in | ||
| [Atlassian's tutorial](https://www.atlassian.com/git/tutorials/git-hooks). | ||
|
|
||
| A special thanks goes to Mohit Sarveiya for providing this shell script. | ||
| You can watch his excellent talk about **Static Code Analysis For Kotlin** on | ||
| [YouTube](https://www.youtube.com/watch?v=LT6m5_LO2DQ). | ||
|
|
||
| ## Only run on staged files | ||
|
|
||
| It is also possible to use [the CLI](/docs/gettingstarted/cli) to create a hook that only runs on staged files. This has the advantage of speedier execution, by running on fewer files and avoiding the warm-up time of the gradle daemon. | ||
|
|
||
| Please note, however, that a handful of checks requiring [type resolution](/docs/gettingstarted/type-resolution) will not work correctly with this approach. If you do adopt a partial hook, it is recommended that you still implement a full `detekt` check as part of your CI pipeline. | ||
|
|
||
| This example has been put together using [pre-commit](https://pre-commit.com/), but the same principle can be applied to any kind of hook. | ||
|
|
||
| Hook definition in pre-commit: | ||
|
|
||
| ```yml | ||
| - id: detekt | ||
| name: detekt check | ||
| description: Runs `detekt` on modified .kt files. | ||
| language: script | ||
| entry: detekt.sh | ||
| files: \.kt | ||
| ``` | ||
|
|
||
| Script `detekt.sh`: | ||
|
|
||
| ```bash | ||
| #!/bin/bash | ||
|
|
||
| echo "Running detekt check..." | ||
| fileArray=($@) | ||
| detektInput=$(IFS=,;printf "%s" "${fileArray[*]}") | ||
| echo "Input files: $detektInput" | ||
|
|
||
| OUTPUT=$(detekt --input "$detektInput" 2>&1) | ||
| EXIT_CODE=$? | ||
| if [ $EXIT_CODE -ne 0 ]; then | ||
| echo $OUTPUT | ||
| echo "***********************************************" | ||
| echo " Detekt failed " | ||
| echo " Please fix the above issues before committing " | ||
| echo "***********************************************" | ||
| exit $EXIT_CODE | ||
| fi | ||
| ``` |
Oops, something went wrong.