Update README and CHANGELOG with recent changes

Attempt to clarify confusion around 
https://github.com/icy-arctic-fox/spectator/issues/22
This commit is contained in:
Michael Miller 2021-08-19 13:35:15 -06:00
parent 2f6ef4b578
commit 5d90a99d8e
No known key found for this signature in database
GPG key ID: FB9F12F7C646A4AD
2 changed files with 13 additions and 10 deletions

View file

@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add `filter_run_including`, `filter_run_excluding`, and `filter_run_when_matching` to config block. - Add `filter_run_including`, `filter_run_excluding`, and `filter_run_when_matching` to config block.
- By default, only run tests when any are marked with `focus: true`. - By default, only run tests when any are marked with `focus: true`.
- Add "f-prefix" blocks for examples and groups (`fit`, `fdescribe`, etc.) as a short-hand for specifying `focus: true`. - Add "f-prefix" blocks for examples and groups (`fit`, `fdescribe`, etc.) as a short-hand for specifying `focus: true`.
- Add HTML formatter. Operates the same as the JUnit formatter. Specify `--html_output=DIR` to use. [#22](https://gitlab.com/arctic-fox/spectator/-/issues/22) [#3](https://github.com/icy-arctic-fox/spectator/issues/3)
### Changed ### Changed
- `given` (now `provided`) blocks changed to produce a single example. `it` can no longer be nested in a `provided` block. - `given` (now `provided`) blocks changed to produce a single example. `it` can no longer be nested in a `provided` block.

View file

@ -277,13 +277,14 @@ For details on mocks and doubles, see the [wiki](https://gitlab.com/arctic-fox/s
Spectator matches Crystal's default Spec output with some minor changes. Spectator matches Crystal's default Spec output with some minor changes.
JUnit and TAP are also supported output formats. JUnit and TAP are also supported output formats.
There is also a highly detailed JSON output. There are also highly detailed JSON and HTML outputs.
Development Development
----------- -----------
This shard is still under development and is not recommended for production use (same as Crystal). This shard is still in active development.
However, feel free to play around with it and use it for non-critical projects. New features are being added and existing functionality improved.
Spectator is well-tested, but may have some yet-to-be-found bugs.
### Feature Progress ### Feature Progress
@ -344,20 +345,20 @@ Items not marked as completed may have partial implementations.
- [ ] Message ordering - `expect().to receive().ordered` - [ ] Message ordering - `expect().to receive().ordered`
- [X] Null doubles - [X] Null doubles
- [X] Verifying doubles - [X] Verifying doubles
- [ ] Runner - [X] Runner
- [X] Fail fast - [X] Fail fast
- [ ] Test filtering - by name, context, and tags - [X] Test filtering - by name, context, and tags
- [X] Fail on no tests - [X] Fail on no tests
- [X] Randomize test order - [X] Randomize test order
- [X] Dry run - for validation and checking formatted output - [X] Dry run - for validation and checking formatted output
- [X] Config block in `spec_helper.cr` - [X] Config block in `spec_helper.cr`
- [X] Config file - `.spectator` - [X] Config file - `.spectator`
- [ ] Reporter and formatting - [X] Reporter and formatting
- [X] RSpec/Crystal Spec default - [X] RSpec/Crystal Spec default
- [X] JSON - [X] JSON
- [X] JUnit - [X] JUnit
- [X] TAP - [X] TAP
- [ ] HTML - [X] HTML
### How it Works (in a nutshell) ### How it Works (in a nutshell)
@ -383,9 +384,10 @@ The CI build checks for properly formatted code.
Documentation is automatically generated and published to GitLab pages. Documentation is automatically generated and published to GitLab pages.
It can be found here: https://arctic-fox.gitlab.io/spectator It can be found here: https://arctic-fox.gitlab.io/spectator
This project is developed on [GitLab](https://gitlab.com/arctic-fox/spectator), This project's home is (and primarily developed) on [GitLab](https://gitlab.com/arctic-fox/spectator).
and mirrored to [GitHub](https://github.com/icy-arctic-fox/spectator). A mirror is maintained to [GitHub](https://github.com/icy-arctic-fox/spectator).
Issues and PRs/MRs are accepted on both. Issues, pull requests (merge requests), and discussion are welcome on both.
Maintainers will ensure your contributions make it in.
### Testing ### Testing