add pnpm workspaces info

[futurist]

• I'd be willing to implement this feature (contributing guide)

Describe the user story

Want a command like yarn workspaces info, but no counterpart command for pnpm.

Describe the solution you'd like

Maybe add a command like pnpm workspaces info

And if pass --json, it can output the json results.

[rdsedmundo]

I managed to get some useful information with pnpm ls -r --depth -1 --long --parseable.

/Users/user/acme/packages/first:@acme/first@1.0.0
/Users/user/acme/packages/second:@acme/second@1.0.0
...

The ls command also supports a --json flag, but it unfortunately doesn't display the package path like the former.

I converted it to JSON like this (note that I'm assuming that packages names start with @, like @acme/package):

const workspaces = execSync('pnpm ls -r --depth -1 --long --parseable')
  .toString('utf8')
  .split('\n')
  // the first line is the workspace root
  .slice(1)
  .map((entry) => {
    const [location, nameWithVersion] = entry.split(':');
    const [, name, version] = nameWithVersion.split('@');

    return {
      location,
      version,
      // add forward @ again that was split
      name: `@${name}`,
    };
  })
  .reduce((acc, workspace) => ({ ...acc, [workspace.name]: workspace }), {});

[gluxon]

Hey everyone, I got linked here by @zkochan's comment in #4154

1. I'm wondering if resolving this via the existing pnpm list command makes sense? In theory that allows the --depth, --filter, and --json flags to be reused.
2. Alternatively we could close the pnpm list feature request I opened in favor of a new pnpm workspaces info command like this issue proposes.

I would personally prefer extending pnpm list to traverse through workspaces (option 1) since a new pnpm workspaces info command would create 2 commands for listing out dependencies, and users might be confused when using the wrong one.

What does everyone else think?

Edit: To be clear, I'm not a pnpm main contributor. Just starting a discussion in hopes of figuring out which GitHub issue to close.

[zkochan]

I think it is fine to extend the pnpm list command. pnpm workspaces might be a bad command for pnpm because we don't call the packages in the workspace "workspaces".

[NullVoxPopuli]

I just ran in to a need for this today as I was adding pnpm support to my project hopper script: https://github.com/NullVoxPopuli/dotfiles/blob/master/home/shell/bash/gg.sh

[NullVoxPopuli]

This is the command I ended up using in bash:

pnpm ls -r --depth -1 --long --parseable \
  | cut -f1 -d':' \
  | sed "s~$PWD~~g" \
  | sed '/^[[:space:]]*$/d' \
  | sed 's~^/~~g'

[karlomedallo]

+1 for this. My use case is I wanted to get all the workspace package dependencies of an app so that during CI it would know if it needs to run a job or not when changes has been detected from the dependent package

[gluxon]

Hey @karlomedallo, would #5863 help for that use case?

[karlomedallo]

@gluxon yes, that #5863 will definitely help! I hope that gets merged. Thanks!

[kachkaev]

If pnpm workspaces is added, having yarn workspace command too would be great! #3451 (comment)