Skip to content

docs: fix workspaces example #6714

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.

Sign up for GitHub

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

Closed
fvilers wants to merge 1 commit into from
Closed

docs: fix workspaces example #6714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/lib/content/using-npm/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ the npm installer that package should be added as a dependency of the provided
workspace:

```
npm install abbrev -w a
npm install abbrev -w packages/a
Copy link
Member

@wraithgar wraithgar Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was actually correct, and included to show that the -w flag accepts the name of the workspace, not just the path.

Copy link
Author

@fvilers fvilers Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not working here (Windows 10, Node 18.15.0)

image

Copy link
Member

@wraithgar wraithgar Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the name attribute of the package.json in packages/app?

Copy link
Author

@fvilers fvilers Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I get it. The argument to -w is not the directory name but the package name defined in package.json. Sorry for the misunderstanding, but it's not precisely stated in the documentation. The example used in documentation is directory structure oriented, hence my confusion.

Copy link
Member

@wraithgar wraithgar Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Perhaps the examples could be updated so the directory and package names differ, to make this more clear?

```

Note: other installing commands such as `uninstall`, `ci`, etc will also
Expand Down