const PackageJson = require('@npmcli/package-json') const BaseCommand = require('../base-command.js') const Queryable = require('../utils/queryable.js') class Pkg extends BaseCommand { static description = 'Manages your package.json' static name = 'pkg' static usage = [ 'set <key>=<value> [<key>=<value> ...]', 'get [<key> [<key> ...]]', 'delete <key> [<key> ...]', 'set [<array>[<index>].<key>=<value> ...]', 'set [<array>[].<key>=<value> ...]', ] static params = [ 'force', 'json', 'workspace', 'workspaces', ] static ignoreImplicitWorkspace = false async exec (args, { prefix } = {}) { if (!prefix) { this.prefix = this.npm.localPrefix } else { this.prefix = prefix } if (this.npm.global) { throw Object.assign( new Error(`There's no package.json file to manage on global mode`), { code: 'EPKGGLOBAL' } ) } const [cmd, ..._args] = args switch (cmd) { case 'get': return this.get(_args) case 'set': return this.set(_args) case 'delete': return this.delete(_args) default: throw this.usageError() } } async execWorkspaces (args, filters) { await this.setWorkspaces(filters) const result = {} for (const [workspaceName, workspacePath] of this.workspaces.entries()) { this.prefix = workspacePath result[workspaceName] = await this.exec(args, { prefix: workspacePath }) } // when running in workspaces names, make sure to key by workspace // name the results of each value retrieved in each ws this.npm.output(JSON.stringify(result, null, 2)) } async get (args) { const pkgJson = await PackageJson.load(this.prefix) const { content } = pkgJson let result = !args.length && content if (!result) { const q = new Queryable(content) result = q.query(args) // in case there's only a single result from the query // just prints that one element to stdout if (Object.keys(result).length === 1) { result = result[args] } } // only outputs if not running with workspaces config, // in case you're retrieving info for workspaces the pkgWorkspaces // will handle the output to make sure it get keyed by ws name if (!this.workspaces) { this.npm.output(JSON.stringify(result, null, 2)) } return result } async set (args) { const setError = () => this.usageError('npm pkg set expects a key=value pair of args.') if (!args.length) { throw setError() } const force = this.npm.config.get('force') const json = this.npm.config.get('json') const pkgJson = await PackageJson.load(this.prefix) const q = new Queryable(pkgJson.content) for (const arg of args) { const [key, ...rest] = arg.split('=') const value = rest.join('=') if (!key || !value) { throw setError() } q.set(key, json ? JSON.parse(value) : value, { force }) } pkgJson.update(q.toJSON()) await pkgJson.save() } async delete (args) { const setError = () => this.usageError('npm pkg delete expects key args.') if (!args.length) { throw setError() } const pkgJson = await PackageJson.load(this.prefix) const q = new Queryable(pkgJson.content) for (const key of args) { if (!key) { throw setError() } q.delete(key) } pkgJson.update(q.toJSON()) await pkgJson.save() } } module.exports = Pkg
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 |
|