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

Warning displayed by 'checkWorkspace' has typo: --with-workspaces should be --with-workspace #72

Closed
mhruddick opened this issue Feb 25, 2021 · 2 comments · Fixed by #73

Comments

@mhruddick
Copy link

Using > synp --source-file yarn.lock in a monorepo displays this warning:

Workspace (npm lockfile v2) support is experimental. Pass `--with-workspaces` flag to enable and cross your fingers. Good luck!

As a first time user, I took it at face value and added that flag, which resulted in this:

error: unknown option '--with-workspaces'

Quite a minor issue, but misleading to first-time users.

Aside from the fix for the warning text, another suggestion would be to automatically display the help along with the 'unknown option' error, as it does here for a different error:

> synp --with-workspace --source-file yarn.lock
destination file package-lock.json already exists, will not overwrite
Usage: synp [options]

Options:
  -V, --version                    output the version number
  -s, --source-file [source-file]  The path to the yarn.lock or package-lock.json to be converted
  -f, --force                      Force overwrite destination file
  --with-workspace                 Enable experimental npm lockfile v2 processing
  -h, --help                       display help for command
@antongolub
Copy link
Collaborator

@mhruddick,

Good catch, thanks!

antongolub added a commit that referenced this issue Feb 28, 2021
@antongolub antongolub added the bug label Feb 28, 2021
antongolub added a commit that referenced this issue Feb 28, 2021
github-actions bot pushed a commit that referenced this issue Feb 28, 2021
## [1.9.7](v1.9.6...v1.9.7) (2021-02-28)

### Bug Fixes

* use actual options for hints ([10cc940](10cc940)), closes [#72](#72)
@github-actions
Copy link

🎉 This issue has been resolved in version 1.9.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants