1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
|
// Base class for npm commands
const { relative } = require('path')
const ConfigDefinitions = require('./utils/config/definitions.js')
const getWorkspaces = require('./workspaces/get-workspaces.js')
const cmdAliases = require('./utils/cmd-list').aliases
class BaseCommand {
constructor (npm) {
this.wrapWidth = 80
this.npm = npm
if (!this.skipConfigValidation) {
this.npm.config.validate()
}
}
get name () {
return this.constructor.name
}
get description () {
return this.constructor.description
}
get ignoreImplicitWorkspace () {
return this.constructor.ignoreImplicitWorkspace
}
get skipConfigValidation () {
return this.constructor.skipConfigValidation
}
get usage () {
const usage = [
`${this.constructor.description}`,
'',
'Usage:',
]
if (!this.constructor.usage) {
usage.push(`npm ${this.constructor.name}`)
} else {
usage.push(...this.constructor.usage.map(u => `npm ${this.constructor.name} ${u}`))
}
if (this.constructor.params) {
usage.push('')
usage.push('Options:')
usage.push(this.wrappedParams)
}
const aliases = Object.keys(cmdAliases).reduce((p, c) => {
if (cmdAliases[c] === this.constructor.name) {
p.push(c)
}
return p
}, [])
if (aliases.length === 1) {
usage.push('')
usage.push(`alias: ${aliases.join(', ')}`)
} else if (aliases.length > 1) {
usage.push('')
usage.push(`aliases: ${aliases.join(', ')}`)
}
usage.push('')
usage.push(`Run "npm help ${this.constructor.name}" for more info`)
return usage.join('\n')
}
get wrappedParams () {
let results = ''
let line = ''
for (const param of this.constructor.params) {
const usage = `[${ConfigDefinitions[param].usage}]`
if (line.length && line.length + usage.length > this.wrapWidth) {
results = [results, line].filter(Boolean).join('\n')
line = ''
}
line = [line, usage].filter(Boolean).join(' ')
}
results = [results, line].filter(Boolean).join('\n')
return results
}
usageError (prefix = '') {
if (prefix) {
prefix += '\n\n'
}
return Object.assign(new Error(`\n${prefix}${this.usage}`), {
code: 'EUSAGE',
})
}
async execWorkspaces (args, filters) {
throw Object.assign(new Error('This command does not support workspaces.'), {
code: 'ENOWORKSPACES',
})
}
async setWorkspaces (filters) {
if (this.isArboristCmd) {
this.includeWorkspaceRoot = false
}
const relativeFrom = relative(this.npm.localPrefix, process.cwd()).startsWith('..')
? this.npm.localPrefix
: process.cwd()
const ws = await getWorkspaces(filters, {
path: this.npm.localPrefix,
includeWorkspaceRoot: this.includeWorkspaceRoot,
relativeFrom,
})
this.workspaces = ws
this.workspaceNames = [...ws.keys()]
this.workspacePaths = [...ws.values()]
}
}
module.exports = BaseCommand
|