how do I integrate ktlint as a jj fixtool

[badp]

ktlint has just been inflicted onto me, and I'm trying to integrate it into my workflow.

I've been using jj as a layer on top of git to make it easier to manage patch series. It lets me take a PR with 10 commits, edit the 3rd, and have the changes automatically ripple through the remaining 6 commits, without needing to enter a special git rebase flow.

Of course, any rebase operation could turn code that ktlint was happy with into code that ktlint is unhappy with. jj doesn't support commit hooks (long story), but it does accommodate for code reformatters — so long as they read source code from stdin, and write formatted source code to stdout, preferrably without throwing hands (ktlint being unable to wrap long lines around on its own is very disappointing).

Can ktlint be coerced to work in this fashion, so I can plug it into jj and keep using my workflow despite having to comply with ktlint's idea of what code is supposed to look like?

[badp]

Okay, it seems like (once I can figure out which version of ktlint is being used by ktlint-gradle... but that's a separate conversation), all I need to run is something not entirely unlike

$ jj config edit --repo
[fix.tools.ktlint]
# --loglevel=none because of https://github.com/pinterest/ktlint/issues/2246
command = ["/path/to/ktlint", "-F", "--stdin", "--stdin-path=$path", "--editorconfig", "/path/to/.editorconfig", "--loglevel=none"]
patterns = ["glob:'**/*.kt'", "glob:'**/*.kts'"]

It's not a perfect solution because the editorconfig file might change mid-branch, and jj fix will apply the same editorconfig to all editable commits... but that's a shortcoming of jj's design.

[paul-dingemans]

Cool you found most of the answers yourselves.

Okay, it seems like (once I can figure out which version of ktlint is being used by ktlint-gradle... b

Currently it uses 1.6.0 (https://github.com/JLLeitschuh/ktlint-gradle/blob/main/plugin/build.gradle.kts#L36)

preferrably without throwing hands (ktlint being unable to wrap long lines around on its own is very disappointing

Ktlint CLI does not provide any support for this. It would be rather a small change a new command line flag --ignore-all-format-errors in the next ktlint version 1.8.0 as an option (#3150)

[paul-dingemans]

preferrably without throwing hands (ktlint being unable to wrap long lines around on its own is very disappointing).

I have interpreted above as a problem with the exit code of ktlint in case of a violation is found that cannot be automatically corrected. In such a case ktlint exits with code 1 instead of 0. If that is indeed the blocking part of your problem, than it can be fixed with an option that tells ktlint to ignore such errors when determining the exit code. As I have not received any reply from you, I guess that I misinterpreted this. I not implement this option until it is confirmed that this solves your problem.

The expectation that ktlint can fix all violations, will never be met. It is just impossible to fix every possible violation in a deterministic manner.

[badp]

I'm sorry for not replying; I don't check github as part of any kind of routine. The option as you describe it is useful in that it will allow jj to run the fix command on all commits as much as possible.

[paul-dingemans]

Option will be added as --ignore-autocorrect-failures in Ktlint 1.8 (see #3157)