libnpmdiff 2.0.0 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 2.0.3
+
+- fix name of options sent by the npm cli
+
+## 2.0.2
+
+- fix matching basename file filter
+
+## 2.0.1
+
+- fix for tarballs not listing folder names
+
+## 2.0.0
+
+- API rewrite:
+  - normalized all options
+  - specs to compare are now an array
+- fix context=0
+- added support to filtering by folder names
+
 ## 1.0.1
 
 - fixed nameOnly option

package/README.md

@@ -78,15 +78,15 @@ Fetches the registry tarballs and compare files between a spec `a` and spec `b`.
 
 - `color <Boolean>`: Should add ANSI colors to string output? Defaults to `false`.
 - `tagVersionPrefix <Sring>`: What prefix should be used to define version numbers. Defaults to `v`
-- `diffContext <Number>`: How many lines of code to print before/after each diff. Defaults to `3`.
+- `diffUnified <Number>`: How many lines of code to print before/after each diff. Defaults to `3`.
 - `diffFiles <Array<String>>`: If set only prints patches for the files listed in this array (also accepts globs). Defaults to `undefined`.
-- `diffIgnoreWhitespace <Boolean>`: Whether or not should ignore changes in whitespace (very useful to avoid indentation changes extra diff lines). Defaults to `false`.
+- `diffIgnoreAllSpace <Boolean>`: Whether or not should ignore changes in whitespace (very useful to avoid indentation changes extra diff lines). Defaults to `false`.
 - `diffNameOnly <Boolean>`: Prints only file names and no patch diffs. Defaults to `false`.
 - `diffNoPrefix <Boolean>`: If true then skips printing any prefixes in filenames. Defaults to `false`.
 - `diffSrcPrefix <String>`: Prefix to be used in the filenames from `a`. Defaults to `a/`.
 - `diffDstPrefix <String>`: Prefix to be used in the filenames from `b`. Defaults to `b/`.
 - `diffText <Boolean>`: Should treat all files as text and try to print diff for binary files. Defaults to `false`.
-- ...`cache`, `registry` and other common options accepted by [pacote](https://github.com/npm/pacote#options)
+- ...`cache`, `registry`, `where` and other common options accepted by [pacote](https://github.com/npm/pacote#options)
 
 Returns a `Promise` that fullfils with a `String` containing the resulting patch diffs.
 

package/index.js

@@ -1,6 +1,7 @@
 const pacote = require('pacote')
 
 const formatDiff = require('./lib/format-diff.js')
+const getTarball = require('./lib/tarball.js')
 const untar = require('./lib/untar.js')
 
 const argsError = () =>
@@ -25,8 +26,8 @@ const diff = async (specs, opts = {}) => {
 
   // fetches tarball using pacote
   const [a, b] = await Promise.all([
-    pacote.tarball(aManifest._resolved, opts),
-    pacote.tarball(bManifest._resolved, opts),
+    getTarball(aManifest, opts),
+    getTarball(bManifest, opts),
   ])
 
   // read all files

package/lib/format-diff.js

@@ -70,8 +70,8 @@ const formatDiff = ({ files, opts = {}, refs, versions }) => {
         '',
         '',
         {
-          context: opts.diffContext === 0 ? 0 : opts.diffContext || 3,
-          ignoreWhitespace: opts.diffIgnoreWhitespace,
+          context: opts.diffUnified === 0 ? 0 : opts.diffUnified || 3,
+          ignoreWhitespace: opts.diffIgnoreAllSpace,
         }
       ).replace(
         '===================================================================\n',

package/lib/tarball.js

@@ -0,0 +1,33 @@
+const { relative } = require('path')
+
+const npa = require('npm-package-arg')
+const pkgContents = require('@npmcli/installed-package-contents')
+const pacote = require('pacote')
+const { tarCreateOptions } = pacote.DirFetcher
+const tar = require('tar')
+
+// returns a simplified tarball when reading files from node_modules folder,
+// thus avoiding running the prepare scripts and the extra logic from packlist
+const nodeModulesTarball = (manifest, opts) =>
+  pkgContents({ path: manifest._resolved, depth: 1 })
+    .then(files =>
+      files.map(file => relative(manifest._resolved, file))
+    )
+    .then(files =>
+      tar.c(tarCreateOptions(manifest), files).concat()
+    )
+
+const tarball = (manifest, opts) => {
+  const resolved = manifest._resolved
+  const where = opts.where || process.cwd()
+
+  const fromNodeModules = npa(resolved).type === 'directory'
+    && /node_modules[\\/](@[^\\/]+\/)?[^\\/]+[\\/]?$/.test(relative(where, resolved))
+
+  if (fromNodeModules)
+    return nodeModulesTarball(manifest, opts)
+
+  return pacote.tarball(manifest._resolved, opts)
+}
+
+module.exports = tarball

package/lib/untar.js

@@ -12,12 +12,14 @@ const untar = ({ files, refs }, { filterFiles, item, prefix }) => {
     filter: (path, entry) => {
       const fileMatch = () =>
         (!filterFiles.length ||
-          filterFiles.some(f =>
-            minimatch(
+          filterFiles.some(f => {
+            const pattern = normalizeMatch(f)
+            return minimatch(
               normalizeMatch(path),
-              `{package/,}${normalizeMatch(f)}`,
-              { matchBase: true }
-            )))
+              `{package/,}${pattern}`,
+              { matchBase: pattern.startsWith('*') }
+            )
+          }))
 
       // expands usage of simple path filters, e.g: lib or src/
       const folderMatch = () =>
@@ -25,19 +27,9 @@ const untar = ({ files, refs }, { filterFiles, item, prefix }) => {
           normalizeMatch(path).startsWith(normalizeMatch(f)) ||
           normalizeMatch(path).startsWith(`package/${normalizeMatch(f)}`))
 
-      if (
-        filterFiles.length &&
-        entry.type === 'Directory' &&
-        folderMatch()
-      ) {
-        // if simple folder was found, add that as a glob to list of filters
-        filterFiles.push(`${path}**`)
-        return false
-      }
-
       if (
         entry.type === 'File' &&
-        fileMatch()
+        (fileMatch() || folderMatch())
       ) {
         const key = path.replace(/^[^/]+\/?/, '')
         files.add(key)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libnpmdiff",
-  "version": "2.0.0",
+  "version": "2.0.4",
   "description": "The registry diff",
   "repository": "https://github.com/npm/libnpmdiff",
   "files": [
@@ -55,10 +55,12 @@
   },
   "dependencies": {
     "@npmcli/disparity-colors": "^1.0.1",
+    "@npmcli/installed-package-contents": "^1.0.7",
     "binary-extensions": "^2.2.0",
     "diff": "^5.0.0",
     "minimatch": "^3.0.4",
-    "pacote": "^11.2.3",
+    "npm-package-arg": "^8.1.1",
+    "pacote": "^11.3.0",
     "tar": "^6.1.0"
   }
 }