const util = require('util') const log = require('../utils/log-shim.js') const semver = require('semver') const pack = require('libnpmpack') const libpub = require('libnpmpublish').publish const runScript = require('@npmcli/run-script') const pacote = require('pacote') const npa = require('npm-package-arg') const npmFetch = require('npm-registry-fetch') const replaceInfo = require('../utils/replace-info.js') const otplease = require('../utils/otplease.js') const { getContents, logTar } = require('../utils/tar.js') // for historical reasons, publishConfig in package.json can contain ANY config // keys that npm supports in .npmrc files and elsewhere. We *may* want to // revisit this at some point, and have a minimal set that's a SemVer-major // change that ought to get a RFC written on it. const { flatten } = require('../utils/config/index.js') // this is the only case in the CLI where we want to use the old full slow // 'read-package-json' module, because we want to pull in all the defaults and // metadata, like git sha's and default scripts and all that. const readJson = util.promisify(require('read-package-json')) const BaseCommand = require('../base-command.js') class Publish extends BaseCommand { static description = 'Publish a package' static name = 'publish' static params = [ 'tag', 'access', 'dry-run', 'otp', 'workspace', 'workspaces', 'include-workspace-root', ] static usage = ['<package-spec>'] static ignoreImplicitWorkspace = false async exec (args) { if (args.length === 0) { args = ['.'] } if (args.length !== 1) { throw this.usageError() } log.verbose('publish', replaceInfo(args)) const unicode = this.npm.config.get('unicode') const dryRun = this.npm.config.get('dry-run') const json = this.npm.config.get('json') const defaultTag = this.npm.config.get('tag') const ignoreScripts = this.npm.config.get('ignore-scripts') const { silent } = this.npm if (semver.validRange(defaultTag)) { throw new Error('Tag name must not be a valid SemVer range: ' + defaultTag.trim()) } const opts = { ...this.npm.flatOptions, progress: false } log.disableProgress() // you can publish name@version, ./foo.tgz, etc. // even though the default is the 'file:.' cwd. const spec = npa(args[0]) let manifest = await this.getManifest(spec, opts) // only run scripts for directory type publishes if (spec.type === 'directory' && !ignoreScripts) { await runScript({ event: 'prepublishOnly', path: spec.fetchSpec, stdio: 'inherit', pkg: manifest, banner: !silent, }) } // we pass dryRun: true to libnpmpack so it doesn't write the file to disk const tarballData = await pack(spec, { ...opts, dryRun: true, prefix: this.npm.localPrefix, workspaces: this.workspacePaths, }) const pkgContents = await getContents(manifest, tarballData) // The purpose of re-reading the manifest is in case it changed, // so that we send the latest and greatest thing to the registry // note that publishConfig might have changed as well! manifest = await this.getManifest(spec, opts) // JSON already has the package contents if (!json) { logTar(pkgContents, { unicode }) } const resolved = npa.resolve(manifest.name, manifest.version) const registry = npmFetch.pickRegistry(resolved, opts) const creds = this.npm.config.getCredentialsByURI(registry) const noCreds = !(creds.token || creds.username || creds.certfile && creds.keyfile) const outputRegistry = replaceInfo(registry) if (noCreds) { const msg = `This command requires you to be logged in to ${outputRegistry}` if (dryRun) { log.warn('', `${msg} (dry-run)`) } else { throw Object.assign(new Error(msg), { code: 'ENEEDAUTH' }) } } log.notice('', `Publishing to ${outputRegistry}${dryRun ? ' (dry-run)' : ''}`) if (!dryRun) { await otplease(this.npm, opts, opts => libpub(manifest, tarballData, opts)) } if (spec.type === 'directory' && !ignoreScripts) { await runScript({ event: 'publish', path: spec.fetchSpec, stdio: 'inherit', pkg: manifest, banner: !silent, }) await runScript({ event: 'postpublish', path: spec.fetchSpec, stdio: 'inherit', pkg: manifest, banner: !silent, }) } if (!this.suppressOutput) { if (!silent && json) { this.npm.output(JSON.stringify(pkgContents, null, 2)) } else if (!silent) { this.npm.output(`+ ${pkgContents.id}`) } } return pkgContents } async execWorkspaces (args, filters) { // Suppresses JSON output in publish() so we can handle it here this.suppressOutput = true const results = {} const json = this.npm.config.get('json') const { silent } = this.npm await this.setWorkspaces(filters) for (const [name, workspace] of this.workspaces.entries()) { let pkgContents try { pkgContents = await this.exec([workspace]) } catch (err) { if (err.code === 'EPRIVATE') { log.warn( 'publish', `Skipping workspace ${ this.npm.chalk.green(name) }, marked as ${ this.npm.chalk.bold('private') }` ) continue } throw err } // This needs to be in-line w/ the rest of the output that non-JSON // publish generates if (!silent && !json) { this.npm.output(`+ ${pkgContents.id}`) } else { results[name] = pkgContents } } if (!silent && json) { this.npm.output(JSON.stringify(results, null, 2)) } } // if it's a directory, read it from the file system // otherwise, get the full metadata from whatever it is // XXX can't pacote read the manifest from a directory? async getManifest (spec, opts) { let manifest if (spec.type === 'directory') { manifest = await readJson(`${spec.fetchSpec}/package.json`) } else { manifest = await pacote.manifest(spec, { ...opts, fullmetadata: true, fullReadJson: true, }) } if (manifest.publishConfig) { flatten(manifest.publishConfig, opts) } return manifest } } module.exports = Publish
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
access.js | File | 5.45 KB | 0644 |
|
adduser.js | File | 2.2 KB | 0644 |
|
audit.js | File | 11.95 KB | 0644 |
|
bin.js | File | 729 B | 0644 |
|
birthday.js | File | 508 B | 0644 |
|
bugs.js | File | 815 B | 0644 |
|
cache.js | File | 7.08 KB | 0644 |
|
ci.js | File | 3.63 KB | 0644 |
|
completion.js | File | 8.91 KB | 0644 |
|
config.js | File | 8.11 KB | 0644 |
|
dedupe.js | File | 1.37 KB | 0644 |
|
deprecate.js | File | 2.06 KB | 0644 |
|
diff.js | File | 8.1 KB | 0644 |
|
dist-tag.js | File | 5.47 KB | 0644 |
|
docs.js | File | 447 B | 0644 |
|
doctor.js | File | 9.22 KB | 0644 |
|
edit.js | File | 2 KB | 0644 |
|
exec.js | File | 2.44 KB | 0644 |
|
explain.js | File | 3.55 KB | 0644 |
|
explore.js | File | 2.33 KB | 0644 |
|
find-dupes.js | File | 602 B | 0644 |
|
fund.js | File | 6.37 KB | 0644 |
|
get.js | File | 524 B | 0644 |
|
help-search.js | File | 5.62 KB | 0644 |
|
help.js | File | 4.53 KB | 0644 |
|
hook.js | File | 3.93 KB | 0644 |
|
init.js | File | 6.81 KB | 0644 |
|
install-ci-test.js | File | 377 B | 0644 |
|
install-test.js | File | 374 B | 0644 |
|
install.js | File | 5.11 KB | 0644 |
|
link.js | File | 5.02 KB | 0644 |
|
ll.js | File | 234 B | 0644 |
|
logout.js | File | 1.34 KB | 0644 |
|
ls.js | File | 16.94 KB | 0644 |
|
org.js | File | 4.2 KB | 0644 |
|
outdated.js | File | 8.84 KB | 0644 |
|
owner.js | File | 5.88 KB | 0644 |
|
pack.js | File | 2.36 KB | 0644 |
|
ping.js | File | 874 B | 0644 |
|
pkg.js | File | 3.47 KB | 0644 |
|
prefix.js | File | 343 B | 0644 |
|
profile.js | File | 11.25 KB | 0644 |
|
prune.js | File | 779 B | 0644 |
|
publish.js | File | 6.33 KB | 0644 |
|
query.js | File | 2.81 KB | 0644 |
|
rebuild.js | File | 2.16 KB | 0644 |
|
repo.js | File | 1.24 KB | 0644 |
|
restart.js | File | 351 B | 0644 |
|
root.js | File | 298 B | 0644 |
|
run-script.js | File | 6.9 KB | 0644 |
|
search.js | File | 2.72 KB | 0644 |
|
set-script.js | File | 2.63 KB | 0644 |
|
set.js | File | 572 B | 0644 |
|
shrinkwrap.js | File | 2.64 KB | 0644 |
|
star.js | File | 1.87 KB | 0644 |
|
stars.js | File | 1.03 KB | 0644 |
|
start.js | File | 341 B | 0644 |
|
stop.js | File | 336 B | 0644 |
|
team.js | File | 4.44 KB | 0644 |
|
test.js | File | 336 B | 0644 |
|
token.js | File | 6.79 KB | 0644 |
|
uninstall.js | File | 1.52 KB | 0644 |
|
unpublish.js | File | 4.51 KB | 0644 |
|
unstar.js | File | 182 B | 0644 |
|
update.js | File | 1.7 KB | 0644 |
|
version.js | File | 3.6 KB | 0644 |
|
view.js | File | 14.38 KB | 0644 |
|
whoami.js | File | 514 B | 0644 |
|