From 91f92d4291334a343e2509395c4dc246f9630d48 Mon Sep 17 00:00:00 2001 From: Jeroen Engels Date: Sat, 20 Jun 2020 17:52:17 +0200 Subject: [PATCH] v2.2.0 --- README.md | 8 ++++---- elm.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 50c7d3b4..f05efe91 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ `elm-review` analyzes [Elm](https://elm-lang.org/) projects, to help find mistakes before your users find them. -[![elm-review reporter output](https://github.com/jfmengels/elm-review/blob/2.0.1/documentation/images/elm-review-report.png?raw=true)](https://github.com/jfmengels/elm-review/blob/2.0.1/documentation/images/elm-review-report-hq.png?raw=true) +[![elm-review reporter output](https://github.com/jfmengels/elm-review/blob/2.2.0/documentation/images/elm-review-report.png?raw=true)](https://github.com/jfmengels/elm-review/blob/2.0.1/documentation/images/elm-review-report-hq.png?raw=true) ## What does `elm-review` do? @@ -75,7 +75,7 @@ Before you start adding rules though, I suggest reading the rest of this documen ## Write your own rule You can write your own rule using this package's API and [`elm-syntax`](https://package.elm-lang.org/packages/stil4m/elm-syntax/7.1.0/). -Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.1.1/Review-Rule) documentation for how to get started. +Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.2.0/Review-Rule) documentation for how to get started. Here's an example of a rule that prevents a typo in a string that was made too often at your company. @@ -124,8 +124,8 @@ Then add the rule in your configuration: ```elm module ReviewConfig exposing (config) -import Review.Rule exposing (Rule) import NoStringWithMisspelledCompanyName +import Review.Rule exposing (Rule) config : List Rule @@ -174,7 +174,7 @@ When wondering whether to enable a rule, I suggest using this checklist: ## Is there a way to ignore an error or disable a rule only in some locations? -You can prevent errors from being reported by either changing the implementation of your rules or by [configuring exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.1.1/Review-Rule#configuring-exceptions) for directories or for files. +You can prevent errors from being reported by either changing the implementation of your rules or by [configuring exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.2.0/Review-Rule#configuring-exceptions) for directories or for files. It is however not possible to ignore errors on a case-by-case basis, for several reasons: diff --git a/elm.json b/elm.json index 50fb0490..fa8fca05 100644 --- a/elm.json +++ b/elm.json @@ -3,7 +3,7 @@ "name": "jfmengels/elm-review", "summary": "Analyzes Elm projects, to help find mistakes before your users find them.", "license": "BSD-3-Clause", - "version": "2.1.1", + "version": "2.2.0", "exposed-modules": [ "Review.Rule", "Review.Project",