libnpmpack 1.0.0 → 3.0.1

package/README.md

@@ -27,15 +27,12 @@ const pack = require('libnpmpack')
 
 ### API
 
-
 #### <a name="pack"></a> `> pack(spec, [opts]) -> Promise`
 
-Packs a tarball from a local directory or from a registry or github spec and saves it on disk. Returns a Promise that resolves to an object containing the tarball contents.
+Packs a tarball from a local directory or from a registry or github spec and returns a Promise that resolves to the tarball data Buffer, with from, resolved, and integrity fields attached.
 
 If no options are passed, the tarball file will be saved on the same directory from which `pack` was called in.
  
-If `opts.target` is passed in, it will save the tarball file on the location entered.
-
 `libnpmpack` uses [`pacote`](https://npm.im/pacote).
 Most options are passed through directly to that library, so please refer to
 [its own `opts`
@@ -45,74 +42,15 @@ for options that can be passed in.
 ##### Examples
 
 ```javascript
-// packs from local directory
-const localTar = await pack()
-console.log(localTar)
-/* 
-{
-  id: 'my-cool-pkg@1.0.0',
-  name: 'my-cool-pkg',
-  version: '1.0.0',
-  size: 260,
-  unpackedSize: 133,
-  shasum: '535bdcc05fd4a1b7f2603c5527a7c63ba5b88cff',
-  integrity: ssri.parse(integrity.sha512[0]),
-  filename: 'my-cool-pkg-1.0.0.tgz',
-  files: [
-    { path: 'index.js', size: 5, mode: 420 },
-    { path: 'node_modules/a/package.json', size: 39, mode: 420 },
-    { path: 'package.json', size: 89, mode: 420 }
-  ],
-  entryCount: 3,
-  bundled: ['a']
-}
-*/
+// packs from cwd
+const tarball = await pack()
+
+// packs from a local directory
+const localTar = await pack('/Users/claudiahdz/projects/my-cool-pkg')
 
 // packs from a registry spec
 const registryTar = await pack('abbrev@1.0.3')
-console.log(registryTar)
-/*
-{
-  id: abbrev@1.0.3,
-  name: 'abbrev',
-  version: '1.0.3',
-  size: 1526,
-  unpackedSize: 3358,
-  shasum: 'aa049c967f999222aa42e14434f0c562ef468241',
-  integrity: Integrity { sha512: [ [Hash] ] },
-  filename: 'abbrev-1.0.3.tgz',
-  files: [
-    { path: 'package.json', size: 277, mode: 420 },
-    { path: 'README.md', size: 499, mode: 420 },
-    { path: 'lib/abbrev.js', size: 2582, mode: 420 }
-  ],
-  entryCount: 3,
-  bundled: []
-}
-*/
 
 // packs from a github spec
 const githubTar = await pack('isaacs/rimraf#PR-192')
-/*
-{
-  id: 'rimraf@2.6.3',
-  name: 'rimraf',
-  version: '2.6.3',
-  size: 5664,
-  unpackedSize: 15463,
-  shasum: '9f5edf99046b4096d610532f0ec279135a624b15',
-  integrity: Integrity { sha512: [ [Hash] ] },
-  filename: 'rimraf-2.6.3.tgz',
-  files: [
-    { path: 'LICENSE', size: 765, mode: 420 },
-    { path: 'bin.js', size: 1196, mode: 493 },
-    { path: 'rimraf.js', size: 9225, mode: 420 },
-    { path: 'package.json', size: 677, mode: 420 },
-    { path: 'README.md', size: 3600, mode: 420 }
-  ],
-  entryCount: 5,
-  bundled: []
-}
-*/
 ```
-

package/lib/index.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const pacote = require('pacote')
+const npa = require('npm-package-arg')
+const runScript = require('@npmcli/run-script')
+
+module.exports = pack
+async function pack (spec = 'file:.', opts = {}) {
+  // gets spec
+  spec = npa(spec)
+
+  const manifest = await pacote.manifest(spec, opts)
+
+  // Default to true if no log options passed, set to false if we're in silent
+  // mode
+  const banner = !opts.log || (opts.log.level !== 'silent')
+
+  if (spec.type === 'directory') {
+    // prepack
+    await runScript({
+      ...opts,
+      event: 'prepack',
+      path: spec.fetchSpec,
+      stdio: 'inherit',
+      pkg: manifest,
+      banner,
+    })
+  }
+
+  // packs tarball
+  const tarball = await pacote.tarball(manifest._resolved, {
+    ...opts,
+    integrity: manifest._integrity,
+  })
+
+  if (spec.type === 'directory') {
+    // postpack
+    await runScript({
+      ...opts,
+      event: 'postpack',
+      path: spec.fetchSpec,
+      stdio: 'inherit',
+      pkg: manifest,
+      banner,
+      env: {
+        npm_package_from: tarball.from,
+        npm_package_resolved: tarball.resolved,
+        npm_package_integrity: tarball.integrity,
+      },
+    })
+  }
+
+  return tarball
+}

package/package.json

@@ -1,32 +1,34 @@
 {
   "name": "libnpmpack",
-  "version": "1.0.0",
+  "version": "3.0.1",
   "description": "Programmatic API for the bits behind npm pack",
-  "author": "npm Inc. <support@npmjs.com>",
+  "author": "GitHub Inc.",
+  "main": "lib/index.js",
   "contributors": [
     "Claudia Hernández <claudia@npmjs.com>"
   ],
-  "main": "index.js",
   "files": [
-    "*.js",
-    "utils"
+    "bin",
+    "lib"
   ],
   "license": "ISC",
   "scripts": {
     "preversion": "npm test",
     "postversion": "npm publish",
     "prepublishOnly": "git push origin --follow-tags",
-    "lint": "standard",
+    "lint": "eslint '**/*.js'",
     "test": "tap",
-    "posttest": "npm run lint"
+    "posttest": "npm run lint",
+    "postlint": "npm-template-check",
+    "lintfix": "npm run lint -- --fix",
+    "snap": "tap"
   },
   "tap": {
     "check-coverage": true
   },
   "devDependencies": {
-    "nock": "^12.0.2",
-    "standard": "^14.3.1",
-    "tap": "^14.10.6"
+    "nock": "^13.0.7",
+    "tap": "^15.0.0"
   },
   "repository": {
     "type": "git",
@@ -35,17 +37,14 @@
   "bugs": "https://github.com/npm/libnpmpack/issues",
   "homepage": "https://npmjs.com/package/libnpmpack",
   "dependencies": {
-    "@npmcli/run-script": "^1.3.0",
-    "byte-size": "^6.2.0",
-    "columnify": "^1.5.4",
-    "move-concurrently": "^1.0.1",
-    "npm-package-arg": "^8.0.0",
-    "pacote": "^11.1.2",
-    "rimraf": "^3.0.2",
-    "ssri": "^8.0.0",
-    "tar": "^6.0.1"
+    "@npmcli/run-script": "^2.0.0",
+    "npm-package-arg": "^8.1.0",
+    "pacote": "^12.0.0"
   },
   "engines": {
-    "node": ">=10"
+    "node": "^12.13.0 || ^14.15.0 || >=16"
+  },
+  "templateOSS": {
+    "version": "2.4.1"
   }
 }

package/CHANGELOG.md

@@ -1,10 +0,0 @@
-# Change Log
-
-<a name="1.0.0"></a> 
-# 1.0.0 (2020-03-26)
-
-### Features
-
-* [`a35c590`](https://github.com/npm/libnpmpack/commit/a35c590) feat: pack tarballs from local dir or registry spec ([@claudiahdz](https://github.com/claudiahdz))
-
-* [`6d72149`](https://github.com/npm/libnpmpack/commit/6d72149) feat: sorted tarball contents ([@eridal](https://github.com/eridal))

package/index.js

@@ -1,75 +0,0 @@
-'use strict'
-
-const os = require('os')
-const fs = require('fs')
-const path = require('path')
-const util = require('util')
-const pacote = require('pacote')
-const npa = require('npm-package-arg')
-const mv = require('move-concurrently')
-const runScript = require('@npmcli/run-script')
-
-const rimraf = util.promisify(require('rimraf'))
-const mkdtemp = util.promisify(fs.mkdtemp)
-
-const { getContents, logTar } = require('./utils/tar')
-
-async function pack (spec = 'file:.', opts = {}) {
-  const { target = null } = opts
-  // gets spec
-  spec = npa(spec)
-
-  const manifest = await pacote.manifest(spec, opts)
-  const filename = path.basename(`${manifest.name}-${manifest.version}.tgz`)
-  const dest = target || `${process.cwd()}/${filename}`
-
-  if (spec.type === 'directory') {
-    // prepack
-    await runScript({
-      ...opts,
-      event: 'prepack',
-      path: spec.fetchSpec,
-      stdio: 'inherit',
-      pkg: manifest,
-      env: {
-        npm_package_target: dest
-      }
-    })
-  }
-
-  const tmpDir = await mkdtemp(path.join(os.tmpdir(), 'libnpmpack-'))
-  const tmpTarget = `${tmpDir}/${filename}`
-
-  // packs tarball on tmp location
-  const tarball = await pacote.tarball.file(manifest._resolved, tmpTarget, {
-    ...opts,
-    integrity: manifest._integrity
-  })
-
-  // moves tarball to dest
-  await mv(tmpTarget, dest)
-  await rimraf(tmpDir)
-
-  if (spec.type === 'directory') {
-    // postpack
-    await runScript({
-      ...opts,
-      event: 'postpack',
-      path: spec.fetchSpec,
-      stdio: 'inherit',
-      pkg: manifest,
-      env: {
-        npm_package_target: dest,
-        npm_package_from: tarball.from,
-        npm_package_resolved: tarball.resolved,
-        npm_package_integrity: tarball.integrity
-      }
-    })
-  }
-
-  const contents = await getContents(manifest, dest)
-  return contents
-}
-
-pack.logTar = logTar
-module.exports = pack

package/utils/tar.js

@@ -1,121 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const tar = require('tar')
-const util = require('util')
-const ssri = require('ssri')
-const byteSize = require('byte-size')
-const columnify = require('columnify')
-
-const statAsync = util.promisify(require('fs').stat)
-
-module.exports.logTar = logTar
-/* istanbul ignore next */
-function logTar (tarball, opts = {}) {
-  const { unicode, log = console.log } = opts
-  log('')
-  log('', `${unicode ? '📦 ' : 'package:'} ${tarball.name}@${tarball.version}`)
-  log('=== Tarball Contents ===')
-  if (tarball.files.length) {
-    log('', columnify(tarball.files.map((f) => {
-      const bytes = byteSize(f.size)
-      return { path: f.path, size: `${bytes.value}${bytes.unit}` }
-    }), {
-      include: ['size', 'path'],
-      showHeaders: false
-    }))
-  }
-  if (tarball.bundled.length) {
-    log('=== Bundled Dependencies ===')
-    tarball.bundled.forEach((name) => log.notice('', name))
-  }
-  log('=== Tarball Details ===')
-  log('', columnify([
-    { name: 'name:', value: tarball.name },
-    { name: 'version:', value: tarball.version },
-    tarball.filename && { name: 'filename:', value: tarball.filename },
-    { name: 'package size:', value: byteSize(tarball.size) },
-    { name: 'unpacked size:', value: byteSize(tarball.unpackedSize) },
-    { name: 'shasum:', value: tarball.shasum },
-    {
-      name: 'integrity:',
-      value: tarball.integrity.toString().substr(0, 20) + '[...]' + tarball.integrity.toString().substr(80)
-    },
-    tarball.bundled.length && { name: 'bundled deps:', value: tarball.bundled.length },
-    tarball.bundled.length && { name: 'bundled files:', value: tarball.entryCount - tarball.files.length },
-    tarball.bundled.length && { name: 'own files:', value: tarball.files.length },
-    { name: 'total files:', value: tarball.entryCount }
-  ].filter((x) => x), {
-    include: ['name', 'value'],
-    showHeaders: false
-  }))
-  log('', '')
-}
-
-module.exports.getContents = getContents
-async function getContents (manifest, target) {
-  const files = []
-  const bundled = new Set()
-  let totalEntries = 0
-  let totalEntrySize = 0
-
-  // reads contents of tarball
-  await tar.t({
-    file: target,
-    onentry (entry) {
-      totalEntries++
-      totalEntrySize += entry.size
-      const p = entry.path
-      if (p.startsWith('package/node_modules/')) {
-        const name = p.match(/^package\/node_modules\/((?:@[^/]+\/)?[^/]+)/)[1]
-        bundled.add(name)
-      }
-      files.push({
-        path: entry.path.replace(/^package\//, ''),
-        size: entry.size,
-        mode: entry.mode
-      })
-    },
-    strip: 1
-  })
-
-  const [stat, integrity] = await Promise.all([
-    statAsync(target),
-    ssri.fromStream(fs.createReadStream(target), {
-      algorithms: ['sha1', 'sha512']
-    })
-  ])
-
-  const comparator = (a, b) => {
-    return a.path.localeCompare(b.path, undefined, {
-      sensitivity: 'case',
-      numeric: true
-    })
-  }
-
-  const isUpper = (str) => {
-    const ch = str.charAt(0)
-    return ch >= 'A' && ch <= 'Z'
-  }
-
-  const uppers = files.filter(file => isUpper(file.path))
-  const others = files.filter(file => !isUpper(file.path))
-
-  uppers.sort(comparator)
-  others.sort(comparator)
-
-  const shasum = integrity.sha1[0].hexDigest()
-  return {
-    id: manifest._id || `${manifest.name}@${manifest.version}`,
-    name: manifest.name,
-    version: manifest.version,
-    size: stat.size,
-    unpackedSize: totalEntrySize,
-    shasum,
-    integrity: ssri.parse(integrity.sha512[0]),
-    filename: `${manifest.name}-${manifest.version}.tgz`,
-    files: uppers.concat(others),
-    entryCount: totalEntries,
-    bundled: Array.from(bundled)
-  }
-}