Chimney stabilization into 1.0.0

[MateuszKubuszok]

List of things to do before preparing 1.0.0 (if needed turn these into separate issues):

• release 1.0.0-RC1
  • provide better nested paths to values in all .withField*/.withSealedSubtype* - followup to Introduce nested paths #358, unblocked in Unified TransformerOverrides representation #490, Pattern matching on case refactor #491, Rename more type parameters, utilitie and change the order of type paremeters in Path for better readability and consistency #492, done in More nested-path functionalities #493
    • with Fix Overrides for Subtypes matching #499
    • and Adding new fields across all subtypes when converting ADTs? #498 (Allow using field overrides in ADTs (when field is available to all subtypes) #512)
  • deprecate .withCoproductInstance in favor of .withSealedSubtypeComputed + .withEnumCaseComputed (alias) - Deprecate withCoproductInstance name #500
  • provide interface for custom optional types and collections
    • integrate it with better nested paths
    • use it to re-implement chimney-java-collections (Java collections as integrations #510)
    • use it to implement chimney-cats support for NonEmpty*/Chain (Be able to convert from NonEmptyList[T] to Seq[T] #421, fixed in Cats data integrations #511)
  • verify that mutable collections are supported
  • verify that IArray on Scala 3 is supported there is some issue, I'll talk to Scala 3 people about it
  • documentation
    • differences between .withSealedSubtype[Sub](...) and withFieldComputed(_.matching[Sub], ...)
    • limitations of .withFieldRenamed on left path (only fieldnames)
    • limitations of option/either support (cannot use .matching)
    • Scala 3 bugs - ClassCastException thrown on Scala 3 when transforming sealed traits to Protobuf GeneratedEnum #479, Can't transform coproduct - Java Enum to Sealed trait #482, Cannot transform Scala class to Java class #484 - it seems that if these bugs will be fixed it's not going to be anytime before the release of RC, we might add information about the bugs/workarounds later when they are known
    • Scaladocs - make scaladocs compile without disabling -Xfatal-errors - Suppress all scaladoc errors causing publishing to fail #494
    • check documentation (.md) formatting with Scala CLI + scalafmt - unfortunately it cannot work OOTB for us currently
    • format scaladoc with scalafmt (change docstrings.wrap = no to yes)
    • add light/dark theme toggle to documentation - Add documentation color palette toggle #503
    • document gotchas and weird workarounds in code (Scala 2 enum workarounds, inconsistency with Matching for normal ADT, Options and Eithers)
    • document internal structures, why they exist etc
• add RC versions to MiMa
• change versionScheme to := Some("semver") - actially early-semver does not mean that the library is immature but that it's 0.x versions are bincompatible within x, we do not need to change it

This is more of my private todo wishlist than any official promise. Content subject to change, no ETA.