diffplug / diffplug/spotless

take toggleOffOn into account for linters

Open
#719 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
5.6k
Forks
559
Avg merge
1d 13h
Merged PRs (30d)
34

Description

First of all, I'm expecting a solution to this to be something extremely obvious but here it is.
Spotless setup in the project looks like this:
```
apply plugin: "com.diffplug.spotless"

spotless {

ext.targetBranch = "develop"
if (project.hasProperty('target_branch') && project.getProperty('target_branch')?.trim()) {
targetBranch = project.getProperty('target_branch')
}

ratchetFrom "origin/$targetBranch"

kotlin {
target '**/*.kt'
trimTrailingWhitespace()
indentWithSpaces()
toggleOffOn('format:off', 'format:on')

ktlint().userData([
'max_line_length': '120',
'disabled_rules' : 'import-ordering' //https://github.com/pinterest/ktlint/issues/527, https://youtrack.jetbrains.com/issue/KT-10974
])
}
}
```

The problem occurs when trying to exclude a part of the code using `spotless:off` and `spotless:on`
I also tried (as seen in the snippet above) with different tags but running `./gradlew spotlessCheck` still fails.

The part where it fails looks something like this:
```

// format:off
private fun functionName(): ReturnType = when (this) {
// A bunch of stuff, one line is >120 chars, our line limit
}
// format:on

```
Reason for failure:
```
java.lang.AssertionError: Error on line: 70, column: 1
Exceeded max line length (120)
```

What is it that I'm missing here?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.