Configuration lies in the
review/ directory. There is an
elm.json which lists the dependencies containing review rules we wish to use. It also contains a
ReviewConfig.elm file, in which we explicitly choose the rules we want to enable.
There are two custom rules in this project:
NoDefiningColorsOutsideOfUiColor: This rule prevents defining colors (using
Css.hex) outside of the
Ui.Colormodule, which is the central location where we define colors in the application.
NoUsingHtmlButton: This rule prevents users from using
Html.Styled.button, because we already have a great module to create buttons with the
Both rules are found in the
review/ directory. You can find their corresponding tests in
You can run the review by running
npm run review, which will run
elm-review .. This means it will run
elm-review on all the Elm files in the project.
You can also run the fix mode by running
npm run review:fix, which will run in effect run
elm-review . --fix.
In a CI environment
You can see what
elm-review looks like when run in a CI like Travis here. (NOTE: I am currently experiencing a problem with tests running into invalid dependencies, preventing the display of review problems. I would really appreciate some help with this!)