Skip to content

pnpm link and pnpm unlink documentation page could be better? #4640

@JasonKleban

Description

@JasonKleban

The documentation pages for pnpm link and pnpm unlink needs some elaboration, please.

Topics that could be covered/improved:

  • difference between pnpm link <dir> and the other options. What is the usecase?
  • The existence of both pnpm link <dir> and --dir option is potentially confusing. For example, my experiments with pnpm link --global --dir c:\some\other\folder did not have the effect I expected. (I don't really know what it did, but it didn't register c:\some\other\folder's package repo globally)
  • explain more the multiple steps involved in --global linking - 1) from the dependency to register it globally, 2) from the dependent
  • for unlink: "If called without arguments, all linked dependencies will be unlinked." Is this global to the machine? Is it just for dependents? Or just for dependencies? Or both, for a particular working directory?
  • Are there any gotchas with mixing package managers on a system? What if the dependency uses npm while the dependent uses pnpm?
  • Are there any tools for examining the current state of linked packages on the machine ("no", I think).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions