Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Move fast and fix things

Move fast and fix things

An introduction to Scalafix, presented at Scala Exchange 2017

Gabriele Petronella

December 14, 2017
Tweet

More Decks by Gabriele Petronella

Other Decks in Programming

Transcript

  1. Move fast and
    BREAK FIX
    things

    View Slide

  2. ME, HI!

    View Slide

  3. STUFF I DO (BY DAY)

    View Slide

  4. STUFF I DO (BY NIGHT)
    Scala and JS open-source

    View Slide

  5. AGENDA
    1. Intro and context
    2. ASTs and related workflows
    3. Scalameta
    4. Scalafix
    5. Live examples

    View Slide

  6. WHAT IS SCALAFIX
    Scalafix is a rewrite and linting tool for Scala
    — scalacenter.github.io/scalafix

    View Slide

  7. EXAMPLE 1 - NOPROCEDURESYNTAX
    // before
    def main(args: Seq[String]) {
    println("Hello world!")
    }
    // after
    def main(args: Seq[String]): Unit = {
    println("Hello world!")
    }

    View Slide

  8. EXAMPLE 2 - NOAUTOTUPLING
    // before
    def someMethod(t: (Int, String)) = ???
    someMethod(1, "something")
    // after
    def someMethod(t: (Int, String)) = ???
    someMethod((1, "something"))

    View Slide

  9. EXAMPLE 3 - REMOVECARTESIANBUILDER
    // before
    import cats.syntax.cartesian._
    val o1: Option[Int] = Some(42)
    val o2: Option[String] = Some("hello")
    o1 |@| o2 map (_ + _)
    // after
    import cats.syntax.apply._
    val o1: Option[Int] = Some(42)
    val o2: Option[String] = Some("hello")
    (o1, o2).mapN(_ + _)

    View Slide

  10. EXAMPLE 4 - NOINFER
    val myList = List(Some(42), Right("foo"))
    // ^
    // |__

    Product with Serializable

    View Slide

  11. LET'S TALK ABOUT
    MAINTAINERS

    View Slide

  12. PURE EVIL
    BREAK CODE WITHOUT
    DOCUMENTING WHAT
    BROKE

    View Slide

  13. MILD EVIL
    BREAK CODE
    DOCUMENTING WHAT
    BROKE
    (OR LINKING TO A SUPER-LONG ISSUE)

    View Slide

  14. GOOD EFFORT
    BREAK CODE AND
    DOCUMENT HOW TO FIX IT

    View Slide

  15. YOU ROCK!
    BREAK CODE AFTER A
    DEPRECATION CYCLE AND
    EXPLAIN HOW TO FIX IT

    View Slide

  16. SUPERHERO
    BREAK CODE AFTER A
    DEPRECATION CYCLE AND
    PROVIDE AN AUTOMATIC
    REWRITE

    View Slide

  17. SCI-FI?

    View Slide

  18. MEANWHILE IN SWIFT

    View Slide

  19. MEANWHILE IN
    JAVASCRIPT

    View Slide

  20. MEANWHILE IN JAVASCRIPT
    3 paragraphs later

    View Slide

  21. The JS tooling landscape is living in the
    future
    — Ólafur Páll Geirsson, author of Scalafix

    View Slide

  22. IT'S TIME WE JUMP INTO THE
    FUTURE

    View Slide

  23. HOW?
    LET'S TAKE A STEP BACK

    View Slide

  24. A WORD ABOUT
    ASTS

    View Slide

  25. ABSTRACT
    SYNTAX
    TREE

    View Slide

  26. WHY ABSTRACT?

    View Slide

  27. val answer = 42;
    val answer = 42
    val answer =
    42
    val
    answer
    =
    42

    View Slide

  28. ASTS...
    WHY SHOULD I
    CARE?

    View Slide

  29. AST WORKFLOW 1: SCALAC

    View Slide

  30. AST WORKFLOW 2: MACROS

    View Slide

  31. AST WORKFLOW 3: SCALAFMT

    View Slide

  32. AST WORKFLOW 4: SCALAFIX

    View Slide

  33. AST WORKFLOW 4: SCALAFIX
    Woops, copy-paste?

    View Slide

  34. WHAT SCALAFIX COULD DO:
    // before
    def someMethod(string: String) { // I like trees
    println(string.trim.split("/").lastOption)
    }
    // after
    def someMethod(string: String): Unit =
    println(
    string
    .trim
    .split("/")
    .lastOption
    )

    View Slide

  35. View Slide

  36. WHAT SCALAFIX DOES INSTEAD:
    // before
    def someMethod(string: String) { // I like trees
    println(string.trim.split("/").lastOption)
    }
    // after
    def someMethod(string: String): Unit = { // I like trees
    println(string.trim.split("/").lastOption)
    }

    View Slide

  37. "AST" WORKFLOW 4: SCALAFIX

    View Slide

  38. OK, LET'S DO
    THIS!

    View Slide

  39. View Slide

  40. Introducing
    SCALAMETA

    View Slide

  41. Scalameta is a modern
    metaprogramming library for Scala
    — scalameta.org

    View Slide

  42. METAPROGRAMMING?

    View Slide

  43. METAPROGRAMMING DEVTOOLS!
    ▸ code formatting
    ▸ code fixing
    ▸ code browsing
    ▸ and many more applications!

    View Slide

  44. SCALAMETA VADEMECUM
    ▸ Trees
    ▸ Tokens
    ▸ Parser
    ▸ Tree manipulation primitives
    ▸ Semantic API
    ▸ (pretty-printer)

    View Slide

  45. SEMANTIC INFORMATION
    List(1, 2, 3)
    // Symbol
    _root_.scala.collection.immutable.List.
    // Denotation
    final object List
    // Synthetic
    [2..7): apply => _root_.scala.collection.immutable.List.apply
    (Lscala/collection/Seq;)

    View Slide

  46. View Slide

  47. SCALAFIX
    FINALLY!

    View Slide

  48. Rule

    View Slide

  49. Rule
    A rule can be:
    ▸ checked
    ▸ fixed

    View Slide

  50. Patch

    View Slide

  51. Patch
    A Scalafix Patch is a patch in the diff sense of patch.
    It boils down to a list of -/+ to apply to the source code.

    View Slide

  52. RuleCtx

    View Slide

  53. RuleCtx
    The toolbox for writing rules.
    It provides the API for producing patches.

    View Slide

  54. SemanticdbIndex

    View Slide

  55. SemanticdbIndex
    A index for looking up data in a scalameta's Semantic Database.
    It contains all the available semantic information.

    View Slide

  56. View Slide

  57. LIVE

    View Slide

  58. WHAT'S NEXT?

    View Slide

  59. MOAR LINTING!

    View Slide

  60. EDITOR SUPPORT

    View Slide

  61. DEMO

    View Slide

  62. View Slide

  63. Questions?
    @gabro27
    @buildoHQ
    @ScalaItaly

    View Slide