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

Wrong hint about --dry-run in react-monorepo.md #30137

Open
1 of 4 tasks
gabsprates opened this issue Feb 21, 2025 · 1 comment · May be fixed by #30198
Open
1 of 4 tasks

Wrong hint about --dry-run in react-monorepo.md #30137

gabsprates opened this issue Feb 21, 2025 · 1 comment · May be fixed by #30198
Assignees
Labels
scope: docs Issues related to generic docs type: docs

Comments

@gabsprates
Copy link

Documentation issue

  • Reporting a typo
  • Reporting a documentation bug
  • Documentation improvement
  • Documentation feedback

Is there a specific documentation page you are reporting?

https://nx.dev/getting-started/tutorials/react-monorepo-tutorial#adding-another-application

Additional context or description

The text says:

Note how we append --dry-run to first check the output.

But:

  1. there's no --dry-run flag included in the command;
  2. the actual flag is --dryRun; and
  3. it doesn't actually works for playwright, which shows a wrong error message with also the wrong flag.
    • maybe a hint like "playwright doesn't supports the --dryRun flag" would be good.

Image

Image


I'll be glad to send a PR with this correction.

@FrozenPandaz FrozenPandaz added the scope: docs Issues related to generic docs label Feb 24, 2025
@isaacplmann
Copy link
Collaborator

I'd be glad to review a PR about this. --dry-run and --dryRun are aliases. I don't think we need an extra warning about Playwright in this tutorial, since it isn't the option we're telling people to choose.

This is the file that would need to be updated:
docs/shared/tutorials/react-monorepo.md

To preview your changes run: nx serve-docs nx-dev
When you're happy with your changes, make sure to run nx format and nx documentation before committing and pushing your PR.

gabsprates added a commit to gabsprates/nx that referenced this issue Feb 26, 2025
Fix generate command for React Monorepo
Closes nrwl#30137
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Issues related to generic docs type: docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants