Skip to content

Try to add a little more helpful information about tgz file references #6751

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Try to add a little more helpful information about tgz file references #6751

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
3 changes: 3 additions & 0 deletions packages/docusaurus/docs/advanced/01-general-reference/protocols/file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ file:./relative/path/to/package.tgz
## Tarball-based links

When `file:` points to a `.tgz` file, Yarn will transparently let you require files from within the archive. For the `node_modules` linker, it means that the archive will be unpacked into the generated `node_modules` folder.

The `.tgz` file should have all the project files under a single top-level folder, and that folder should have a `package.json` file describing the package and its version. For example, a package called `foo` might be
in a file named `foo-1.0.tgz`, the `tgz` could have files in it at `foo/package.json` and `foo/main.js`. You would add it to your project with a command like `yarn add foo@file:./path/to/foo-1.0.tgz`.
Loading