diff --git a/CHANGELOG.md b/CHANGELOG.md index 58753929..c95e0366 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ## [2.13.2] - 2024-04-09 -Fixed an issue where the result of a module name lookup for let variables was sometimes incorrect. +Fixed an issue where the result of a module name lookup for let variables was sometimes incorrect. [#171](https://github.com/jfmengels/elm-review/pull/171) ## [2.13.1] - 2023-06-17 @@ -169,7 +169,8 @@ Help would be appreciated to fill the blanks! [`Review.Rule.errorFixFailure`]: https://package.elm-lang.org/packages/jfmengels/elm-review/latest/Review-Rule#errorFixFailure [`Review.Test.ignoredFilesImpactResults`]: https://package.elm-lang.org/packages/jfmengels/elm-review/latest/Review-Rule-Test#ignoredFilesImpactResults -[Unreleased]: https://github.com/jfmengels/elm-review-unused/compare/v2.13.1...HEAD +[Unreleased]: https://github.com/jfmengels/elm-review-unused/compare/v2.13.2...HEAD +[2.13.2]: https://github.com/jfmengels/elm-review/releases/tag/2.13.2 [2.13.1]: https://github.com/jfmengels/elm-review/releases/tag/2.13.1 [2.13.0]: https://github.com/jfmengels/elm-review/releases/tag/2.13.0 [2.12.2]: https://github.com/jfmengels/elm-review/releases/tag/2.12.2 diff --git a/README.md b/README.md index 42fec800..0b1658e6 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Before you start adding rules or an unfamiliar existing configuration, I suggest ## 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.2.1/). -Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.13.1/Review-Rule/) documentation for how to get started. +Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.13.2/Review-Rule/) documentation for how to get started. **NOTE**: If you want to **create a package** containing `elm-review` rules, I highly recommend using the [CLI's](https://github.com/jfmengels/node-elm-review/) `elm-review new-package` subcommand. This will create a new package that will help you use the best practices and give you helpful tools like easy auto-publishing. More information is available in the maintenance file generated along with it. @@ -236,7 +236,7 @@ It does provide 2 systems that I think are better alternatives for the health of ### Configuring exceptions -You can [configure exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.13.1/Review-Rule/#configuring-exceptions), +You can [configure exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.13.2/Review-Rule/#configuring-exceptions), which consists of marking specific directories or files as not relevant to a rule or set of rules, preventing errors to be reported for those. It is a good fit if you wish for `elm-review` to not report errors in vendored or generated code, @@ -282,7 +282,7 @@ the codebase. You can use this to gain insight into your codebase, or provide in powerful integrations. To make use of this feature, run `elm-review --extract --report=json` with a configuration containing a rule that uses -[`Rule.withDataExtractor`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.13.1/Review-Rule/#withDataExtractor). +[`Rule.withDataExtractor`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.13.2/Review-Rule/#withDataExtractor). The result for a rule will be stored under `.extracts.`. To access it, you can then pipe the result into either a `Node.js` script, a tool that expects JSON, or [`jq`](https://stedolan.github.io/jq/) as in the example below. diff --git a/elm.json b/elm.json index f8a666ef..8587d1d2 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.13.1", + "version": "2.13.2", "exposed-modules": [ "Review.Rule", "Review.ModuleNameLookupTable",