Change API to support publishing non-directories

.eslintrc.json

@@ -0,0 +1,207 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "ecmaFeatures": {},
+    "sourceType": "script"
+  },
+
+  "env": {
+    "es6": true,
+    "node": true
+  },
+
+  "plugins": [
+    "import",
+    "node",
+    "promise",
+    "standard"
+  ],
+
+  "globals": {
+    "document": "readonly",
+    "navigator": "readonly",
+    "window": "readonly"
+  },
+
+  "rules": {
+    "accessor-pairs": "error",
+    "array-bracket-spacing": ["error", "never"],
+    "arrow-spacing": ["error", { "before": true, "after": true }],
+    "block-spacing": ["error", "always"],
+    "brace-style": ["error", "1tbs", { "allowSingleLine": false }],
+    "camelcase": ["error", { "properties": "never" }],
+    "comma-dangle": ["error", {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline",
+      "functions": "never"
+    }],
+    "comma-spacing": ["error", { "before": false, "after": true }],
+    "comma-style": ["error", "last"],
+    "computed-property-spacing": ["error", "never"],
+    "constructor-super": "error",
+    "curly": ["error", "multi-or-nest"],
+    "dot-location": ["error", "property"],
+    "dot-notation": ["error", { "allowKeywords": true }],
+    "eol-last": "error",
+    "eqeqeq": ["error", "always", { "null": "ignore" }],
+    "func-call-spacing": ["error", "never"],
+    "generator-star-spacing": ["error", { "before": true, "after": true }],
+    "handle-callback-err": ["error", "^(err|error)$" ],
+    "indent": ["error", 2, {
+      "SwitchCase": 1,
+      "VariableDeclarator": 1,
+      "outerIIFEBody": 1,
+      "MemberExpression": 1,
+      "FunctionDeclaration": { "parameters": 1, "body": 1 },
+      "FunctionExpression": { "parameters": 1, "body": 1 },
+      "CallExpression": { "arguments": 1 },
+      "ArrayExpression": 1,
+      "ObjectExpression": 1,
+      "ImportDeclaration": 1,
+      "flatTernaryExpressions": true,
+      "ignoreComments": false,
+      "ignoredNodes": ["TemplateLiteral *"]
+    }],
+    "key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
+    "keyword-spacing": ["error", { "before": true, "after": true }],
+    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
+    "new-cap": ["error", { "newIsCap": true, "capIsNew": false, "properties": true }],
+    "new-parens": "error",
+    "no-array-constructor": "error",
+    "no-async-promise-executor": "error",
+    "no-caller": "error",
+    "no-case-declarations": "error",
+    "no-class-assign": "error",
+    "no-compare-neg-zero": "error",
+    "no-cond-assign": "off",
+    "no-const-assign": "error",
+    "no-constant-condition": ["error", { "checkLoops": false }],
+    "no-control-regex": "error",
+    "no-debugger": "error",
+    "no-delete-var": "error",
+    "no-dupe-args": "error",
+    "no-dupe-class-members": "error",
+    "no-dupe-keys": "error",
+    "no-duplicate-case": "error",
+    "no-empty-character-class": "error",
+    "no-empty-pattern": "error",
+    "no-eval": "error",
+    "no-ex-assign": "error",
+    "no-extend-native": "error",
+    "no-extra-bind": "error",
+    "no-extra-boolean-cast": "error",
+    "no-extra-parens": ["error", "functions"],
+    "no-fallthrough": "error",
+    "no-floating-decimal": "error",
+    "no-func-assign": "error",
+    "no-global-assign": "error",
+    "no-implied-eval": "error",
+    "no-inner-declarations": ["error", "functions"],
+    "no-invalid-regexp": "error",
+    "no-irregular-whitespace": "error",
+    "no-iterator": "error",
+    "no-labels": ["error", { "allowLoop": true, "allowSwitch": false }],
+    "no-lone-blocks": "error",
+    "no-misleading-character-class": "error",
+    "no-prototype-builtins": "error",
+    "no-useless-catch": "error",
+    "no-mixed-operators": "off",
+    "no-mixed-spaces-and-tabs": "error",
+    "no-multi-spaces": "error",
+    "no-multi-str": "error",
+    "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 0 }],
+    "no-negated-in-lhs": "error",
+    "no-new": "off",
+    "no-new-func": "error",
+    "no-new-object": "error",
+    "no-new-require": "error",
+    "no-new-symbol": "error",
+    "no-new-wrappers": "error",
+    "no-obj-calls": "error",
+    "no-octal": "error",
+    "no-octal-escape": "error",
+    "no-path-concat": "error",
+    "no-proto": "error",
+    "no-redeclare": ["error", { "builtinGlobals": false }],
+    "no-regex-spaces": "error",
+    "no-return-assign": "off",
+    "no-self-assign": "off",
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-shadow-restricted-names": "error",
+    "no-sparse-arrays": "error",
+    "no-tabs": "error",
+    "no-template-curly-in-string": "error",
+    "no-this-before-super": "error",
+    "no-throw-literal": "off",
+    "no-trailing-spaces": "error",
+    "no-undef": "error",
+    "no-undef-init": "error",
+    "no-unexpected-multiline": "error",
+    "no-unmodified-loop-condition": "error",
+    "no-unneeded-ternary": ["error", { "defaultAssignment": false }],
+    "no-unreachable": "error",
+    "no-unsafe-finally": 0,
+    "no-unsafe-negation": "error",
+    "no-unused-expressions": ["error", { "allowShortCircuit": true, "allowTernary": true, "allowTaggedTemplates": true }],
+    "no-unused-vars": ["error", { "vars": "all", "args": "none", "ignoreRestSiblings": true }],
+    "no-use-before-define": ["error", { "functions": false, "classes": false, "variables": false }],
+    "no-useless-call": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-constructor": "error",
+    "no-useless-escape": "error",
+    "no-useless-rename": "error",
+    "no-useless-return": "error",
+    "no-void": "error",
+    "no-whitespace-before-property": "error",
+    "no-with": "error",
+    "nonblock-statement-body-position": [2, "below"],
+    "object-curly-newline": "off",
+    "object-curly-spacing": "off",
+    "object-property-newline": ["error", { "allowMultiplePropertiesPerLine": true }],
+    "one-var": ["error", { "initialized": "never" }],
+    "operator-linebreak": "off",
+    "padded-blocks": ["error", { "blocks": "never", "switches": "never", "classes": "never" }],
+    "prefer-const": ["error", {"destructuring": "all"}],
+    "prefer-promise-reject-errors": "error",
+    "quote-props": ["error", "as-needed"],
+    "quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": true }],
+    "rest-spread-spacing": ["error", "never"],
+    "semi": ["error", "never"],
+    "semi-spacing": ["error", { "before": false, "after": true }],
+    "space-before-blocks": ["error", "always"],
+    "space-before-function-paren": ["error", "always"],
+    "space-in-parens": ["error", "never"],
+    "space-infix-ops": "error",
+    "space-unary-ops": ["error", { "words": true, "nonwords": false }],
+    "spaced-comment": ["error", "always", {
+      "line": { "markers": ["*package", "!", "/", ",", "="] },
+      "block": { "balanced": true, "markers": ["*package", "!", ",", ":", "::", "flow-include"], "exceptions": ["*"] }
+    }],
+    "symbol-description": "error",
+    "template-curly-spacing": ["error", "never"],
+    "template-tag-spacing": ["error", "never"],
+    "unicode-bom": ["error", "never"],
+    "use-isnan": "error",
+    "valid-typeof": ["error", { "requireStringLiterals": true }],
+    "wrap-iife": ["error", "any", { "functionPrototypeMethods": true }],
+    "yield-star-spacing": ["error", "both"],
+    "yoda": ["error", "never"],
+
+    "import/export": "error",
+    "import/first": "error",
+    "import/no-absolute-path": ["error", { "esmodule": true, "commonjs": true, "amd": false }],
+    "import/no-duplicates": "error",
+    "import/no-named-default": "error",
+    "import/no-webpack-loader-syntax": "error",
+
+    "node/no-deprecated-api": "error",
+    "node/process-exit-as-throw": "error",
+
+    "promise/param-names": "off",
+
+    "standard/no-callback-literal": "error"
+  }
+}

