hamnis / dataclass-scalafix Goto Github PK

View Code? Open in Web Editor NEW

6.0 6.0 2.0 73 KB

License: Apache License 2.0

Scala 100.00%

dataclass-scalafix's People

Contributors

Stargazers

Watchers

Forkers

eed3si9n andrelfpinto

dataclass-scalafix's Issues

since annotation is not supported

https://github.com/alexarchambault/data-class#adding-fields

steps

package lmcoursier.credentials

import dataclass._

@data class DirectCredentials(
  host: String = "",
  username: String = "",
  password: String = "",
  @since
  realm: Option[String] = None,
  @since
  optional: Boolean = true,
  @since
  matchHost: Boolean = false,
  httpsOnly: Boolean = true
) {
  override def toString(): String = s"DirectCredentials(host=$host, username=$username)"
}

problem

Here's the generated code:

object DirectCredentials {
def apply(host: String, username: String, password: String, @since realm: Option[String], @since optional: Boolean, @since matchHost: Boolean, httpsOnly: Boolean): DirectCredentials = new DirectCredentials(host, username, password, realm, optional, matchHost, httpsOnly)
def apply(): DirectCredentials = new DirectCredentials("", "", "", None, true, false, true)
}

expectation

@since or @since("1.0.0") denotes newly introduced fields, and there should be def apply(...) without them, which helps to keep binary compatible API.

consider dropping the data annotation from generated sources

we dont really need the @data annotation after the fact.

Doesn't work with methods that use withX

steps

package lmcoursier.definitions

import dataclass._

@data class Authentication(
  user: String,
  password: String,
) {
  override def toString(): String =
    withPassword("****")
      .productIterator
      .mkString("Authentication(", ", ", ")")
}

problem

This fails at the step where semanticdb is produced for the original file:

[error] /Users/xxx/work/sbt-coursier/modules/definitions/src/main/scala/lmcoursier/definitions/Authentication.scala:16:5: not found: value withPassword
[error]     withPassword("****")
[error]     ^

Reuse existing companion object

Minimized code

import dataclass.data

@data class Foo(bar: String)

object Foo {
  val baz = "baz"
}

Output

import dataclass.data

@data final class Foo private (val bar: String)
    extends Product
    with Serializable {

  ...

}

object Foo {
  def apply(bar: String): Foo = new Foo(bar)
}

object Foo {
  val baz = "baz"
}

Expectation

import dataclass.data

@data final class Foo private (val bar: String)
    extends Product
    with Serializable {

  ...

}

object Foo {
  val baz = "baz"

  def apply(bar: String): Foo = new Foo(bar)
}

implement companion.fromProduct(p: Product)

https://contributors.scala-lang.org/t/can-we-make-adding-a-parameter-with-a-default-value-binary-compatible/6132/8

steps

Use Scala 2.12

package lmcoursier.definitions

import dataclass._

@data class Strict(
  include: Set[(String, String)] = Set(("*", "*")),
  exclude: Set[(String, String)] = Set.empty,
) {
}

problems

[error] /Users/xxxx/work/sbt-coursier/modules/lm-coursier/target/scala-2.12/src_managed/main/scala/lmcoursier/definitions/Strict.scala:37:14: method productElementName overrides nothing
[error] override def productElementName(n: Int) = n match {
[error]              ^
[error] /Users/xxxx/work/sbt-coursier/modules/lm-coursier/target/scala-2.12/src_managed/main/scala/lmcoursier/definitions/Strict.scala:51:14: method productElementNames overrides nothing
[error] override def productElementNames = {
[error]              ^

Create sbt plugin

to make this easier to use we should consider adding a plugin for this that just invokes scalafix correctly.

Doesn't work with Scala 2.13 or 3

Ref #4

steps

Use Scala 3

package lmcoursier.definitions

import dataclass._

@data class Strict(
  include: Set[(String, String)] = Set(("*", "*")),
  exclude: Set[(String, String)] = Set.empty,
) {
}

problems

[error] -- [E164] Declaration Error: /Users/xxx/work/sbt-coursier/modules/lm-coursier/target/scala-3.1.3/src_managed/main/scala/lmcoursier/definitions/Strict.scala:37:4
[error] 37 |def productElementName(n: Int) = n match {
[error]    |    ^
[error]    |error overriding method productElementName in trait Product of type (n: Int): String;
[error]    |  method productElementName of type (n: Int): String needs `override` modifier
[error] -- [E164] Declaration Error: /Users/xxx/work/sbt-coursier/modules/lm-coursier/target/scala-3.1.3/src_managed/main/scala/lmcoursier/definitions/Strict.scala:51:4
[error] 51 |def productElementNames = {
[error]    |    ^
[error]    |error overriding method productElementNames in trait Product of type => Iterator[String];
[error]    |  method productElementNames of type => Iterator[String] needs `override` modifier

notes

Using Scalafix from sbt, I am guessing that the rule will always use the same version as the metabuild, in this case Scala 2.12.
I don't know if there's a way to detect that the target dialect should be Scala 3.
https://github.com/scalacenter/scalafix/blob/main/scalafix-core/src/main/scala/scalafix/v1/SemanticDocument.scala doesn't seem to contain Scala version.

Maven artifact

Thanks for working on this!
Do you mind publishing this to Maven Central?

hamnis / dataclass-scalafix Goto Github PK

dataclass-scalafix's People

Contributors

Stargazers

Watchers

Forkers

dataclass-scalafix's Issues

steps

problem

expectation

steps

problem

Minimized code

Output

Expectation

steps

problems

steps

problems

notes

Recommend Projects

Recommend Topics

Recommend Org