https://github.com/endpoints4s/migrations

Automatic rewrite rules for upgrading to new releases of endpoints4s
https://github.com/endpoints4s/migrations

Last synced: about 1 month ago
JSON representation

Automatic rewrite rules for upgrading to new releases of endpoints4s

• Host: GitHub
• URL: https://github.com/endpoints4s/migrations
• Owner: endpoints4s
• Created: 2020-06-27T14:13:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-01T18:10:37.000Z (over 4 years ago)
• Last Synced: 2024-11-06T19:27:12.140Z (about 2 months ago)
• Language: Scala
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Automatic rewrite rules for upgrading to new releases of endpoints4s 

## Migrating from 0.15.0 to 1.0.0

Add the scalafix plugin to your build definition. For sbt:

~~~ scala

// project/plugins.sbt

addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.17")

~~~

Start the sbt shell and run the following commands:

~~~

// sbt shell

scalafixEnable

scalafix dependency:[email protected]:to-1-0-0:1.0.0 --files .

~~~

The rule applies the following changes:

- rename references to package `endpoints` to `endpoints4s`,

- update imports of `endpoints.algebra.Codec` to `endpoints4s.Codec`,

- rewrite constructor calls of `EndpointDocs` and `CallbackDocs` to

  avoid deprecations,

- bump version number in build dependencies from `0.15.0` to `1.0.0`,

- update modules organization from `org.julienrf` to `org.endpoints4s`,

- update artifact names to remove the `endpoints-` prefix.

Note that the rules sometimes overlap or might be incomplete. You will

probably have to do some manual edits.

## Contributing

To develop rule:

```

sbt ~to-1_0_0-tests/test

# edit to-1.0.0/rules/src/main/scala/fix/To_1_0_0.scala

```