/* eslint-disable camelcase */
const fs = require('fs')
const util = require('util')
const readdir = util.promisify(fs.readdir)
const reifyFinish = require('../utils/reify-finish.js')
const log = require('../utils/log-shim.js')
const { resolve, join } = require('path')
const Arborist = require('@npmcli/arborist')
const runScript = require('@npmcli/run-script')
const pacote = require('pacote')
const checks = require('npm-install-checks')
const ArboristWorkspaceCmd = require('../arborist-cmd.js')
class Install extends ArboristWorkspaceCmd {
static description = 'Install a package'
static name = 'install'
// These are in the order they will show up in when running "-h"
static params = [
'save',
'save-exact',
'global',
'install-strategy',
'legacy-bundling',
'global-style',
'omit',
'strict-peer-deps',
'package-lock',
'foreground-scripts',
'ignore-scripts',
'audit',
'bin-links',
'fund',
'dry-run',
...super.params,
]
static usage = ['[<package-spec> ...]']
async completion (opts) {
const { partialWord } = opts
// install can complete to a folder with a package.json, or any package.
// if it has a slash, then it's gotta be a folder
// if it starts with https?://, then just give up, because it's a url
if (/^https?:\/\//.test(partialWord)) {
// do not complete to URLs
return []
}
if (/\//.test(partialWord)) {
// Complete fully to folder if there is exactly one match and it
// is a folder containing a package.json file. If that is not the
// case we return 0 matches, which will trigger the default bash
// complete.
const lastSlashIdx = partialWord.lastIndexOf('/')
const partialName = partialWord.slice(lastSlashIdx + 1)
const partialPath = partialWord.slice(0, lastSlashIdx) || '/'
const isDirMatch = async sibling => {
if (sibling.slice(0, partialName.length) !== partialName) {
return false
}
try {
const contents = await readdir(join(partialPath, sibling))
const result = (contents.indexOf('package.json') !== -1)
return result
} catch (er) {
return false
}
}
try {
const siblings = await readdir(partialPath)
const matches = []
for (const sibling of siblings) {
if (await isDirMatch(sibling)) {
matches.push(sibling)
}
}
if (matches.length === 1) {
return [join(partialPath, matches[0])]
}
// no matches
return []
} catch (er) {
return [] // invalid dir: no matching
}
}
// Note: there used to be registry completion here,
// but it stopped making sense somewhere around
// 50,000 packages on the registry
}
async exec (args) {
// the /path/to/node_modules/..
const globalTop = resolve(this.npm.globalDir, '..')
const ignoreScripts = this.npm.config.get('ignore-scripts')
const isGlobalInstall = this.npm.global
const where = isGlobalInstall ? globalTop : this.npm.prefix
const forced = this.npm.config.get('force')
const scriptShell = this.npm.config.get('script-shell') || undefined
// be very strict about engines when trying to update npm itself
const npmInstall = args.find(arg => arg.startsWith('npm@') || arg === 'npm')
if (isGlobalInstall && npmInstall) {
const npmOptions = this.npm.flatOptions
const npmManifest = await pacote.manifest(npmInstall, npmOptions)
try {
checks.checkEngine(npmManifest, npmManifest.version, process.version)
} catch (e) {
if (forced) {
log.warn(
'install',
/* eslint-disable-next-line max-len */
`Forcing global npm install with incompatible version ${npmManifest.version} into node ${process.version}`
)
} else {
throw e
}
}
}
// don't try to install the prefix into itself
args = args.filter(a => resolve(a) !== this.npm.prefix)
// `npm i -g` => "install this package globally"
if (where === globalTop && !args.length) {
args = ['.']
}
// throw usage error if trying to install empty package
// name to global space, e.g: `npm i -g ""`
if (where === globalTop && !args.every(Boolean)) {
throw this.usageError()
}
const opts = {
...this.npm.flatOptions,
auditLevel: null,
path: where,
add: args,
workspaces: this.workspaceNames,
}
const arb = new Arborist(opts)
await arb.reify(opts)
if (!args.length && !isGlobalInstall && !ignoreScripts) {
const scripts = [
'preinstall',
'install',
'postinstall',
'prepublish', // XXX(npm9) should we remove this finally??
'preprepare',
'prepare',
'postprepare',
]
for (const event of scripts) {
await runScript({
path: where,
args: [],
scriptShell,
stdio: 'inherit',
banner: !this.npm.silent,
event,
})
}
}
await reifyFinish(this.npm, arb)
}
}
module.exports = Install
| Name | Type | Size | Permission | Actions |
|---|---|---|---|---|
| access.js | File | 6.08 KB | 0644 |
|
| adduser.js | File | 1.32 KB | 0644 |
|
| audit.js | File | 13.86 KB | 0644 |
|
| bugs.js | File | 815 B | 0644 |
|
| cache.js | File | 7.07 KB | 0644 |
|
| ci.js | File | 3.51 KB | 0644 |
|
| completion.js | File | 8.73 KB | 0644 |
|
| config.js | File | 10.04 KB | 0644 |
|
| dedupe.js | File | 1.4 KB | 0644 |
|
| deprecate.js | File | 2.03 KB | 0644 |
|
| diff.js | File | 8.12 KB | 0644 |
|
| dist-tag.js | File | 5.45 KB | 0644 |
|
| docs.js | File | 447 B | 0644 |
|
| doctor.js | File | 11.51 KB | 0644 |
|
| edit.js | File | 2 KB | 0644 |
|
| exec.js | File | 2.54 KB | 0644 |
|
| explain.js | File | 3.55 KB | 0644 |
|
| explore.js | File | 2.3 KB | 0644 |
|
| find-dupes.js | File | 622 B | 0644 |
|
| fund.js | File | 6.51 KB | 0644 |
|
| get.js | File | 524 B | 0644 |
|
| help-search.js | File | 5.49 KB | 0644 |
|
| help.js | File | 3.54 KB | 0644 |
|
| hook.js | File | 3.77 KB | 0644 |
|
| init.js | File | 6.9 KB | 0644 |
|
| install-ci-test.js | File | 373 B | 0644 |
|
| install-test.js | File | 370 B | 0644 |
|
| install.js | File | 5.11 KB | 0644 |
|
| link.js | File | 5.15 KB | 0644 |
|
| ll.js | File | 234 B | 0644 |
|
| login.js | File | 1.32 KB | 0644 |
|
| logout.js | File | 1.3 KB | 0644 |
|
| ls.js | File | 16.73 KB | 0644 |
|
| org.js | File | 4.14 KB | 0644 |
|
| outdated.js | File | 8.76 KB | 0644 |
|
| owner.js | File | 5.91 KB | 0644 |
|
| pack.js | File | 2.37 KB | 0644 |
|
| ping.js | File | 917 B | 0644 |
|
| pkg.js | File | 3.5 KB | 0644 |
|
| prefix.js | File | 303 B | 0644 |
|
| profile.js | File | 11.19 KB | 0644 |
|
| prune.js | File | 779 B | 0644 |
|
| publish.js | File | 6.5 KB | 0644 |
|
| query.js | File | 2.9 KB | 0644 |
|
| rebuild.js | File | 2.14 KB | 0644 |
|
| repo.js | File | 1.24 KB | 0644 |
|
| restart.js | File | 310 B | 0644 |
|
| root.js | File | 258 B | 0644 |
|
| run-script.js | File | 6.81 KB | 0644 |
|
| search.js | File | 2.68 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 | 300 B | 0644 |
|
| stop.js | File | 295 B | 0644 |
|
| team.js | File | 4.44 KB | 0644 |
|
| test.js | File | 295 B | 0644 |
|
| token.js | File | 6.64 KB | 0644 |
|
| uninstall.js | File | 1.51 KB | 0644 |
|
| unpublish.js | File | 4.54 KB | 0644 |
|
| unstar.js | File | 182 B | 0644 |
|
| update.js | File | 1.71 KB | 0644 |
|
| version.js | File | 3.58 KB | 0644 |
|
| view.js | File | 14.38 KB | 0644 |
|
| whoami.js | File | 474 B | 0644 |
|