README.md

@@ -1,13 +1,9 @@
 # libnpmpublish
 
-[![npm version](https://img.shields.io/npm/v/libnpmpublish.svg)](https://npm.im/libnpmpublish)
-[![license](https://img.shields.io/npm/l/libnpmpublish.svg)](https://npm.im/libnpmpublish)
-[![GitHub Actions](https://github.com/npm/libnpmpublish/workflows/Node%20CI/badge.svg)](https://github.com/npm/libnpmpublish/actions?query=workflow%3A%22Node+CI%22)
-[![Coverage Status](https://coveralls.io/repos/github/npm/libnpmpublish/badge.svg?branch=latest)](https://coveralls.io/github/npm/libnpmpublish?branch=latest)
-
-[`libnpmpublish`](https://github.com/npm/libnpmpublish) is a Node.js library for
-programmatically publishing and unpublishing npm packages. It takes care
-of packing tarballs from source code and putting it up on a nice registry for you.
+[`libnpmpublish`](https://github.com/npm/libnpmpublish) is a Node.js
+library for programmatically publishing and unpublishing npm packages. Give
+it a manifest as an object and a tarball as a Buffer, and it'll put them on
+the registry for you.
 
 ## Table of Contents
 
@@ -22,7 +18,6 @@ of packing tarballs from source code and putting it up on a nice registry for yo
 
 ```js
 const { publish, unpublish } = require('libnpmpublish')
-
 ```
 
 ## Install
@@ -33,39 +28,58 @@ const { publish, unpublish } = require('libnpmpublish')
 
 #### <a name="opts"></a> `opts` for `libnpmpublish` commands
 
-`libnpmpublish` uses [`npm-registry-fetch`](https://npm.im/npm-registry-fetch).
-Most options are passed through directly to that library, so please refer to
-[its own `opts`
-documentation](https://www.npmjs.com/package/npm-registry-fetch#fetch-options)
-for options that can be passed in.
+`libnpmpublish` uses
+[`npm-registry-fetch`](https://npm.im/npm-registry-fetch).  Most options
+are passed through directly to that library, so please refer to [its own
+`opts` documentation](http://npm.im/npm-registry-fetch#fetch-options) for
+options that can be passed in.
+
+A couple of options of note:
+
+* `opts.defaultTag` - registers the published package with the given tag,
+  defaults to `latest`.
 
-A couple of options of note for those in a hurry:
-* `opts.defaultTag` - registers the published package with the given tag, defaults to `latest`.
+* `opts.access` - tells the registry whether this package should be
+  published as public or restricted. Only applies to scoped packages, which
+  default to restricted.
 
-* `opts.access` - tells the registry whether this package should be published as public or restricted. Only applies to scoped packages, which default to restricted.
+* `opts.token` - can be passed in and will be used as the authentication
+  token for the registry. For other ways to pass in auth details, see the
+  n-r-f docs.
 
-* `opts.token` - can be passed in and will be used as the authentication token for the registry. For other ways to pass in auth details, see the n-r-f docs.
+#### <a name="publish"></a> `> libpub.publish(manifest, tarData, [opts]) -> Promise`
 
-#### <a name="publish"></a> `> libpub.publish(path, pkgJson, [opts]) -> Promise`
+Sends the package represented by the `manifest` and `tarData` to the
+configured registry.
 
-Packs a tarball located in `path` and publishes to the appropriate configured registry. `pkgJson` should be
-the parsed `package.json` for the package that is being published.
+`manifest` should be the parsed `package.json` for the package being
+published (which can also be the manifest pulled from a packument, a git
+repo, tarball, etc.)
 
-If `opts.npmVersion` is passed in, it will be used as the `_npmVersion` field in
-the outgoing packument. It's recommended you add your own user agent string in
-there!
+`tarData` is a `Buffer` of the tarball being published.
 
-If `opts.algorithms` is passed in, it should be an array of hashing algorithms
-to generate `integrity` hashes for. The default is `['sha512']`, which means you
-end up with `dist.integrity = 'sha512-deadbeefbadc0ffee'`. Any algorithm
-supported by your current node version is allowed -- npm clients that do not
-support those algorithms will simply ignore the unsupported hashes.
+If `opts.npmVersion` is passed in, it will be used as the `_npmVersion`
+field in the outgoing packument.  You may put your own user-agent string in
+there to identify your publishes.
+
+If `opts.algorithms` is passed in, it should be an array of hashing
+algorithms to generate `integrity` hashes for. The default is `['sha512']`,
+which means you end up with `dist.integrity = 'sha512-deadbeefbadc0ffee'`.
+Any algorithm supported by your current node version is allowed -- npm
+clients that do not support those algorithms will simply ignore the
+unsupported hashes.
 
 ##### Example
 
-```javascript
+```js
+// note that pacote.manifest() and pacote.tarball() can also take
+// any spec that npm can install.  a folder shown here, since that's
+// far and away the most common use case.
 const path = '/a/path/to/your/source/code'
-await libpub.publish(path, {
+const pacote = require('pacote') // see: http://npm.im/pacote
+const manifest = await pacote.manifest(path)
+const tarData = await pacote.tarball(path)
+await libpub.publish(manifest, tarData, {
   npmVersion: '[email protected]',
   token: 'my-auth-token-here'
 }, opts)
@@ -84,15 +98,8 @@ expected. `range` specs will fail silently in most cases.
 
 ##### Example
 
-```javascript
+```js
 await libpub.unpublish('lodash', { token: 'i-am-the-worst'})
 //
-// `lodash` has now been unpublished, along with all its versions, and the world
-// devolves into utter chaos.
-//
-// That, or we all go home to our friends and/or family and have a nice time
-// doing nothing having to do with programming or JavaScript and realize our
-// lives are just so much happier now, and we just can't understand why we ever
-// got so into this JavaScript thing but damn did it pay well. I guess you'll
-// settle for gardening or something.
+// `lodash` has now been unpublished, along with all its versions
 ```

index.js

@@ -1,4 +1,4 @@
 module.exports = {
   publish: require('./publish.js'),
-  unpublish: require('./unpublish.js')
+  unpublish: require('./unpublish.js'),
 }