Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing --code-style flag in CLI documentation #2921

Merged
merged 1 commit into from
Jan 4, 2025
Merged

Add missing --code-style flag in CLI documentation #2921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions documentation/release-latest/docs/install/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,10 @@ Some rules can be tweaked via the [`editorconfig file`](../../rules/configuratio
A scaffold of the `.editorconfig` file can be generated with command below. Note: that the generated file only contains configuration settings which are actively used by the [rules which are loaded](#rule-sets):

```shell title="Generate .editorconfig"
# Specify the code style(ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig
ktlint generateEditorConfig ktlint_official
# Specify the code style (ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig
ktlint generateEditorConfig --code-style ktlint_official
# or
ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig android_studio
ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig --code-style android_studio
```

Normally the `.editorconfig` file is located in the root of your project directory. In case the file is located in a sub folder of the project, the settings of that file only applies to that subdirectory and its folders (recursively). Ktlint automatically detects and reads all `.editorconfig` files in your project.
Expand Down
6 changes: 3 additions & 3 deletions documentation/snapshot/docs/install/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,10 @@ Some rules can be tweaked via the [`editorconfig file`](../../rules/configuratio
A scaffold of the `.editorconfig` file can be generated with command below. Note: that the generated file only contains configuration settings which are actively used by the [rules which are loaded](#rule-sets):

```shell title="Generate .editorconfig"
# Specify the code style(ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig
ktlint generateEditorConfig ktlint_official
# Specify the code style (ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig
ktlint generateEditorConfig --code-style ktlint_official
# or
ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig android_studio
ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig --code-style android_studio
```

Normally the `.editorconfig` file is located in the root of your project directory. In case the file is located in a sub folder of the project, the settings of that file only applies to that subdirectory and its folders (recursively). Ktlint automatically detects and reads all `.editorconfig` files in your project.
Expand Down
Loading