Skip to content

Commit

Permalink
2.14.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jfmengels committed Oct 8, 2024
1 parent 55bc0d7 commit b1700c6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## [Unreleased]

## [2.14.1] - 2024-10-08

- Fixed an issue where extracting code using `Review.Rule.withSourceCodeExtractor` would not get the correct source code when source contains Unicode characters.

## [2.14.0] - 2024-06-14
Expand Down Expand Up @@ -181,7 +183,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/compare/v2.14.0...HEAD
[Unreleased]: https://github.com/jfmengels/elm-review/compare/v2.14.1...HEAD
[2.14.1]: https://github.com/jfmengels/elm-review/releases/tag/2.14.1
[2.14.0]: https://github.com/jfmengels/elm-review/releases/tag/2.14.0
[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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.14.0/Review-Rule/) documentation for how to get started.
Check out the [`Review.Rule`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.14.1/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.
Expand Down Expand Up @@ -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.14.0/Review-Rule/#configuring-exceptions),
You can [configure exceptions](https://package.elm-lang.org/packages/jfmengels/elm-review/2.14.1/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,
Expand Down Expand Up @@ -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.14.0/Review-Rule/#withDataExtractor).
[`Rule.withDataExtractor`](https://package.elm-lang.org/packages/jfmengels/elm-review/2.14.1/Review-Rule/#withDataExtractor).

The result for a rule will be stored under `<json>.extracts.<YourRuleName>`. 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.
Expand Down
2 changes: 1 addition & 1 deletion elm.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.14.0",
"version": "2.14.1",
"exposed-modules": [
"Review.Rule",
"Review.ModuleNameLookupTable",
Expand Down

0 comments on commit b1700c6

Please sign in to comment.