Skip to content

Small update to the linter information for the documentation website #810

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

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Small update to the linter information for the documentation website #810

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
16 changes: 14 additions & 2 deletions docs/StardustDocs/topics/gettingStartedGradleAdvanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,13 +154,16 @@ dependencies {
#### Linter configuration

We provide a Gradle plugin that generates interfaces with your data.
Use this configuration to prevent linter from complaining about formatting in the generated sources.
If you're using any sort of linter, it might complain about them generated sources.

Use a configuration similar to this to prevent your linter from complaining about the
formatting of the generated sources.

<tabs>
<tab title="Kotlin DSL">

```kotlin
// (Only if you use kotlint) Excludes for `kotlint`:
// Exclusions for `kotlinter`, if you use it:
tasks.withType<org.jmailen.gradle.kotlinter.tasks.LintTask> {
exclude {
it.name.endsWith(".Generated.kt")
Expand All @@ -176,6 +179,7 @@ tasks.withType<org.jmailen.gradle.kotlinter.tasks.LintTask> {
<tab title="Groovy DSL">

```groovy
// Exclusions for `kotlinter`, if you use it:
tasks.withType(org.jmailen.gradle.kotlinter.tasks.LintTask).all {
exclude {
it.name.endsWith(".Generated.kt")
Expand All @@ -186,6 +190,14 @@ tasks.withType(org.jmailen.gradle.kotlinter.tasks.LintTask).all {
}
```

</tab>
<tab title=".editorconfig">

```.editorconfig
[{**/*.Generated.kt,**/*$Extensions.kt}]
ktlint = disabled
```

</tab>

</tabs>