libnpmdiff 1.0.1 → 2.0.3

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

@@ -20,10 +20,10 @@ The registry diff lib.
 ```js
 const libdiff = require('libnpmdiff')
 
-const patch = await libdiff({
-  a: 'abbrev@1.1.0',
-  b: 'abbrev@1.1.1'
-})
+const patch = await libdiff([
+  'abbrev@1.1.0',
+  'abbrev@1.1.1'
+])
 console.log(
   patch
 )
@@ -70,27 +70,27 @@ Happy hacking!
 
 ### API
 
-#### `> libnpmdif({ a, b }, [opts]) -> Promise<String>`
+#### `> libnpmdif([ a, b ], [opts]) -> Promise<String>`
 
 Fetches the registry tarballs and compare files between a spec `a` and spec `b`. **npm** spec types are usually described in `<pkg-name>@<version>` form but multiple other types are alsos supported, for more info on valid specs take a look at [`npm-package-arg`](https://github.com/npm/npm-package-arg).
 
-If only spec `a` is provided, then it's going to try and compare that specified spec against the current project directory in the local file system (cwd may be set via `opts.prefix` option).
-
 **Options**:
 
 - `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`
-- `prefix <String>`: The path to use as current working directory if trying to read from local file system when using only a single comparison parameter `a`. Defaults to `.`.
+- `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`.
+- `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)
-- `diffOpts <Object>`: Object containing extra options on how to format the diff patch output:
-  - `context <Number>`: How many lines of code to print before/after each diff. Defaults to `3`.
-  - `files <Array<String>>`: If set only prints patches for the files listed in this array (also accepts globs). Defaults to `undefined`.
-  - `ignoreWhitespace <Boolean>`: Whether or not should ignore changes in whitespace (very useful to avoid indentation changes extra diff lines). Defaults to `false`.
-  - `nameOnly <Boolean>`: Prints only file names and no patch diffs. Defaults to `false`.
-  - `noPrefix <Boolean>`: If true then skips printing any prefixes in filenames. Defaults to `false`.
-  - `srcPrefix <String>`: Prefix to be used in the filenames from `a`. Defaults to `a/`.
-  - `dstPrefix <String>`: Prefix to be used in the filenames from `b`. Defaults to `b/`.
-  - `text <Boolean>`: Should treat all files as text and try to print diff for binary files. Defaults to `false`.
+
+Returns a `Promise` that fullfils with a `String` containing the resulting patch diffs.
+
+Throws an error if either `a` or `b` are missing or if trying to diff more than two specs.
 
 ## LICENSE
 

package/index.js

@@ -3,17 +3,20 @@ const pacote = require('pacote')
 const formatDiff = require('./lib/format-diff.js')
 const untar = require('./lib/untar.js')
 
