File Explorer

1const pkgJson = require('@npmcli/package-json')2const runScript = require('@npmcli/run-script')3const { join, relative } = require('node:path')4const { log, output } = require('proc-log')5const completion = require('../utils/installed-shallow.js')6const BaseCommand = require('../base-cmd.js')7 8// npm explore <pkg>[@<version>]9// open a subshell to the package folder.10class Explore extends BaseCommand {11  static description = 'Browse an installed package'12  static name = 'explore'13  static usage = ['<pkg> [ -- <command>]']14  static params = ['shell']15  static ignoreImplicitWorkspace = false16 17  static async completion (opts, npm) {18    return completion(npm, opts)19  }20 21  async exec (args) {22    if (args.length < 1 || !args[0]) {23      throw this.usageError()24    }25 26    const pkgname = args.shift()27 28    // detect and prevent any .. shenanigans29    const path = join(this.npm.dir, join('/', pkgname))30    if (relative(path, this.npm.dir) === '') {31      throw this.usageError()32    }33 34    // run as if running a script named '_explore', which we set to either35    // the set of arguments, or the shell config, and let @npmcli/run-script36    // handle all the escaping and PATH setup stuff.37 38    const { content: pkg } = await pkgJson.normalize(path).catch(er => {39      log.error('explore', `It doesn't look like ${pkgname} is installed.`)40      throw er41    })42 43    const { shell } = this.npm.flatOptions44    pkg.scripts = {45      ...(pkg.scripts || {}),46      _explore: args.join(' ').trim() || shell,47    }48 49    if (!args.length) {50      output.standard(`\nExploring ${path}\nType 'exit' or ^D when finished\n`)51    }52 53    return runScript({54      ...this.npm.flatOptions,55      pkg,56      path,57      event: '_explore',58      stdio: 'inherit',59    }).catch(er => {60      process.exitCode = typeof er.code === 'number' && er.code !== 0 ? er.code61        : 162        // if it's not an exit error, or non-interactive, throw it63      const isProcExit = er.message === 'command failed' &&64          (typeof er.code === 'number' || /^SIG/.test(er.signal || ''))65      if (args.length || !isProcExit) {66        throw er67      }68    })69  }70}71 72module.exports = Explore73