[feat] List workspace names/paths only

[restfulhead]

Is there an existing issue for this?

• I have searched the existing issues

This issue exists in the latest npm version

• I am using the latest npm

Current Behavior

I'm looking for an NPM command similar to lerna ls that would print out only the paths of all workspaces.

npm ls --production --depth 0 -json does contain the information, but it's difficult to parse ("resolved": "file:../../packages/package1", instead of just path: packages/package1 for example)

Related Stackoverflow post: https://stackoverflow.com/questions/69980663/list-npm-workspaces-similar-to-lerna-ls

Expected Behavior

Maybe npm ls -ws could just print out the paths, e.g.

packages/package1
packages/package2
my-other-package

Steps To Reproduce

See above

Environment

• npm: 7.24.2
• Node: v14.17.3
• OS: MacOS
• platform: Mac

P.S.: This is not a bug, but a feature request. I could not find another template.

[justinfagnani]

This is especially important to understand what packages and in what order npm will run scripts in. Related to the issue I just filed about running scripts in topological order: #4139

[nlf]

this is now possible with npm query when combined with a tool like jq in the latest npm@8, an example run from this repository:

> npm query .workspace | jq -r '.[].location'
docs
workspaces/arborist
workspaces/libnpmaccess
workspaces/libnpmdiff
workspaces/libnpmexec
workspaces/libnpmfund
workspaces/libnpmhook
workspaces/libnpmorg
workspaces/libnpmpack
workspaces/libnpmpublish
workspaces/libnpmsearch
workspaces/libnpmteam
workspaces/libnpmversion
smoke-tests

[dmail]

jq will list a subset of packages when NPM output is too large for the terminal.
It gives the false impression NPM is not taking into account some packages.
And it forces to install jq.

[ljharb]

You can use npx json too. I’m confused why jq would truncate anything tho.

[dmail]

Actually my bad, jq works fine.
Some packages where not reported but after removing nodes modules + package-lock.json + npm install: they are listed.

Still something odd to me: the order of packages being listed.

My workspaces config:

"workspaces": [
    "./packages/internal/*",
    "./packages/plugins/*",
    "./packages/rest/*"
]

And the output in the terminal is mixing package directories

packages/rest/a
packages/plugins/plugin-a
packages/internal/internal-a
packages/plugins/plugin-b
packages/rest/b

I would expect them to stay grouped by directory (and in the order provided by "workspaces"):

packages/internal/internal-a
packages/plugins/plugin-a
packages/plugins/plugin-b
packages/rest/a
packages/rest/b

[siefkenj]

You can get pretty close with npm exec -c pwd -ws (on a unix system), and there's no need for jq.

[luwes]

not the fastest but this seems to work and it should be supported on all platforms.

npm exec -c 'node -p "process.env.npm_package_name + \":\" + process.env.PWD"' -w packages

npm query seems less ideal because you lose the filtering options of -w and -ws and the order is not maintained.