Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
access.js	5.45 KB	-rw-r--r--	2023-08-08 22:32
adduser.js	2.2 KB	-rw-r--r--	2023-08-08 22:32
audit.js	11.95 KB	-rw-r--r--	2023-08-08 22:32
bin.js	729 B	-rw-r--r--	2023-08-08 22:32
birthday.js	508 B	-rw-r--r--	2023-08-08 22:32
bugs.js	815 B	-rw-r--r--	2023-08-08 22:32
cache.js	7.08 KB	-rw-r--r--	2023-08-08 22:32
ci.js	3.63 KB	-rw-r--r--	2023-08-08 22:32
completion.js	8.91 KB	-rw-r--r--	2023-08-08 22:32
config.js	8.11 KB	-rw-r--r--	2023-08-08 22:32
dedupe.js	1.37 KB	-rw-r--r--	2023-08-08 22:32
deprecate.js	2.06 KB	-rw-r--r--	2023-08-08 22:32
diff.js	8.1 KB	-rw-r--r--	2023-08-08 22:32
dist-tag.js	5.47 KB	-rw-r--r--	2023-08-08 22:32
docs.js	447 B	-rw-r--r--	2023-08-08 22:32
doctor.js	9.22 KB	-rw-r--r--	2023-08-08 22:32
edit.js	2 KB	-rw-r--r--	2023-08-08 22:32
exec.js	2.44 KB	-rw-r--r--	2023-08-08 22:32
explain.js	3.55 KB	-rw-r--r--	2023-08-08 22:32
explore.js	2.33 KB	-rw-r--r--	2023-08-08 22:32
find-dupes.js	602 B	-rw-r--r--	2023-08-08 22:32
fund.js	6.37 KB	-rw-r--r--	2023-08-08 22:32
get.js	524 B	-rw-r--r--	2023-08-08 22:32
help-search.js	5.62 KB	-rw-r--r--	2023-08-08 22:32
help.js	4.53 KB	-rw-r--r--	2023-08-08 22:32
hook.js	3.93 KB	-rw-r--r--	2023-08-08 22:32
init.js	6.81 KB	-rw-r--r--	2023-08-08 22:32
install-ci-test.js	377 B	-rw-r--r--	2023-08-08 22:32
install-test.js	374 B	-rw-r--r--	2023-08-08 22:32
install.js	5.11 KB	-rw-r--r--	2023-08-08 22:32
link.js	5.02 KB	-rw-r--r--	2023-08-08 22:32
ll.js	234 B	-rw-r--r--	2023-08-08 22:32
logout.js	1.34 KB	-rw-r--r--	2023-08-08 22:32
ls.js	16.94 KB	-rw-r--r--	2023-08-08 22:32
org.js	4.2 KB	-rw-r--r--	2023-08-08 22:32
outdated.js	8.84 KB	-rw-r--r--	2023-08-08 22:32
owner.js	5.88 KB	-rw-r--r--	2023-08-08 22:32
pack.js	2.36 KB	-rw-r--r--	2023-08-08 22:32
ping.js	874 B	-rw-r--r--	2023-08-08 22:32
pkg.js	3.47 KB	-rw-r--r--	2023-08-08 22:32
prefix.js	343 B	-rw-r--r--	2023-08-08 22:32
profile.js	11.25 KB	-rw-r--r--	2023-08-08 22:32
prune.js	779 B	-rw-r--r--	2023-08-08 22:32
publish.js	6.33 KB	-rw-r--r--	2023-08-08 22:32
query.js	2.81 KB	-rw-r--r--	2023-08-08 22:32
rebuild.js	2.16 KB	-rw-r--r--	2023-08-08 22:32
repo.js	1.24 KB	-rw-r--r--	2023-08-08 22:32
restart.js	351 B	-rw-r--r--	2023-08-08 22:32
root.js	298 B	-rw-r--r--	2023-08-08 22:32
run-script.js	6.9 KB	-rw-r--r--	2023-08-08 22:32
search.js	2.72 KB	-rw-r--r--	2023-08-08 22:32
set-script.js	2.63 KB	-rw-r--r--	2023-08-08 22:32
set.js	572 B	-rw-r--r--	2023-08-08 22:32
shrinkwrap.js	2.64 KB	-rw-r--r--	2023-08-08 22:32
star.js	1.87 KB	-rw-r--r--	2023-08-08 22:32
stars.js	1.03 KB	-rw-r--r--	2023-08-08 22:32
start.js	341 B	-rw-r--r--	2023-08-08 22:32
stop.js	336 B	-rw-r--r--	2023-08-08 22:32
team.js	4.44 KB	-rw-r--r--	2023-08-08 22:32
test.js	336 B	-rw-r--r--	2023-08-08 22:32
token.js	6.79 KB	-rw-r--r--	2023-08-08 22:32
uninstall.js	1.52 KB	-rw-r--r--	2023-08-08 22:32
unpublish.js	4.51 KB	-rw-r--r--	2023-08-08 22:32
unstar.js	182 B	-rw-r--r--	2023-08-08 22:32
update.js	1.7 KB	-rw-r--r--	2023-08-08 22:32
version.js	3.6 KB	-rw-r--r--	2023-08-08 22:32
view.js	14.38 KB	-rw-r--r--	2023-08-08 22:32
whoami.js	514 B	-rw-r--r--	2023-08-08 22:32

