File Explorer

1const { output } = require('proc-log')2const PackageJson = require('@npmcli/package-json')3const BaseCommand = require('../base-cmd.js')4const Queryable = require('../utils/queryable.js')5 6class Pkg extends BaseCommand {7  static description = 'Manages your package.json'8  static name = 'pkg'9  static usage = [10    'set <key>=<value> [<key>=<value> ...]',11    'get [<key> [<key> ...]]',12    'delete <key> [<key> ...]',13    'set [<array>[<index>].<key>=<value> ...]',14    'set [<array>[].<key>=<value> ...]',15    'fix',16  ]17 18  static params = [19    'force',20    'json',21    'workspace',22    'workspaces',23  ]24 25  static workspaces = true26  static ignoreImplicitWorkspace = false27 28  async exec (args, { path = this.npm.localPrefix, workspace } = {}) {29    if (this.npm.global) {30      throw Object.assign(31        new Error(`There's no package.json file to manage on global mode`),32        { code: 'EPKGGLOBAL' }33      )34    }35 36    const [cmd, ..._args] = args37    switch (cmd) {38      case 'get':39        return this.get(_args, { path, workspace })40      case 'set':41        return this.set(_args, { path, workspace }).then(p => p.save())42      case 'delete':43        return this.delete(_args, { path, workspace }).then(p => p.save())44      case 'fix':45        return PackageJson.fix(path).then(p => p.save())46      default:47        throw this.usageError()48    }49  }50 51  async execWorkspaces (args) {52    await this.setWorkspaces()53    for (const [workspace, path] of this.workspaces.entries()) {54      await this.exec(args, { path, workspace })55    }56  }57 58  async get (args, { path, workspace }) {59    this.npm.config.set('json', true)60    const pkgJson = await PackageJson.load(path)61 62    let result = pkgJson.content63 64    if (args.length) {65      result = new Queryable(result).query(args)66      // in case there's only a single argument and a single result from the query67      // just prints that one element to stdout.68      // TODO(BREAKING_CHANGE): much like other places where we unwrap single69      // item arrays this should go away. it makes the behavior unknown for users70      // who don't already know the shape of the data.71      if (Object.keys(result).length === 1 && args.length === 1) {72        result = result[args]73      }74    }75 76    // The display layer is responsible for calling JSON.stringify on the result77    // TODO: https://github.com/npm/cli/issues/5508 a raw mode has been requested similar78    // to jq -r. If that was added then this method should no longer set `json:true` all the time79    output.buffer(workspace ? { [workspace]: result } : result)80  }81 82  async set (args, { path }) {83    const setError = () =>84      this.usageError('npm pkg set expects a key=value pair of args.')85 86    if (!args.length) {87      throw setError()88    }89 90    const force = this.npm.config.get('force')91    const json = this.npm.config.get('json')92    const pkgJson = await PackageJson.load(path)93    const q = new Queryable(pkgJson.content)94    for (const arg of args) {95      const [key, ...rest] = arg.split('=')96      const value = rest.join('=')97      if (!key || !value) {98        throw setError()99      }100 101      q.set(key, json ? JSON.parse(value) : value, { force })102    }103 104    return pkgJson.update(q.toJSON())105  }106 107  async delete (args, { path }) {108    const setError = () =>109      this.usageError('npm pkg delete expects key args.')110 111    if (!args.length) {112      throw setError()113    }114 115    const pkgJson = await PackageJson.load(path)116    const q = new Queryable(pkgJson.content)117    for (const key of args) {118      if (!key) {119        throw setError()120      }121 122      q.delete(key)123    }124 125    return pkgJson.update(q.toJSON())126  }127}128 129module.exports = Pkg130