Skip to content

CHANGELOG.md

Latest commit

 

History

History
328 lines (192 loc) · 16.4 KB

CHANGELOG.md

File metadata and controls

328 lines (192 loc) · 16.4 KB

Changelog

Notable changes to this project will be documented in this file.

The format is based on Keep a Changelog. This project mirrors the Elm version. So version 0.19.1-revisionX of this project will be compatible with Elm 0.19.1.

0.19.1-revision17 - 2025-11-18

Fixed

When running tests, elm-test needs to merge "dependencies" and "test-dependencies" in your elm.json. To do this, elm-test uses elm-solve-deps.

Previously, this merging step could result in ignoring the "indirect" parts of dependencies in elm.json, and getting a later (but still semver compatible) version instead. For example, you might have had "elm/virtual-dom": "1.0.4" in "indirect" in elm.json, but ended up getting 1.0.5 installed in tests.

Now, elm-test prefers the version mentioned in "indirect" if possible, so that you end up getting the same code in your source code and in tests.

See issue 652 for more details.

Thanks to Juliano Solanho for reporting and fixing!

0.19.1-revision16 - 2025-07-06

Fixed

elm-test now works with an upcoming version of the Lamdera compiler. Lamdera has a cool new optimization, that unfortunately made elm-test unable to find tests. Now that is fixed! Thanks to Leonardo Taglialegne!

0.19.1-revision15 - 2025-02-16

Fixed

This version replaces the glob dependency with tinyglobby, which is used by elm-review, and many other popular projects. This has a couple of benefits:

  • Restores the Node.js 12 support lost in 0.19.1-revision13.
  • Fixes globs that resolve to directories on Windows. Regression since 0.19.1-revision13, due to the glob upgrade. The test suite was previously missing coverage for this.
  • tinyglobby is much smaller than glob, reducing the installation size and number of indirect dependencies.

Thanks to Jeroen Engels for making the pull request fixing this, and to @lishaduck for introducing tinyglobby to elm-review and suggesting elm-test should use it too!

0.19.1-revision14 - 2025-02-15

Fixed

0.19.1-revision13 unfortunately did not work out of the box in Node.js 12–18 due to a bug in npm versions older than v10. This version is a quick-fix that restores support for Node.js 14–18, while still not causing deprecation warnings. Thanks to @lishaduck for reporting!

Unfortunately, Node.js 12 is still broken. You need to stay on 0.19.1-revision12 if you use Node.js 12.

(For those interested, the fix was changing the glob version range to ^8.0.3 to ^8.0.3 || ^9.0.0 || ^10.0.0. ^11.0.0 was removed from it due to the linked npm bug.)

0.19.1-revision13 - 2025-02-14

Fixed

  • elm-test no longer fails with an error about duplicate source directories if your elm.json contains "source-directories": ["tests"].
  • The glob dependency version has been updated from ^8.0.3 to ^8.0.3 || ^9.0.0 || ^10.0.0 || ^11.0.0. This allows npm (or your package manager of choice) to install the latest version of glob that works with your Node.js version. Versions 8 and 9 are deprecated. If you use Node.js 16 or later, this allows you to get rid of deprecation warnings.
  • The elm-solve-deps-wasm dependency version has been updated from ^1.0.2 to ^1.0.2 || ^2.0.0, which is the same version constraint that elm-review 2.13.0 uses. If you install the latest version of both elm-test and elm-review, you only get one copy of elm-solve-deps-wasm in node_modules/ instead of two, saving about 288 KB.

0.19.1-revision12 - 2023-02-16

Fixed

  • elm-test --report junit now works with elm-program-test. The junit report is XML. elm-program-test uses some characters that are not allowed in XML. This version replaces such disallowed characters with an Elm-style escape sequence, instead of crashing like it did before. Thanks to Christoph Hermann for reporting and to Ilias Van Peer for fixing!

0.19.1-revision11 - 2023-01-02

Fixed

  • elm-test init now prints a working link to the elm-explorations/test package. Thanks to Max Strübing!
  • If you ever saw RuntimeError: unreachable when trying to use elm-test, that should not be possible to happen anymore. elm-test now depends on the latest version of elm-solve-deps-wasm which solved that problem. (Previously, you had to make sure you had that version installed yourself).

0.19.1-revision10 - 2022-10-11

⚠️ Updating to this version also requires upgrading to the just released elm-explorations/test 2.0.0!

Breaking

  • This version of elm-test only works with elm-explorations/test 2.x (2.0.0 <= v < 3.0.0), which was just released. The versions table should make it clear which versions work together.

  • Removed elm-test install-unstable-test-master and elm-test uninstall-unstable-test-master. They are no longer needed since elm-explorations/test 2.0.0 has been released.

