libnpmfund 1.0.2 → 2.0.2

package/README.md

@@ -73,7 +73,10 @@ Options:
 - `countOnly`: Uses the tree-traversal logic from **npm fund** but skips over
 any obj definition and just returns an obj containing `{ length }` - useful for
 things such as printing a `6 packages are looking for funding` msg.
-- `path`: Location to current working directory
+- `workspaces`: `Array<String>` List of workspaces names to filter for,
+the result will only include a subset of the resulting tree that includes
+only the nodes that are children of the listed workspaces names.
+- `path`, `registry` and more [Arborist](https://github.com/npm/arborist/) options.
 
 ##### <a name="fund.readTree"></a> `> fund.readTree(tree, [opts]) -> Promise<Object>`
 

package/{index.js → lib/index.js}

@@ -15,7 +15,9 @@ function normalizeFunding (funding) {
 // Is the value of a `funding` property of a `package.json`
 // a valid type+url for `npm fund` to display?
 function isValidFunding (funding) {
-  if (!funding) return false
+  if (!funding) {
+    return false
+  }
 
   if (Array.isArray(funding)) {
     return funding.every(f => !Array.isArray(f) && isValidFunding(f))
@@ -30,7 +32,9 @@ function isValidFunding (funding) {
   if (
     parsed.protocol !== 'https:' &&
     parsed.protocol !== 'http:'
-  ) return false
+  ) {
+    return false
+  }
 
   return Boolean(parsed.host)
 }
@@ -43,11 +47,19 @@ function readTree (tree, opts) {
   const { countOnly } = opts || {}
   const _trailingDependencies = Symbol('trailingDependencies')
 
+  let filterSet
+
+  if (opts && opts.workspaces && opts.workspaces.length) {
+    const arb = new Arborist(opts)
+    filterSet = arb.workspaceDependencySet(tree, opts.workspaces)
+  }
+
   function tracked (name, version) {
     const key = String(name) + String(version)
     if (seen.has(key)) {
       return true
     }
+
     seen.add(key)
   }
 
@@ -81,18 +93,30 @@ function readTree (tree, opts) {
 
   function getFundingDependencies (tree) {
     const edges = tree && tree.edgesOut && tree.edgesOut.values()
-    if (!edges) return empty()
+    if (!edges) {
+      return empty()
+    }
 
     const directDepsWithFunding = Array.from(edges).map(edge => {
-      if (!edge || !edge.to) return empty()
+      if (!edge || !edge.to) {
+        return empty()
+      }
 
       const node = edge.to.target || edge.to
-      if (!node.package) return empty()
+      if (!node.package) {
+        return empty()
+      }
+
+      if (filterSet && filterSet.size > 0 && !filterSet.has(node)) {
+        return empty()
+      }
 
       const { name, funding, version } = node.package
 
       // avoids duplicated items within the funding tree
-      if (tracked(name, version)) return empty()
+      if (tracked(name, version)) {
+        return empty()
+      }
 
       const fundingItem = {}
 
@@ -104,7 +128,7 @@ function readTree (tree, opts) {
 
       return {
         node,
-        fundingItem
+        fundingItem,
       }
     })
 
@@ -112,7 +136,9 @@ function readTree (tree, opts) {
       (res, { node, fundingItem }, i) => {
         if (!fundingItem ||
           fundingItem.length === 0 ||
-          !node) return res
+          !node) {
+          return res
+        }
 
         // recurse
         const transitiveDependencies = node.edgesOut &&
@@ -121,7 +147,9 @@ function readTree (tree, opts) {
 
         // if we're only counting items there's no need
         // to add all the data to the resulting object
-        if (countOnly) return null
+        if (countOnly) {
+          return null
+        }
 
         if (hasDependencies(transitiveDependencies)) {
           fundingItem.dependencies =
@@ -145,7 +173,7 @@ function readTree (tree, opts) {
 
   const treeDependencies = getFundingDependencies(tree)
   const result = {
-    length: packageWithFundingCount
+    length: packageWithFundingCount,
   }
 
   if (!countOnly) {
@@ -170,8 +198,7 @@ function readTree (tree, opts) {
 
 async function read (opts) {
   const arb = new Arborist(opts)
-  const tree = await arb.loadActual()
-
+  const tree = await arb.loadActual(opts)
   return readTree(tree, opts)
 }
 
@@ -179,5 +206,5 @@ module.exports = {
   read,
   readTree,
   normalizeFunding,
-  isValidFunding
+  isValidFunding,
 }

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "libnpmfund",
-  "version": "1.0.2",
+  "version": "2.0.2",
+  "main": "lib/index.js",
   "files": [
-    "index.js"
+    "bin",
+    "lib"
   ],
   "description": "Programmatic API for npm fund",
   "repository": "https://github.com/npm/libnpmfund",
@@ -15,7 +17,7 @@
     "fund",
     "gitfund"
   ],
-  "author": "npm Inc. <support@npmjs.com>",
+  "author": "GitHub Inc.",
   "contributors": [
     {
       "name": "Ruy Adorno",
@@ -25,28 +27,30 @@
   ],
   "license": "ISC",
   "scripts": {
-    "lint": "standard",
-    "pretest": "npm run lint",
+    "eslint": "eslint",
+    "lint": "eslint '**/*.js'",
+    "lintfix": "npm run lint -- --fix",
+    "posttest": "npm run lint",
     "test": "tap",
     "snap": "tap",
     "preversion": "npm test",
     "postversion": "npm publish",
-    "prepublishOnly": "git push origin --follow-tags"
+    "prepublishOnly": "git push origin --follow-tags",
+    "postlint": "npm-template-check"
   },
   "tap": {
     "check-coverage": true
   },
-  "standard": {
-    "ignore": [
-      "/tap-snapshots/"
-    ]
-  },
   "devDependencies": {
-    "require-inject": "^1.4.4",
-    "standard": "^14.3.4",
-    "tap": "^14.10.7"
+    "tap": "^15.0.9"
   },
   "dependencies": {
-    "@npmcli/arborist": "^2.0.0"
+    "@npmcli/arborist": "^4.0.0"
+  },
+  "engines": {
+    "node": "^12.13.0 || ^14.15.0 || >=16"
+  },
+  "templateOSS": {
+    "version": "2.4.1"
   }
 }

package/CHANGELOG.md

@@ -1,6 +0,0 @@
-# Changelog
-
-## 0.0.0-pre.0
-
-- Initial pre-release.
-