Rename

const { spawn } = require('child_process')
const path = require('path')
const openUrl = require('../utils/open-url.js')
const { promisify } = require('util')
const glob = promisify(require('glob'))
const localeCompare = require('@isaacs/string-locale-compare')('en')

const globify = pattern => pattern.split('\\').join('/')
const BaseCommand = require('../base-command.js')

// Strips out the number from foo.7 or foo.7. or foo.7.tgz
// We don't currently compress our man pages but if we ever did this would
// seemlessly continue supporting it
const manNumberRegex = /\.(\d+)(\.[^/\\]*)?$/
// Searches for the "npm-" prefix in page names, to prefer those.
const manNpmPrefixRegex = /\/npm-/

class Help extends BaseCommand {
  static description = 'Get help on npm'
  static name = 'help'
  static usage = ['<term> [<terms..>]']
  static params = ['viewer']
  static ignoreImplicitWorkspace = true

async completion (opts) {
    if (opts.conf.argv.remain.length > 2) {
      return []
    }
    const g = path.resolve(__dirname, '../../man/man[0-9]/*.[0-9]')
    const files = await glob(globify(g))

return Object.keys(files.reduce(function (acc, file) {
      file = path.basename(file).replace(/\.[0-9]+$/, '')
      file = file.replace(/^npm-/, '')
      acc[file] = true
      return acc
    }, { help: true }))
  }

async exec (args) {
    // By default we search all of our man subdirectories, but if the user has
    // asked for a specific one we limit the search to just there
    let manSearch = 'man*'
    if (/^\d+$/.test(args[0])) {
      manSearch = `man${args.shift()}`
    }

if (!args.length) {
      return this.npm.output(await this.npm.usage)
    }

// npm help foo bar baz: search topics
    if (args.length > 1) {
      return this.helpSearch(args)
    }

let section = this.npm.deref(args[0]) || args[0]

// support `npm help package.json`
    section = section.replace('.json', '-json')

const manroot = path.resolve(__dirname, '..', '..', 'man')
    // find either section.n or npm-section.n
    const f = `${manroot}/${manSearch}/?(npm-)${section}.[0-9]*`
    let mans = await glob(globify(f))
    mans = mans.sort((a, b) => {
      // Prefer the page with an npm prefix, if there's only one.
      const aHasPrefix = manNpmPrefixRegex.test(a)
      const bHasPrefix = manNpmPrefixRegex.test(b)
      if (aHasPrefix !== bHasPrefix) {
        return aHasPrefix ? -1 : 1
      }

// Because the glob is (subtly) different from manNumberRegex,
      // we can't rely on it passing.
      const aManNumberMatch = a.match(manNumberRegex)
      const bManNumberMatch = b.match(manNumberRegex)
      if (aManNumberMatch) {
        if (!bManNumberMatch) {
          return -1
        }
        // man number sort first so that 1 aka commands are preferred
        if (aManNumberMatch[1] !== bManNumberMatch[1]) {
          return aManNumberMatch[1] - bManNumberMatch[1]
        }
      } else if (bManNumberMatch) {
        return 1
      }

return localeCompare(a, b)
    })
    const man = mans[0]

if (man) {
      await this.viewMan(man)
    } else {
      return this.helpSearch(args)
    }
  }

helpSearch (args) {
    return this.npm.exec('help-search', args)
  }

async viewMan (man) {
    const env = {}
    Object.keys(process.env).forEach(function (i) {
      env[i] = process.env[i]
    })
    const viewer = this.npm.config.get('viewer')

const opts = {
      env,
      stdio: 'inherit',
    }

let bin = 'man'
    const args = []
    switch (viewer) {
      case 'woman':
        bin = 'emacsclient'
        args.push('-e', `(woman-find-file '${man}')`)
        break

case 'browser':
        await openUrl(this.npm, this.htmlMan(man), 'help available at the following URL', true)
        return

default:
        args.push(man)
        break
    }

const proc = spawn(bin, args, opts)
    return new Promise((resolve, reject) => {
      proc.on('exit', (code) => {
        if (code) {
          return reject(new Error(`help process exited with code: ${code}`))
        }

return resolve()
      })
    })
  }

// Returns the path to the html version of the man page
  htmlMan (man) {
    let sect = man.match(manNumberRegex)[1]
    const f = path.basename(man).replace(manNumberRegex, '')
    switch (sect) {
      case '1':
        sect = 'commands'
        break
      case '5':
        sect = 'configuring-npm'
        break
      case '7':
        sect = 'using-npm'
        break
    }
    return 'file:///' + path.resolve(__dirname, '..', '..', 'docs', 'output', sect, f + '.html')
  }
}
module.exports = Help