https://github.com/lue-bird/elm-review-upgrade

tell me how to get rid of outdated stuff
https://github.com/lue-bird/elm-review-upgrade

elm elm-review migration upgrade version-upgrade

Last synced: 6 days ago
JSON representation

tell me how to get rid of outdated stuff

• Host: GitHub
• URL: https://github.com/lue-bird/elm-review-upgrade
• Owner: lue-bird
• License: mit
• Created: 2024-02-02T04:37:31.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-02-27T16:48:28.000Z (11 months ago)
• Last Synced: 2025-01-12T11:52:19.176Z (15 days ago)
• Topics: elm, elm-review, migration, upgrade, version-upgrade
• Language: Elm
• Homepage: https://dark.elm.dmy.fr/packages/lue-bird/elm-review-upgrade/latest/
• Size: 268 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# elm-review-upgrade

[🔧 `Upgrade`](https://package.elm-lang.org/packages/lue-bird/elm-review-upgrade/1.0.1/Upgrade/ "Provides automatic fixes") reports functions and types that can be upgraded to give users an easy time migrating to a new version of a package or an internal elm API.

What this rule is not for: _simplifying_ your code to use new functions and types,

like replacing `YourString.join ""` by your new `YourString.concat`.

```elm

import Review.Rule

import Upgrade

import Elm.CodeGen -- the-sett/elm-syntax-dsl

config : List Review.Rule.Rule

config =

    [ Upgrade.rule

        [ Upgrade.reference { old = ( "Fuzz", "tuple" ), new = ( "Fuzz", "pair" ) }

        , Upgrade.application

            { oldName = ( "Expect", "true" )

            , oldArgumentNames = [ "onFalseDescription", "actualBool" ]

            , oldArgumentsToNew =

                \oldArguments ->

                    case oldArguments of

                        [ onFalse, actual ] ->

                            Upgrade.call ( "Expect", "equal" )

                                [ Elm.CodeGen.fqVal [ "Basics" ] "True", actual ]

                                |> Upgrade.pipeInto ( "Expect", "onFail" ) [ onFalse ]

                                |> Just

                        

                        _ ->

                            Nothing

            }

        ]

    ]

```

(full examples of [test 1→2](https://github.com/lue-bird/elm-review-upgrade/blob/main/example/elmcraft-core-extra-1-to-2) and [elmcraft/core-extra 1→2](https://github.com/elmcraft/core-extra/tree/master/upgrade))

Writing custom elm-review rules for every version upgrade yourself will get tricky.

A few examples:

- Is the function curried or part of a composition or pipeline? If it is, do transformations like reversing the argument order still work?

- How do we unify your replacement code with our import aliases and exposings and shadowed exposings? Do we need new imports?

- When changing the argument order, should we keep the formatting of the arguments?

- How do you ensure that the fix indentation doesn't interfere with previous `let` declarations, `if` branches or cases?

This rule has your back in cases like these :)

## not currently supported

- upgrading variants in any way is not supported because that's usually more involved, transforming patterns and stuff

- anything that involves more context than just the old function/type and its arguments to upgrade (e.g. when a function returns a new field and we'd need to adjust type annotations)

- 👀 something else you'd like to see?