Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add examples and epilogue to cli commands #4587

Merged
merged 17 commits into from Oct 10, 2019

Conversation

@christian-bromann
Copy link
Member

commented Oct 8, 2019

Proposed changes

Additional information to the CLI command interface.

  • wdio --help (before/after)

Screen Shot 2019-10-08 at 11 14 46 AM
Screen Shot 2019-10-08 at 11 35 59 AM

  • wdio config --help (before/after)

Screen Shot 2019-10-08 at 11 16 35 AM
Screen Shot 2019-10-08 at 11 16 49 AM

  • wdio install --help (before/after)

Screen Shot 2019-10-08 at 11 17 32 AM
Screen Shot 2019-10-08 at 11 17 47 AM

  • wdio repl --help (before/after)

Screen Shot 2019-10-08 at 11 18 32 AM
Screen Shot 2019-10-08 at 11 18 45 AM

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Tests will be added by @baruchvlz

Reviewers: @webdriverio/project-committers

@codecov

This comment has been minimized.

Copy link

commented Oct 8, 2019

Codecov Report

Merging #4587 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4587      +/-   ##
==========================================
+ Coverage   99.32%   99.33%   +<.01%     
==========================================
  Files         193      195       +2     
  Lines        5038     5087      +49     
  Branches     1082     1090       +8     
==========================================
+ Hits         5004     5053      +49     
  Misses         31       31              
  Partials        3        3
Impacted Files Coverage Δ
packages/webdriver/src/constants.js 100% <ø> (ø) ⬆️
packages/wdio-cli/src/constants.js 100% <100%> (ø)
packages/wdio-cli/src/commands/install.js 100% <100%> (ø) ⬆️
packages/wdio-cli/src/index.js 100% <100%> (ø)
packages/wdio-utils/src/utils.js 100% <100%> (ø) ⬆️
packages/wdio-cli/src/commands/config.js 100% <100%> (ø) ⬆️
packages/wdio-cli/src/commands/run.js 100% <100%> (ø) ⬆️
packages/wdio-cli/src/commands/repl.js 100% <100%> (ø) ⬆️
packages/wdio-cli/src/utils.js 100% <100%> (ø) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4d34ab6...b59798b. Read the comment docs.

@christian-bromann christian-bromann requested a review from mgrybyk Oct 8, 2019
@christian-bromann christian-bromann referenced this pull request Oct 8, 2019
4 of 7 tasks complete
Copy link
Member

left a comment

LGTM 👍

Are you going to add tests?

@christian-bromann

This comment has been minimized.

Copy link
Member Author

commented Oct 8, 2019

Are you going to add tests?

Yes, it will be happen as part of #4570

@mgrybyk

This comment has been minimized.

Copy link
Member

commented Oct 8, 2019

got it, let's wait for the tests then otherwise build will start failing

Jest: "global" coverage threshold for statements (99%) not met: 98.55%
Jest: "global" coverage threshold for lines (99%) not met: 98.66%
Jest: "global" coverage threshold for functions (99%) not met: 96.88%
@mgrybyk

This comment has been minimized.

Copy link
Member

commented Oct 9, 2019

Is it expected to have Not enough non-option arguments: got 0, need at least 1 in the end instead of epilogue when running ./node_modules/.bin/wdio run?
image

I don't mind, just want to make sure it works as expected.

@christian-bromann

This comment has been minimized.

Copy link
Member Author

commented Oct 9, 2019

I don't mind, just want to make sure it works as expected.

What did you executed?

I am currently running manual tests to check functionality of it.

@mgrybyk

This comment has been minimized.

Copy link
Member

commented Oct 9, 2019

./node_modules/.bin/wdio run

@christian-bromann

This comment has been minimized.

Copy link
Member Author

commented Oct 9, 2019

it should ask you if you want to create a config file if you don't have one

@mgrybyk

This comment has been minimized.

Copy link
Member

commented Oct 9, 2019

for me error message like Not enough non-option arguments: got 0, need at least 1 makes sense.

I wanted to run conf file but didn't proved it, so pretty much fair.

The question was only about epilogue if it should be in the very end in such case or no, both cases works for me

@christian-bromann

This comment has been minimized.

Copy link
Member Author

commented Oct 9, 2019

I think if the epilogue is always at the end such error message can get lost so I am fine with the observed behavior

christian-bromann and others added 12 commits Oct 8, 2019
* wdio-cli: init index.js tests

* wdio-cli: add index tests

* wdio-cli: fix config path with absolute path
@christian-bromann christian-bromann force-pushed the cb-cli-improvements branch from 13ed8bf to 04a558e Oct 10, 2019
Copy link
Member

left a comment

LGTM

@mgrybyk

This comment has been minimized.

Copy link
Member

commented Oct 10, 2019

Can you increase unit test coverage a bit?

@christian-bromann christian-bromann merged commit 6de6181 into master Oct 10, 2019
5 checks passed
5 checks passed
codecov/patch 100% of diff hit (target 99.32%)
Details
codecov/project 99.33% (+<.01%) compared to 4d34ab6
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
licence/cla Contributor License Agreement is signed.
Details
@christian-bromann christian-bromann deleted the cb-cli-improvements branch Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.