Skip to content

Commit

Permalink
chore: drop code-style after v1.0.0 (#46)
Browse files Browse the repository at this point in the history
* `code-style` command line argument is deprecated pinterest/ktlint@85ef029
* `.editorconfig` needs to be used starting v1.0.1
  • Loading branch information
ghaiszaher authored Oct 16, 2023
1 parent 8b728e4 commit 0ff81ef
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,20 @@ See reviewdog fail on error [documentation](https://github.com/reviewdog/reviewd
Optional. Print files relative to the working directory [`true`/`false`]
The default value is true.

### `android`
### `android` (deprecated)

Optional. Runs KtLint with [Android Kotlin Style Guide](https://android.github.io/kotlin-guides/style.html) [`true`/`false`]
The default value is false.

Note: this field has no effect if `ktlint_version` is 1.0.1 or later. `code-style` command-line argument is deprecated in ktlint. Instead, `ktlint_code_style` property in `.editorconfig`
needs to be used. Example:
```editorconfig
[*.{kt,kts}]
ktlint_code_style = android_studio
```

More in https://pinterest.github.io/ktlint/latest/rules/code-styles/

### `baseline`

Optional. Runs checks against the baseline file provided.
Expand Down
12 changes: 7 additions & 5 deletions entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,13 @@ ktlint_version=$(ktlint --version)
echo "ktlint version: $ktlint_version"

if [ "$(printf '%s\n' "0.49.1" "$ktlint_version" | sort -V | head -n1)" = "0.49.1" ]; then
if [ "$INPUT_ANDROID" = true ]; then
export ANDROID="--code-style=android_studio"
else
export ANDROID="--code-style=intellij_idea"
# --code-style is deprecated since 1.0.1 and .editorconfig needs to be used: https://pinterest.github.io/ktlint/latest/rules/code-styles/
if [ "$(printf '%s\n' "1.0.0" "$ktlint_version" | sort -V | tail -n1)" = "1.0.0" ]; then
if [ "$INPUT_ANDROID" = true ]; then
export ANDROID="--code-style=android_studio"
else
export ANDROID="--code-style=intellij_idea"
fi
fi
else
if [ "$INPUT_ANDROID" = true ]; then
Expand All @@ -55,4 +58,3 @@ ktlint --reporter=checkstyle $CUSTOM_RULE_PATH $RELATIVE $ANDROID $BASELINE $INP
-level="${INPUT_LEVEL}" \
-filter-mode="${INPUT_FILTER_MODE}" \
-fail-on-error="${INPUT_FAIL_ON_ERROR}"

0 comments on commit 0ff81ef

Please sign in to comment.