libnpmdiff 2.0.1 → 3.0.0

package/README.md

@@ -61,7 +61,7 @@ hesitate to jump in if you'd like to, or even ask us questions if something
 isn't clear.
 
 All participants and maintainers in this project are expected to follow the
-[npm Code of Conduct](https://www.npmjs.com/policies/conduct), and just
+[npm Code of Conduct](https://docs.npmjs.com/policies/conduct), and just
 generally be excellent to each other.
 
 Please refer to the [Changelog](CHANGELOG.md) for project history details, too.
@@ -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/lib/format-diff.js

@@ -30,8 +30,9 @@ const formatDiff = ({ files, opts = {}, refs, versions }) => {
       b: filenames.b && filenames.b.mode,
     }
 
-    if (contents.a === contents.b && modes.a === modes.b)
+    if (contents.a === contents.b && modes.a === modes.b) {
       continue
+    }
 
     if (opts.diffNameOnly) {
       res += `${filename}${EOL}`
@@ -47,18 +48,19 @@ const formatDiff = ({ files, opts = {}, refs, versions }) => {
 
     // manually build a git diff-compatible header
     header(`diff --git ${names.a} ${names.b}`)
-    if (modes.a === modes.b)
+    if (modes.a === modes.b) {
       fileMode = filenames.a.mode
-    else {
-      if (modes.a && !modes.b)
+    } else {
+      if (modes.a && !modes.b) {
         header(`deleted file mode ${modes.a}`)
-      else if (!modes.a && modes.b)
+      } else if (!modes.a && modes.b) {
         header(`new file mode ${modes.b}`)
-      else {
+      } else {
         header(`old mode ${modes.a}`)
         header(`new mode ${modes.b}`)
       }
     }
+    /* eslint-disable-next-line max-len */
     header(`index ${opts.tagVersionPrefix || 'v'}${versions.a}..${opts.tagVersionPrefix || 'v'}${versions.b} ${fileMode}`)
 
     if (shouldPrintPatch(filename)) {
@@ -70,8 +72,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/{index.js → lib/index.js}

@@ -1,16 +1,22 @@
 const pacote = require('pacote')
 
-const formatDiff = require('./lib/format-diff.js')
-const untar = require('./lib/untar.js')
-
+const formatDiff = require('./format-diff.js')
+const getTarball = require('./tarball.js')
+const untar = require('./untar.js')
+
+// TODO: we test this condition in the diff command
+// so this error probably doesnt need to be here. Or
+// if it does we should figure out a standard code
+// so we can catch it in the cli and display it consistently
 const argsError = () =>
   Object.assign(
     new TypeError('libnpmdiff needs two arguments to compare'),
     { code: 'EDIFFARGS' }
   )
 const diff = async (specs, opts = {}) => {
-  if (specs.length !== 2)
+  if (specs.length !== 2) {
     throw argsError()
+  }
 
   const [
     aManifest,
@@ -25,8 +31,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/should-print-patch.js

@@ -5,8 +5,9 @@ const binaryExtensions = require('binary-extensions')
 // we should try to print patches as long as the
 // extension is not identified as binary files
 const shouldPrintPatch = (path, opts = {}) => {
-  if (opts.diffText)
+  if (opts.diffText) {
     return true
+  }
 
   const filename = basename(path)
   const extension = (

package/lib/tarball.js

@@ -0,0 +1,34 @@
+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 = () =>

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "libnpmdiff",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "The registry diff",
   "repository": "https://github.com/npm/libnpmdiff",
+  "main": "lib/index.js",
   "files": [
-    "index.js",
+    "bin",
     "lib"
   ],
   "engines": {
-    "node": ">=10"
+    "node": "^12.13.0 || ^14.15.0 || >=16"
   },
   "keywords": [
     "npm",
@@ -28,37 +29,34 @@
   "license": "ISC",
   "scripts": {
     "eslint": "eslint",
-    "lint": "npm run eslint -- index.js \"lib/**/*.js\" \"test/*.js\"",
+    "lint": "eslint '**/*.js'",
     "lintfix": "npm run lint -- --fix",
-    "test": "tap test/*.js",
+    "test": "tap",
     "posttest": "npm run lint",
-    "snap": "tap test/*.js",
+    "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": {
-    "eslint": "^7.18.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^5.0.0",
-    "tap": "^14.11.0"
+    "eslint": "^8.1.0",
+    "tap": "^15.0.9"
   },
   "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.4",
+    "pacote": "^12.0.0",
     "tar": "^6.1.0"
+  },
+  "templateOSS": {
+    "version": "2.4.1"
   }
 }

package/CHANGELOG.md

@@ -1,22 +0,0 @@
-# Changelog
-
-## 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
-
-## 1.0.0
-
-- Initial release
-