ember-cli / ember-cli/ember-exam

usage of the --path option (and other valid ember test options) needs clarification

Open
#641 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
289
Forks
65
Avg merge
4m
Merged PRs (30d)
9

Description

when I read the docs I thought that --path option is only valid with the `exam:iterate` command.
https://github.com/ember-cli/ember-exam#randomization-iterator

It was not easy for me to understand that `--path` is also valid with the `exam` command also. The readme has the below quote regarding the ember test inheritance.
> Using Ember Exam is fairly straightforward as it extends directly from the default Ember-CLI test command. So, by default, it will work exactly the same as ember test.

After running `yarn run ember exam --help`, valid options were more clear to me. But seeing the path option only for the `exam:iterate` mislead me initially. I believe that explicitly stating that all the other `ember test` options are also valid for `ember exam` on the docs site and/or README could be beneficial. When I visit the docs site and see the options section, I immediately think that these are the only valid CLI options, there is nothing more.
https://ember-cli.github.io/ember-exam/docs/randomization

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.