Added

  • Fuzzer distribution statistics report. Fuzzer distribution is new in elm-explorations/test 2.0.0, and it required a change in how things are reported from Elm to the test runner, which is why elm-test 0.19.1-revision10 is not compatible with older elm-explorations/test versions.

  • The --no-clear-console flag. By default, elm-test --watch clears the screen on every re-run, so you only see up-to-date output. With --no-clear-console, the console is not cleared and a separator is instead printed between the old and new output instead (similar to how elm-test-rs works). This is useful if you are running several commands in the same terminal and don’t want elm-test --watch to clear away output from other commands.

0.19.1-revision9 - 2022-07-03

Fixed

  • elm-test install-unstable-test-master (added in the previous version) now works with packages.

0.19.1-revision8 - 2022-06-20

Breaking

  • Removed support for Node.js 10 (which reached end of life 2021-04-30). Node.js 12.20.0 is now the minimum supported Node.js version. (Node.js 12 actually reached end of life 2022-04-30, but we decided to keep support for it for a while longer since there was no need of dropping it right now.)

Added

  • elm-test install-unstable-test-master
    • which installs the master version of the elm-explorations/test library in place of the 1.2.2 version in your ELM_HOME
  • elm-test uninstall-unstable-test-master
    • which undoes that

This let’s you test the upcoming major version of elm-explorations/test. Big thanks to Martin Janiczek!

Changed

  • elm-test no longer uses elm-json to calculate the set of dependencies needed to run your tests. Instead, we use elm-solve-deps-wasm which basically is a WebAssembly port of the dependency solver in elm-test-rs. Big thanks to Matthieu Pizenberg! Benefits of this change:

    • elm-test no longer needs to download the elm-json binary at install time or run time. elm-solve-deps-wasm is a regular, cross platform npm package.
    • Improves compatibility with Lamdera.
    • elm-solve-deps-wasm works offline to a greater extent than elm-json. Many times it doesn’t need to make any calls to package.elm-lang.org at all!

  • elm-test now shows suggestions on misspelled CLI flags.

Fixed

  • If you have module MyTest exposing (..) with the expose-all (..) and a char literal with a unicode escape, like '\u{000D}', in the same file, elm-test now correctly finds all tests to run in that file. A bug with unicode escape parsing previously caused no tests to be found.

0.19.1-revision7 - 2021-05-14

Fixed

  • elm-test now works if you have { "type": "module" } in your package.json.
  • --output=/dev/null is now ignored. This is needed by Emacs’ flycheck-elm package, which calls both elm make and elm-test make with --output=/dev/null. elm-test make does not produce any output files, so the flag doesn’t change anything. (Before 0.19.1-revision5, all unknown flags were silently ignored.)
  • The “no tests found” error message now works with --report=json and --report=junit again (regression in 0.19.1-revision5).
  • Better error message for --fuzz=0.

0.19.1-revision6 - 2020-01-29

Fixed

  • The --no-color and --color flags (to disable and force colors) now work again (regression in 0.19.1-revision5).
  • --no-color now turns off colors in Elm compiler error messages as well.

0.19.1-revision5 - 2020-01-28

Breaking

  • Removed support for Node.js 8 (which reached end of life 2019-12-31). Node.js 10.13.0 is now the minimum supported Node.js version.
  • Removed the undocumented --verbose flag. It didn’t do much at all in its current state.

Fixed

  • Now works on Apple Silicon/M1/ARM MacBooks. Installation used to fail with “Error: No binaries are available for your platform: darwin-arm64.”
  • You can now run your test from a subdirectory. elm-test finds your elm.json up the directory tree instead of printing an error.
  • If you had a port named send or receive and they were reached via test cases, elm-test used to fail with a duplicate port error. elm-test has renamed its internal ports so that conflicts are very unlikely.
  • The JUnit reporter now says @failures instead of @failed which makes Jenkins happier.
  • elm-test now errors on unknown (misspelled) flags instead of silently ignoring them.
  • elm-test now errors on bad --fuzz and --seed values instead of silently ignoring them.
  • A whole host of Elm package dependencies errors, by using elm-json to calculate the set of dependencies needed to run your tests.
  • elm-test --watch no longer crashes if for packages if there are compilation errors in src/ at startup.
  • elm-test --watch now detects changes in your elm.json.
  • elm-test --watch now works better when lots of files change at once. If 10 files changed, your tests used to run 10 times in sequence (more or less). Now, they only run once or twice. Changes within 100 ms are batched together. Changes happening while the tests are running no longer queue up – they instead trigger one single test once the current run is done.
  • Compilation errors are no longer hidden by a super long “Compilation failed while attempting to build [absolute paths to every single test Elm file]” message.
  • A bunch of checks and validations have been added to help in edge cases.

