build(deps): bump org.jlleitschuh.gradle.ktlint from 11.6.1 to 12.1.1 & ktlint 1.5.0

[david-allison]

Reviewers: please pay attention to the manual changes in the commits. They have been fully split out

Important

Please don't merge anything else until after this is merged, or will be a define "can't merge".
This is almost certainly going to conflict, and took a LOT of work to get into a good state

Note: this could be split into 2 PRs: one per dependency, but it felt sensible to combine the two, as was done in the linked commit

Fixes

• Fixes build(deps): bump org.jlleitschuh.gradle.ktlint from 11.6.1 to 12.0.2 #14870
• Follow-on from: style(lint) manual fixes for gradle.ktlint 12.1.1 / ktLint 1.5.0 #17577
• Needs a follow-up issue/PR to ignore these commits in git blame

Approach

• Upgrade to org.jlleitschuh.gradle.ktlint 12.1.1
• Upgrade to ktlint 1.5.0

Similar approach to both:

1. Pre-fix
   • Perform the version upgrade, then ./gradlew --rerun-tasks ktLintFormat
   • Revert the version upgrade and run ./gradlew --rerun-tasks ktLintFormat again
   • One initial commit for manual fixups
   • A second commit for automated fixups
2. Version bump + limited diff of automated changes via ./gradlew --rerun-tasks ktLintFormat

How Has This Been Tested?

CI.

Ran ./gradlew --rerun-tasks ktLintFormat on each commit. Success, and no changes

Learning (optional, can help others)

We really shouldn't let lint get out of date

⚠️ A potential compiler bug in CardBrowser caused by annotations on a when.
ktlint didn't seem to like it. Fixed in 1.5.0 I believe, but one to note

Checklist

• You have a descriptive commit message with a short title (first line, max 50 chars).
• You have commented your code, particularly in hard-to-understand areas
• You have performed a self-review of your own code
• UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
• UI Changes: You have tested your change using the Google Accessibility Scanner

[mikehardy]

Wow! Someone's going for the LOC-changed-leaderboard 😆
The whole point of autolinters is not to argue about them, I personally see no point in it
As long as everyone is aware that they will need to rebase their PRs after this - needs a big announcement I think? - works for me
This dependency has hung out for far too long and it really queued up quite the change

[david-allison]

I do want to note I added:

# We often have block comments representing implementation details after KDocs.
# This feels like an acceptable commenting strategy
ktlint_standard_no-consecutive-comments = disabled

This did not like UniqueArrayList at all (as an example), even though I found the comments to be clean.

Anki-Android/AnkiDroid/src/main/java/com/ichi2/utils/UniqueArrayList.kt

Lines 22 to 90 in 58e6a9d

	/**
	* A collection of items that doesn't allow duplicate items, and allows fast random access, lookup, maintaining order, and sorting.
	*
	*
	* The [List] interface makes certain assumptions/requirements. This
	* implementation breaks these in certain ways, but this is merely the result of
	* rejecting duplicates. Each violation is explained in the method, but it
	* should not affect you.
	*
	* This class does also implement the [Set] interface, and as a result
	* you should bear in mind that Sets require immutable objects to function correctly.
	*
	* @implNote The implementation of this class extends [SetUniqueList] and adds the ability to define a comparator
	* to be used to judge uniqueness of elements, and allows sorting.
	*
	*
	* Data structures used internally:
	* - [ArrayList] to enable fast random access, sorting, and maintaining order of items during iteration
	* - [TreeSet] if a comparator is given or a [HashSet] otherwise.
	*/
	class UniqueArrayList<E>
	/**
	* Constructor that wraps (not copies) the List and specifies the set to use.
	*
	*
	* The set and list must both be correctly initialised to the same elements.
	*
	* @param set the set to decorate, must not be null
	* @param list the list to decorate, must not be null
	* @throws NullPointerException if set or list is null
	*/
	private constructor(
	/**
	* Internal list used in [SetUniqueList] implementation.
	*
	*
	* This is the same list as the one used internally in [SetUniqueList]. We keep a reference to it here in
	* order to be able to sort it. [SetUniqueList] implementation needs to make sure the internal [Set]
	* and [List] don't get out of sync, and [<] cannot be sorted via [Collections.sort]
	* or [SetUniqueList.sort] both will throw an exception, due to a limitation on this class [java.util.ListIterator]
	*
	* Sorting can be only done via [UniqueArrayList.sort] or [UniqueArrayList.sort].
	*
	* Modification to this list reference should be done with cautious to avoid having the internal [Set] out of sync
	*/
	private val list: MutableList<E>,
	set: Set<E>?
	) : SetUniqueList<E>(list, set), MutableList<E>, MutableSet<E> {
	/**
	* Constructs a new empty [UniqueArrayList]
	*/
	constructor() : this(ArrayList<E>(), HashSet<E>())
	/**
	* Sorts the list into ascending order, according to the
	* [natural ordering][Comparable] of its elements.
	* All elements in the list must implement the [Comparable]
	* interface. Furthermore, all elements in the list must be
	* *mutually comparable* (that is, `e1.compareTo(e2)`
	* must not throw a `ClassCastException` for any elements
	* `e1` and `e2` in the list).
	*
	* @see .sort
	*/
	@KotlinCleanup("sortWith")
	fun sort() {
	sortOverride(null)
	}

We lose out on the following, which is a little messy

Anki-Android/AnkiDroid/src/main/java/com/ichi2/libanki/Tags.kt

Lines 88 to 98 in e38bfe4

	/*
	* List-based utilities
	* ***********************************************************
	*/
	/** {@inheritDoc} */
	// this is now a no-op - the tags are canonified when the note is saved
	fun canonify(tagList: List<String>): AbstractSet<String> {
	// libAnki difference: tagList was returned directly
	return HashSet(tagList)
	}

But the fix with additional lines was worse:

     /* 
      * List-based utilities 
      * *********************************************************** 
      */ 

     // this is now a no-op - the tags are canonified when the note is saved 

     /** {@inheritDoc}  */   
     fun canonify(tagList: List<String>): AbstractSet<String> { 
         // libAnki difference: tagList was returned directly 
         return HashSet(tagList) 
     } 

[BrayanDSO]

Thank you