2021-03-11 17:54:23 -05:00
|
|
|
// Base class for npm.commands[cmd]
|
|
|
|
const usageUtil = require('./utils/usage.js')
|
2021-03-23 14:58:11 -04:00
|
|
|
const ConfigDefinitions = require('./utils/config/definitions.js')
|
2021-03-11 17:54:23 -05:00
|
|
|
|
|
|
|
class BaseCommand {
|
|
|
|
constructor (npm) {
|
|
|
|
this.npm = npm
|
|
|
|
}
|
|
|
|
|
2021-03-23 14:58:11 -04:00
|
|
|
get name () {
|
|
|
|
return this.constructor.name
|
|
|
|
}
|
|
|
|
|
|
|
|
get description () {
|
|
|
|
return this.constructor.description
|
|
|
|
}
|
|
|
|
|
2021-03-11 17:54:23 -05:00
|
|
|
get usage () {
|
|
|
|
let usage = `npm ${this.constructor.name}\n\n`
|
|
|
|
if (this.constructor.description)
|
|
|
|
usage = `${usage}${this.constructor.description}\n\n`
|
|
|
|
|
|
|
|
usage = `${usage}Usage:\n`
|
|
|
|
if (!this.constructor.usage)
|
|
|
|
usage = `${usage}npm ${this.constructor.name}`
|
|
|
|
else
|
|
|
|
usage = `${usage}${this.constructor.usage.map(u => `npm ${this.constructor.name} ${u}`).join('\n')}`
|
|
|
|
|
2021-03-23 14:58:11 -04:00
|
|
|
if (this.constructor.params)
|
2021-04-01 17:27:18 -04:00
|
|
|
// TODO word wrap this along params boundaries
|
2021-03-23 14:58:11 -04:00
|
|
|
usage = `${usage}\n\nOptions:\n[${this.constructor.params.map(p => ConfigDefinitions[p].usage).join('] [')}]`
|
|
|
|
|
2021-03-11 17:54:23 -05:00
|
|
|
// Mostly this just appends aliases, this could be more clear
|
|
|
|
usage = usageUtil(this.constructor.name, usage)
|
|
|
|
usage = `${usage}\n\nRun "npm help ${this.constructor.name}" for more info`
|
|
|
|
return usage
|
|
|
|
}
|
|
|
|
|
|
|
|
usageError (msg) {
|
|
|
|
if (!msg) {
|
|
|
|
return Object.assign(new Error(`\nUsage: ${this.usage}`), {
|
|
|
|
code: 'EUSAGE',
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
return Object.assign(new Error(`\nUsage: ${msg}\n\n${this.usage}`), {
|
|
|
|
code: 'EUSAGE',
|
|
|
|
})
|
|
|
|
}
|
2021-03-23 14:58:11 -04:00
|
|
|
|
|
|
|
execWorkspaces (args, filters, cb) {
|
|
|
|
throw Object.assign(
|
|
|
|
new Error('This command does not support workspaces.'),
|
|
|
|
{ code: 'ENOWORKSPACES' }
|
|
|
|
)
|
|
|
|
}
|
2021-03-11 17:54:23 -05:00
|
|
|
}
|
|
|
|
module.exports = BaseCommand
|