Skip to content

Latest commit

 

History

History
130 lines (92 loc) · 5.17 KB

README.md

File metadata and controls

130 lines (92 loc) · 5.17 KB
Raw

elm-review-codeinstaller

NOTE: This version is a breaking change from version 12.05. The visible part is an improved set of rule names. Please see the documentation, both below and for the A package designed to make it easy to add pieces of code to an existing codebase using elm-review rules. This package provides a set of tools to help you automatically insert clauses in case expressions, fields in type aliases, fields in initializer functions, and variants in custom types.

The project is still in development, so expect it to change a lot over the next weeks and likely months. For now, consider it to be an experiment.

Installation

To install elm-review-codeinstaller, add it to your elm.json dependencies:

elm install jxxcarlson/elm-review-codeinstaller

Usage

Suppose you have the following Msg type and update function in your Counter module:

module Counter exposing (..)

type Msg
    = Increment
    | Decrement

update : Msg -> Model -> ( Model, Cmd Msg )
update msg model =
    case msg of
        Increment ->
            ( { model | counter = model.counter + 1 }, Cmd.none)

        Decrement ->
            ( { model | counter = model.counter - 1 }, Cmd.none)

To add a new ResetCounter variant to the Msg type and handle it in the update function, your ReviewConfig.elm file would look like the following:

module ReviewConfig exposing (config)

import Install.ClauseInCase
import Install.ElementToList
import Install.TypeVariant
import Review.Rule exposing (Rule)

config : List Rule
config =
    addResetCounter ++
    [ -- other rules
    ]

addResetCounter : List Rule
addResetCounter =
    [ addResetCounterVariant
    , addResetCounterClause
    ]

addResetCounterVariant : Rule
addResetCounterVariant =
    Install.TypeVariant.makeRule "Counter" "Msg" "ResetCounter"

addResetCounterClause : Rule
addResetCounterClause =
    Install.ClauseInCase.config "Counter" "update" "ResetCounter" "( { model | counter = 0 }, Cmd.none )"
        |> Install.ClauseInCase.makeRule

After running elm-review --fix, your Counter module will be updated as follows:

module Counter exposing (..)

type Msg
    = Increment
    | Decrement
    | ResetCounter

update : Msg -> Model -> ( Model, Cmd Msg )
update msg model =
    case msg of
        Increment ->
            ( { model | counter = model.counter + 1 }, Cmd.none )

        Decrement ->
            ( { model | counter = model.counter - 1 },  Cmd.none )

        ResetCounter ->
            ( { model | counter = 0 }, Cmd.none )

Modules

elm-review-codeinstaller includes the following modules:

  • Install.ClauseInCase: Add a clause to a case expression in a specified function within a specified module. For more details, see the docs.
  • Install.FieldInTypeAlias: Add a field to a specified type alias in a specified module. For more details, see the docs.
  • Install.Initializer: Add a field to the body of an initializer function where the return value is of the form ( Model, Cmd msg ). For more details, see the docs.
  • Install.TypeVariant: Add a variant to a specified type in a specified module. For more details, see the docs.
  • Install.Function.ReplaceFunction: Replace a function in a given module with a new implementation. For more details, see the docs.
  • Install.Function.InsertFunction: Add a function in a given module if it is not present. For more details, see the docs.
  • Install.Import: Add import statements to a given module. For more details, see the docs.
  • Install.ElementToList: Add an element to a list in a specified function within a specified module. For more details, see the docs.

Try it out

To test the review code in its current state, try running this in a clean Lamdera project:

npx elm-review --template jxxcarlson/elm-review-codeinstaller/example

For this to succeed, your Lamdera project must have a notion of "page," as in the counter app that you will find in the folder counter-original of the repo for this project. Try copying that folder.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.

Contributors

James Carlson and Mateus Leite. We also thank Jeroen Engels for his contributions to making our API much better.

License

This package is licensed under the MIT License.