Performance

  • elm-test is now faster to install (by having fewer dependencies). It used to be around 18 MB, now it’s just 2 MB.
  • elm-test now runs about half a second faster, by no longer using elmi-to-json. (As a bonus, if you ever encountered errors mentioning elmi-to-json, that won’t happen anymore.)
  • elm-test --watch now reruns your tests sooner after file changes (about 100 ms after the changes, instead of about 500 ms).

Changed

  • The --help output is now more conventional and hopefully easier to read.

0.19.1-revision4 - 2020-09-21

Fixed

  • The --compiler command line flag now correctly finds elm executables on your PATH (see #438).
  • We have hugely slimmed down the reproduction instructions so that the test runner no longer prints hundreds of test file paths to the console (see issue #431 and fix #432).

Performance

  • A whole host of spring cleaning that streamlines the test runner. (see #425).

0.19.1-revision3 - 2020-01-10

Fixed

  • Pointing to specific test files sometimes failed (see issue #391 and fix #404).

0.19.1-revision2 - 2019-10-22

Performance

  • Update elmi-to-json and use --for-elm-test to optimise collection of tests (#396).

0.19.1 - 2019-12-04

Breaking

  • drop support for elm 0.19.0
  • elm-test --help now exits with code 0.

Added

0.19.0-rev6 - 2019-03-10

Fixed

  • npm audit complaints on versions of chokidar and node-elm-compiler

0.19.0-rev5 - 2019-02-22

Fixed

  • Excessive small highlights in some diffs (#263)
  • Upgraded to a version of lodash with a vulnerability fixed.

0.19.0 - 2018-08-19

Added

  • elm-test install PACKAGE - works like elm install but installs into test-dependencies

Removed

  • --add-dependencies (replaced by elm-test install)
  • CLI aliases (e.g. -f as a shorthand for --fuzz).

0.18.11 - 2017-08-07

Fixed

  • Low-contrast diff color (#229)
  • Socket write edge case (#228)
  • Invalid JUnit XML (#218)

0.18.10 - 2017-11-16

Fixed

  • Potentially fixed: elm-test hanging

0.18.8 - 2017-08-07

Added

  • Run tests in parallel (#45)

Fixed

  • --watch error reporting (#192)
  • --watch potential extra compile processes (#194)

Internal

  • More accurate timetracking
  • Use symlinks to improve generated code performance
  • Use Elm instead of Chalk for colored console output
  • Use Prettier

0.18.7 - 2017-06-30

Fixed

  • All reporters were considered "machine readable", resulting in the error stream being ignored (#161)

Added

  • We have a changelog! (#151)
  • Proper error messages when username or repository name contains dots (#166)

Internal

  • Add flow type annotations to prevent silly JS mistakes! (#162)

0.18.6 - 2017-06-12

Changed

  • Imports in the Example.elm file are now sorted for compatibility with elm-format@exp

0.18.5 - 2017-06-11

Fixed

  • --report flag broken (#155)

Added

  • If your project depends on elm-lang/html, elm-test init will add a dependency to eeue56/elm-html-test so you can test your HTML. (#154)

0.18.4 - 2017-05-30

Fixed

  • Runner no longer fails when CWD has spaces in it (#147)
  • Tests that are port modules or effect modules are no longer rejected (#143)

0.18.3 - 2017-05-25

Added

  • --add-dependencies target/elm-package.json flag to add any missing dependencies from the elm-package.json file in the current director to the target/elm-package.json file. (#28)
  • Test.todo to mark tests as not yet implemented. (#104)
  • --fuzz flag to override the default fuzz count. (#77)
  • Test.only and Test.skip to limit which tests will be executed.

Changed

  • elm-test init now adds all dependencies from the package elm-package.json to the generated tests/elm-package.json file. (#68)
  • You no longer write a tests/Main.elm file. Rather, you pass the paths to your tests to the elm-test executable to run just those files, or you run elm-test without arguments which will look for all elm files under tests/ and test/. (#72)
  • All exposed values of type Test are executed by the test-runner.
  • Duplicate titles/descriptions fail the test run. (#115)
  • Empty describes are no longer allowed. (#95)

Fixed

  • Ignores elm-stuff (#100)
  • Tests that throw a runtime exception fail with the exception message as failure, rather than crashing the runner. (#69)

Migrating from 0.18.2

  • Upgrade the runner npm i -g elm-test
  • Remove tests/Main.elm
  • Remove the dependency on rtfeldman/node-test-runner from tests/elm-package.json
  • Bump the dependency on elm-community/elm-test to 4.2.0 <= v < 5.0.0 in tests/elm-package.json
  • Ensure your test files expose each test you want to run, and that those values are of type Test
  • Make sure those tests aren't defined twice (for example: once as a top-level value, and again in a describe block) or they will be executed twice.
  • run elm-test to execute your tests.