feat: add fund workspaces

Add workspaces support to `npm fund`

- Add ability to filter fund results to a specific set of workspaces
- Added tests and docs

Fixes: npm/statusboard#301

docs/content/commands/npm-fund.md

@@ -8,6 +8,7 @@ description: Retrieve funding information
 
 ```bash
 npm fund [<pkg>]
+npm fund [-w <workspace-name>]
 ```
 
 ### Description
@@ -24,6 +25,43 @@ The list will avoid duplicated entries and will stack all packages that
 share the same url as a single entry. Thus, the list does not have the same
 shape of the output from `npm ls`.
 
+#### Example
+
+### Workspaces support
+
+It's possible to filter the results to only include a single workspace and its
+dependencies using the `workspace` config option.
+
+#### Example:
+
+Here's an example running `npm fund` in a project with a configured
+workspace `a`:
+
+```bash
+$ npm fund
+test-workspaces-fund@1.0.0
++-- https://example.com/a
+| | `-- a@1.0.0
+| `-- https://github.com/sponsors/ljharb
+|     `-- has-symbols@1.0.2
++-- https://example.com/funding
+|   `-- @npmcli/test-funding
+`-- https://github.com/sponsors/isaacs
+    `-- promise-all-reject-late@1.0.1
+```
+
+And here is an example of the expected result when filtering only by
+a specific workspace `a` in the same project:
+
+```bash
+$ npm fund -w a
+test-workspaces-fund@1.0.0
+`-- https://github.com/sponsors
+  | `-- a@1.0.0
+  `-- https://github.com/sponsors/ljharb
+      `-- has-symbols@1.0.2
+```
+
 ### Configuration
 
 #### browser
@@ -48,6 +86,21 @@ Show information in JSON format.
 Whether to represent the tree structure using unicode characters.
 Set it to `false` in order to use all-ansi output.
 
+#### workspace
+
+* Alias: `-w`
+* Type: Array
+* Default: `[]`
+
+Enable filtering funding info results for `npm fund` to dependencies of a
+set of configured **workspaces**.
+
+Valid values for the `workspace` config are either:
+- Workspace names
+- Path to a workspace directory
+- Path to a parent workspace directory (will result to selecting all of the
+children workspaces)
+
 #### which
 
 * Type: Number
@@ -61,3 +114,4 @@ If there are multiple funding sources, which 1-indexed source URL to open.
 * [npm docs](/commands/npm-docs)
 * [npm ls](/commands/npm-ls)
 * [npm config](/commands/npm-config)
+* [npm workspaces](/using-npm/workspaces)

lib/fund.js

@@ -13,6 +13,7 @@ const {
 
 const completion = require('./utils/completion/installed-deep.js')
 const openUrl = require('./utils/open-url.js')
+const getWorkspaces = require('./workspaces/get-workspaces.js')
 
 const getPrintableName = ({ name, version }) => {
   const printableVersion = version ? `@${version}` : ''
@@ -38,6 +39,7 @@ class Fund extends BaseCommand {
       'json',
       'browser',
       'unicode',
+      'workspace',
       'which',
     ]
   }
@@ -56,7 +58,15 @@ class Fund extends BaseCommand {
     this.fund(args).then(() => cb()).catch(cb)
   }
 
-  async fund (args) {
+  execWorkspaces (args, filters, cb) {
+    getWorkspaces(filters, { path: this.npm.localPrefix })
+      .then(workspaces => {
+        this.workspaces = [...workspaces.keys()]
+        this.exec(args, cb)
+      })
+  }
+
+  async fund (args, opts) {
     const spec = args[0]
     const numberArg = this.npm.config.get('which')
 
@@ -92,10 +102,16 @@ class Fund extends BaseCommand {
       return
     }
 
+    const fundingInfo = getFundingInfo(tree, {
+      ...this.flatOptions,
+      log: this.npm.log,
+      workspaces: this.workspaces,
+    })
+
     if (this.npm.config.get('json'))
-      this.npm.output(this.printJSON(getFundingInfo(tree)))
+      this.npm.output(this.printJSON(fundingInfo))
     else
-      this.npm.output(this.printHuman(getFundingInfo(tree)))
+      this.npm.output(this.printHuman(fundingInfo))
   }
 
   printJSON (fundingInfo) {

tap-snapshots/test/lib/fund.js.test.cjs

@@ -92,3 +92,13 @@ test-multiple-funding-sources@1.0.0
 
 
 `
+
+exports[`test/lib/fund.js TAP workspaces filter funding info by a specific workspace > should display only filtered workspace and its deps 1`] = `
+workspaces-support@1.0.0
+\`-- https://example.com/a
+  | \`-- a@1.0.0
+  \`-- http://example.com/c
+      \`-- c@1.0.0
+
+
+`

test/lib/fund.js

@@ -839,3 +839,72 @@ t.test('sub dep with fund info and a parent with no funding info', t => {
     t.end()
   })
 })
+
+t.test('workspaces', t => {
+  t.test('filter funding info by a specific workspace', t => {
+    npm.localPrefix = npm.prefix = t.testdir({
+      'package.json': JSON.stringify({
+        name: 'workspaces-support',
+        version: '1.0.0',
+        workspaces: ['packages/*'],
+        dependencies: {
+          d: '^1.0.0',
+        },
+      }),
+      node_modules: {
+        a: t.fixture('symlink', '../packages/a'),
+        b: t.fixture('symlink', '../packages/b'),
+        c: {
+          'package.json': JSON.stringify({
+            name: 'c',
+            version: '1.0.0',
+            funding: [
+              'http://example.com/c',
+              'http://example.com/c-other',
+            ],
+          }),
+        },
+        d: {
+          'package.json': JSON.stringify({
+            name: 'd',
+            version: '1.0.0',
+            funding: 'http://example.com/d',
+          }),
+        },
+      },
+      packages: {
+        a: {
+          'package.json': JSON.stringify({
+            name: 'a',
+            version: '1.0.0',
+            funding: 'https://example.com/a',
+            dependencies: {
+              c: '^1.0.0',
+            },
+          }),
+        },
+        b: {
+          'package.json': JSON.stringify({
+            name: 'b',
+            version: '1.0.0',
+            funding: 'http://example.com/b',
+            dependencies: {
+              d: '^1.0.0',
+            },
+          }),
+        },
+      },
+    })
+
+    fund.execWorkspaces([], ['a'], (err) => {
+      t.error(err, 'should not error out')
+      t.matchSnapshot(result,
+        'should display only filtered workspace and its deps')
+
+      result = ''
+      t.end()
+    })
+  })
+
+  t.end()
+})