Prepare version 1.0.0 of elm-test-rs (#82)

* Update version to 1.0.0

* Document the dependencies in Cargo.toml

* Deactivate cache clearing in hope that new PR is OK

* Clear ubuntu tests cache

* Update elm-tooling-action

* Update CI triggers with pushes to master

* Add Windows specific fixes to changelog

* Update readme

* Add a failing example with Debug.log

* Readme fix

* Bump elm to version 4.0.4

* Update copyright date to 2021

* Add license to Cargo.toml

* Update changelog with v1.0

.github/workflows/ci.yml

@@ -1,6 +1,9 @@
 name: CI
 
-on: [pull_request]
+on:
+  pull_request:
+  push:
+    branches: [ master, main ]
 
 jobs:
   build:
@@ -88,16 +91,14 @@ jobs:
         with:
           submodules: recursive
 
-      - uses: mpizenberg/elm-tooling-action@b6665b9d55111b51d09574b4338883ab572d100f
+      - uses: mpizenberg/elm-tooling-action@746bbdcd1ed901364e4c8380058da4c22ebfbb92
         with:
-          cache-key: elm-home-${{ matrix.os }}
-          elm: '0.19.1'
-          # elm-format: '0.8.5'
-          # elm-json: '0.2.10'
+          cache-key: elm-home-${{ matrix.os }}-0
+          cache-restore-key: elm-home-${{ matrix.os }}
+          elm-tooling-dir: tests
 
-      - name: Temporary clear windows elm cache
-        if: ${{ startsWith(matrix.os, 'windows') }}
-        run: rm -rf $ELM_HOME/0.19.1
+      - name: Clear elm-test-runner package in cache
+        run: rm -rf $ELM_HOME/0.19.1/packages/mpizenberg/elm-test-runner
         shell: bash
 
       - uses: actions-rs/toolchain@v1

CHANGELOG.md

@@ -7,6 +7,17 @@ All notable changes to this project will be documented in this file.
 
 #### Added
 
+#### Changed
+
+#### Removed
+
+#### Fixed
+
+
+## [1.0.0] - (2021-02-27) [(diff)][diff-1.0.0]
+
+#### Added
+
 - New `--project` CLI option to be able to pass as argument the path to the root
   of the elm project, containing the `elm.json`.
 - The globs CLI arguments and resulting found tests modules paths
@@ -15,20 +26,21 @@ All notable changes to this project will be documented in this file.
 - New `--dependencies [newest|oldest]` argument.
 - New `make` subcommand that stops after compilation of the tests modules.
 - New `--elm-home` argument also able to pick up the env variable `ELM_HOME`.
+- New multiple verbosity flag `-v` to replace the previous `--quiet` flag.
+  Level 0 (default) has mostly quiet stderr, level 3 `-vvv` add debug info,
+  and levels in between add more and more info.
 
 #### Changed
 
 - Http timeouts are increased from 1s to 10s.
 - Updated the Elm submodule for the test runner.
 - Changed the CLI crate from pico_args to clap.
-- Replace the `--quiet` flag by a multiple verbosity one `-v`.
-  Level 0 (default) hast mostly quiet stderr, level 3 `-vvv` add debug info,
-  and levels in between add more and more info.
 
 #### Removed
 
 - The `--connectivity` argument is no more.
   Replaced by a combination of `--offline` and `--dependencies <strategy>`.
+- The `--quiet` flag, replaced by verbosity `-vvv`.
 
 #### Fixed
 
@@ -41,6 +53,8 @@ All notable changes to this project will be documented in this file.
 - Add a message to stderr and fail when no test was found.
 - Validate that `--fuzz` is >= 1.
 - Fix race condition in `--watch` mode preventing a re-run if files change while running tests.
+- Fix Windows paths issues due to UNC paths.
+- Fix elm command for Windows when installed via npm.
 
 
 ## [0.6.1] - (2021-01-23) [(diff)][diff-0.6.1]
@@ -181,6 +195,7 @@ All notable changes to this project will be documented in this file.
 - `.gitmodules` git submodules.
 - `.github/workflows/` CI to automatically build and test on pull requests.
 
+[1.0.0]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v1.0
 [0.6.1]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v0.6.1
 [0.6.0]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v0.6
 [0.5.1]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v0.5.1
@@ -191,7 +206,8 @@ All notable changes to this project will be documented in this file.
 [0.2.0]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v0.2
 [0.1.1]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v0.1.1
 [0.1.0]: https://github.com/mpizenberg/elm-test-rs/releases/tag/v0.1
-[diff-unreleased]: https://github.com/mpizenberg/elm-test-rs/compare/v0.6.1...master
+[diff-unreleased]: https://github.com/mpizenberg/elm-test-rs/compare/v1.0...master
+[diff-1.0.0]: https://github.com/mpizenberg/elm-test-rs/compare/v0.6.1...v1.0
 [diff-0.6.1]: https://github.com/mpizenberg/elm-test-rs/compare/v0.6...v0.6.1
 [diff-0.6.0]: https://github.com/mpizenberg/elm-test-rs/compare/v0.5.1...v0.6
 [diff-0.5.1]: https://github.com/mpizenberg/elm-test-rs/compare/v0.5...v0.5.1

Cargo.toml

@@ -1,30 +1,31 @@
 [package]
 name = "elm-test-rs"
-version = "1.0.0-beta"
+version = "1.0.0"
 authors = ["Matthieu Pizenberg <[email protected]>", "Harry Sarson <[email protected]>"]
 edition = "2018"
 description = "Simple and fast Rust alternative to node-test-runner to run elm tests"
+license = "BSD-3-Clause"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-glob = "0.3.0"
-pathdiff = "0.2.0"
-num_cpus = "1.13.0"
-regex = "1.4.3"
+glob = "0.3.0" # to interpret CLI glob patterns
+pathdiff = "0.2.0" # to compute a path relative to another path
+num_cpus = "1.13.0" # to get the number of logic cores
+regex = "1.4.3" # to path the elm kernel code
+pubgrub = { version = "0.2", features = ["serde"] } # for dependency solving
 # pubgrub-dependency-provider-elm = { path = "../pubgrub-dependency-provider-elm" }
 pubgrub-dependency-provider-elm = { git = "https://github.com/mpizenberg/pubgrub-dependency-provider-elm", branch = "master" }
-serde_json = "1.0.61"
-ureq = "2.0.1"
-dirs-next = "2.0.0"
-pubgrub = { version = "0.2", features = ["serde"] }
-nom = "6.1.0"
-notify = "4.0.15"
-atty = "0.2.14"
-anyhow = "1.0.38"
-clap = { version = "2.33.3", default-features = false }
+serde_json = "1.0.61" # for JSON serialization
 serde = { version = "1.0.123", default-features = false }
-log = { version = "0.4.14", default-features = false }
+ureq = "2.0.1" # for https requests to the package website
+dirs-next = "2.0.0" # to handle ELM_HOME
+nom = "6.1.0" # to parse the tests files and extract potential tests
+notify = "4.0.15" # for --watch mode
+atty = "0.2.14" # to handle color correctly in pipes
+anyhow = "1.0.38" # for error handling
+clap = { version = "2.33.3", default-features = false } # for CLI argument parsing
+log = { version = "0.4.14", default-features = false } # for debug logs with -vvv
 stderrlog = { version = "0.5.1", default-features = false }
 walkdir = "2.3.1" # to find all elm files in a given directory
 either = { version = "1.6.1", default-features = false } # for iterators on two branches

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2020, Matthieu Pizenberg
+Copyright (c) 2021, Matthieu Pizenberg
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without