+const argsError = () =>
+  Object.assign(
+    new TypeError('libnpmdiff needs two arguments to compare'),
+    { code: 'EDIFFARGS' }
+  )
 const diff = async (specs, opts = {}) => {
-  const { prefix: path } = opts
-
-  const aManifest = await pacote.manifest(specs.a, opts)
-
-  // when using a single argument the spec to compare from is going to be
-  // figured out from reading the current location package
-  if (!specs.b)
-    specs.b = `file:${path || '.'}`
-
-  const bManifest = await pacote.manifest(specs.b, opts)
+  if (specs.length !== 2)
+    throw argsError()
+
+  const [
+    aManifest,
+    bManifest,
+  ] =
+    await Promise.all(specs.map(spec => pacote.manifest(spec, opts)))
 
   const versions = {
     a: aManifest.version,

package/lib/format-diff.js

@@ -7,9 +7,8 @@ const shouldPrintPatch = require('./should-print-patch.js')
 
 const formatDiff = ({ files, opts = {}, refs, versions }) => {
   let res = ''
-  const diffOpts = opts.diffOpts || {}
-  const srcPrefix = diffOpts.noPrefix ? '' : diffOpts.srcPrefix || 'a/'
-  const dstPrefix = diffOpts.noPrefix ? '' : diffOpts.dstPrefix || 'b/'
+  const srcPrefix = opts.diffNoPrefix ? '' : opts.diffSrcPrefix || 'a/'
+  const dstPrefix = opts.diffNoPrefix ? '' : opts.diffDstPrefix || 'b/'
 
   for (const filename of files.values()) {
     const names = {
@@ -34,7 +33,7 @@ const formatDiff = ({ files, opts = {}, refs, versions }) => {
     if (contents.a === contents.b && modes.a === modes.b)
       continue
 
-    if (diffOpts.nameOnly) {
+    if (opts.diffNameOnly) {
       res += `${filename}${EOL}`
       continue
     }
@@ -71,8 +70,8 @@ const formatDiff = ({ files, opts = {}, refs, versions }) => {
         '',
         '',
         {
-          context: diffOpts.context || 3,
-          ignoreWhitespace: diffOpts.ignoreWhitespace,
+          context: opts.diffUnified === 0 ? 0 : opts.diffUnified || 3,
+          ignoreWhitespace: opts.diffIgnoreAllSpace,
         }
       ).replace(
         '===================================================================\n',

package/lib/should-print-patch.js

@@ -5,8 +5,7 @@ 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 = {}) => {
-  const { text } = opts.diffOpts || {}
-  if (text)
+  if (opts.diffText)
     return true
 
   const filename = basename(path)

package/lib/untar.js

@@ -10,35 +10,49 @@ const normalizeMatch = str => str
 const untar = ({ files, refs }, { filterFiles, item, prefix }) => {
   tar.list({
     filter: (path, entry) => {
+      const fileMatch = () =>
+        (!filterFiles.length ||
+          filterFiles.some(f => {
+            const pattern = normalizeMatch(f)
+            return minimatch(
+              normalizeMatch(path),
+              `{package/,}${pattern}`,
+              { matchBase: pattern.startsWith('*') }
+            )
+          }))
+
+      // expands usage of simple path filters, e.g: lib or src/
+      const folderMatch = () =>
+        filterFiles.some(f =>
+          normalizeMatch(path).startsWith(normalizeMatch(f)) ||
+          normalizeMatch(path).startsWith(`package/${normalizeMatch(f)}`))
+
       if (
-        entry.type !== 'File' ||
-        (filterFiles.length &&
-          !filterFiles.some(f =>
-            minimatch(normalizeMatch(path), `{package/,}${normalizeMatch(f)}`)))
-      )
-        return false
+        entry.type === 'File' &&
+        (fileMatch() || folderMatch())
+      ) {
+        const key = path.replace(/^[^/]+\/?/, '')
+        files.add(key)
 
-      const key = path.replace(/^[^/]+\/?/, '')
-      files.add(key)
+        // should skip reading file when using --name-only option
+        let content
+        try {
+          entry.setEncoding('utf8')
+          content = entry.concat()
+        } catch (e) {
+          /* istanbul ignore next */
+          throw Object.assign(
+            new Error('failed to read files'),
+            { code: 'EDIFFUNTAR' }
+          )
+        }
 
-      // should skip reading file when using --name-only option
-      let content
-      try {
-        entry.setEncoding('utf8')
-        content = entry.concat()
-      } catch (e) {
-        /* istanbul ignore next */
-        throw Object.assign(
-          new Error('failed to read files'),
-          { code: 'EDIFFUNTAR' }
-        )
+        refs.set(`${prefix}${key}`, {
+          content,
+          mode: `100${entry.mode.toString(8)}`,
+        })
+        return true
       }
-
-      refs.set(`${prefix}${key}`, {
-        content,
-        mode: `100${entry.mode.toString(8)}`,
-      })
-      return true
     },
   })
     .on('error', /* istanbul ignore next */ e => {
@@ -51,9 +65,8 @@ const readTarballs = async (tarballs, opts = {}) => {
   const files = new Set()
   const refs = new Map()
   const arr = [].concat(tarballs)
-  const { files: _files } = opts.diffOpts || {}
 
-  const filterFiles = _files || []
+  const filterFiles = opts.diffFiles || []
 
   for (const i of arr) {
     untar({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libnpmdiff",
-  "version": "1.0.1",
+  "version": "2.0.3",
   "description": "The registry diff",
   "repository": "https://github.com/npm/libnpmdiff",
   "files": [
@@ -58,7 +58,7 @@
     "binary-extensions": "^2.2.0",
     "diff": "^5.0.0",
     "minimatch": "^3.0.4",
-    "pacote": "^11.1.14",
+    "pacote": "^11.2.3",
     "tar": "^6.1.0"
   }
 }