Gecko [ tsuru-no-tsurugi.tokyo ]

Name	Size	Permission	Date
access.js	6.04 KB	-rw-r--r--	2024-07-09 00:04
adduser.js	1.29 KB	-rw-r--r--	2024-05-09 19:00
audit.js	3.15 KB	-rw-r--r--	2024-07-09 00:04
bugs.js	847 B	-rw-r--r--	2023-10-14 15:00
cache.js	7.12 KB	-rw-r--r--	2025-03-27 09:29
ci.js	4.22 KB	-rw-r--r--	2024-07-09 00:04
completion.js	8.9 KB	-rw-r--r--	2024-07-09 00:04
config.js	11.18 KB	-rw-r--r--	2025-03-27 09:29
dedupe.js	1.41 KB	-rw-r--r--	2024-05-09 19:00
deprecate.js	2.13 KB	-rw-r--r--	2025-03-27 09:29
diff.js	8.14 KB	-rw-r--r--	2025-03-27 09:29
dist-tag.js	5.52 KB	-rw-r--r--	2025-03-27 09:29
docs.js	449 B	-rw-r--r--	2024-05-09 19:00
doctor.js	10.1 KB	-rw-r--r--	2025-03-27 09:29
edit.js	1.76 KB	-rw-r--r--	2024-07-09 00:04
exec.js	3.42 KB	-rw-r--r--	2024-07-09 00:04
explain.js	3.58 KB	-rw-r--r--	2025-03-27 09:29
explore.js	2.16 KB	-rw-r--r--	2024-07-09 00:04
find-dupes.js	634 B	-rw-r--r--	2024-05-09 19:00
fund.js	6.46 KB	-rw-r--r--	2024-07-09 00:04
get.js	577 B	-rw-r--r--	2024-05-09 19:00
help-search.js	5.52 KB	-rw-r--r--	2024-05-09 19:00
help.js	3.66 KB	-rw-r--r--	2024-07-09 00:04
hook.js	3.37 KB	-rw-r--r--	2025-03-27 09:29
init.js	6.85 KB	-rw-r--r--	2025-03-27 09:29
install-ci-test.js	373 B	-rw-r--r--	2024-05-09 19:00
install-test.js	370 B	-rw-r--r--	2024-05-09 19:00
install.js	5.15 KB	-rw-r--r--	2025-03-27 09:29
link.js	5.3 KB	-rw-r--r--	2025-03-27 09:29
ll.js	234 B	-rw-r--r--	2022-10-11 19:59
login.js	1.29 KB	-rw-r--r--	2024-05-09 19:00
logout.js	1.42 KB	-rw-r--r--	2024-05-09 19:00
ls.js	16.81 KB	-rw-r--r--	2025-03-27 09:29
org.js	4.02 KB	-rw-r--r--	2025-03-27 09:29
outdated.js	7.7 KB	-rw-r--r--	2024-07-13 15:00
owner.js	5.85 KB	-rw-r--r--	2024-07-09 00:04
pack.js	2.6 KB	-rw-r--r--	2025-03-27 09:29
ping.js	873 B	-rw-r--r--	2024-07-09 00:04
pkg.js	3.56 KB	-rw-r--r--	2025-03-27 09:29
prefix.js	335 B	-rw-r--r--	2025-03-27 09:29
profile.js	10.57 KB	-rw-r--r--	2024-07-09 00:04
prune.js	799 B	-rw-r--r--	2024-05-09 19:00
publish.js	7.19 KB	-rw-r--r--	2025-03-27 09:29
query.js	3.51 KB	-rw-r--r--	2024-07-09 00:04
rebuild.js	2.19 KB	-rw-r--r--	2024-07-09 00:04
repo.js	1.25 KB	-rw-r--r--	2025-03-27 09:29
restart.js	310 B	-rw-r--r--	2023-01-17 19:00
root.js	295 B	-rw-r--r--	2024-05-09 19:00
run-script.js	6.04 KB	-rw-r--r--	2025-03-27 09:29
sbom.js	4.51 KB	-rw-r--r--	2025-03-27 09:29
search.js	1.83 KB	-rw-r--r--	2024-05-09 19:00
set.js	671 B	-rw-r--r--	2024-05-09 19:00
shrinkwrap.js	2.65 KB	-rw-r--r--	2024-07-09 00:04
star.js	1.87 KB	-rw-r--r--	2025-03-27 09:29
stars.js	1.03 KB	-rw-r--r--	2025-03-27 09:29
start.js	300 B	-rw-r--r--	2023-01-17 19:00
stop.js	295 B	-rw-r--r--	2023-01-17 19:00
team.js	4.36 KB	-rw-r--r--	2024-07-09 00:04
test.js	295 B	-rw-r--r--	2023-01-17 19:00
token.js	6.02 KB	-rw-r--r--	2025-03-27 09:29
uninstall.js	1.52 KB	-rw-r--r--	2024-07-09 00:04
unpublish.js	5.27 KB	-rw-r--r--	2025-03-27 09:29
unstar.js	183 B	-rw-r--r--	2024-05-09 19:00
update.js	1.72 KB	-rw-r--r--	2024-07-09 00:04
version.js	3.54 KB	-rw-r--r--	2025-03-27 09:29
view.js	12.8 KB	-rw-r--r--	2025-03-27 09:29
whoami.js	527 B	-rw-r--r--	2024-07-09 00:04

Rename

const { readFile } = require('node:fs/promises')
const path = require('node:path')
const { glob } = require('glob')
const { output } = require('proc-log')
const BaseCommand = require('../base-cmd.js')

const globify = pattern => pattern.split('\\').join('/')

class HelpSearch extends BaseCommand {
  static description = 'Search npm help documentation'
  static name = 'help-search'
  static usage = ['<text>']
  static params = ['long']

async exec (args) {
    if (!args.length) {
      throw this.usageError()
    }

const docPath = path.resolve(this.npm.npmRoot, 'docs/content')
    let files = await glob(`${globify(docPath)}/*/*.md`)
    // preserve glob@8 behavior
    files = files.sort((a, b) => a.localeCompare(b, 'en'))
    const data = await this.readFiles(files)
    const results = await this.searchFiles(args, data)
    const formatted = this.formatResults(args, results)
    if (!formatted.trim()) {
      output.standard(`No matches in help for: ${args.join(' ')}\n`)
    } else {
      output.standard(formatted)
    }
  }

async readFiles (files) {
    const res = {}
    await Promise.all(files.map(async file => {
      res[file] = (await readFile(file, 'utf8'))
        .replace(/^---\n(.*\n)*?---\n/, '').trim()
    }))
    return res
  }

async searchFiles (args, data) {
    const results = []
    for (const [file, content] of Object.entries(data)) {
      const lowerCase = content.toLowerCase()
      // skip if no matches at all
      if (!args.some(a => lowerCase.includes(a.toLowerCase()))) {
        continue
      }

const lines = content.split(/\n+/)

// if a line has a search term, then skip it and the next line.
      // if the next line has a search term, then skip all 3
      // otherwise, set the line to null.  then remove the nulls.
      for (let i = 0; i < lines.length; i++) {
        const line = lines[i]
        const nextLine = lines[i + 1]
        let match = false
        if (nextLine) {
          match = args.some(a =>
            nextLine.toLowerCase().includes(a.toLowerCase()))
          if (match) {
            // skip over the next line, and the line after it.
            i += 2
            continue
          }
        }

match = args.some(a => line.toLowerCase().includes(a.toLowerCase()))

if (match) {
          // skip over the next line
          i++
          continue
        }

lines[i] = null
      }

// now squish any string of nulls into a single null
      const pruned = lines.reduce((l, r) => {
        if (!(r === null && l[l.length - 1] === null)) {
          l.push(r)
        }

return l
      }, [])

if (pruned[pruned.length - 1] === null) {
        pruned.pop()
      }

if (pruned[0] === null) {
        pruned.shift()
      }

// now count how many args were found
      const found = {}
      let totalHits = 0
      for (const line of pruned) {
        for (const arg of args) {
          const hit = (line || '').toLowerCase()
            .split(arg.toLowerCase()).length - 1

if (hit > 0) {
            found[arg] = (found[arg] || 0) + hit
            totalHits += hit
          }
        }
      }

const cmd = 'npm help ' +
        path.basename(file, '.md').replace(/^npm-/, '')
      results.push({
        file,
        cmd,
        lines: pruned,
        found: Object.keys(found),
        hits: found,
        totalHits,
      })
    }

// sort results by number of results found, then by number of hits
    // then by number of matching lines

// coverage is ignored here because the contents of results are
    // nondeterministic due to either glob or readFiles or Object.entries
    return results.sort(/* istanbul ignore next */ (a, b) =>
      a.found.length > b.found.length ? -1
      : a.found.length < b.found.length ? 1
      : a.totalHits > b.totalHits ? -1
      : a.totalHits < b.totalHits ? 1
      : a.lines.length > b.lines.length ? -1
      : a.lines.length < b.lines.length ? 1
      : 0).slice(0, 10)
  }

formatResults (args, results) {
    const cols = Math.min(process.stdout.columns || Infinity, 80) + 1

const formattedOutput = results.map(res => {
      const out = [res.cmd]
      const r = Object.keys(res.hits)
        .map(k => `${k}:${res.hits[k]}`)
        .sort((a, b) => a > b ? 1 : -1)
        .join(' ')

out.push(' '.repeat((Math.max(1, cols - out.join(' ').length - r.length - 1))))
      out.push(r)

if (!this.npm.config.get('long')) {
        return out.join('')
      }

out.unshift('\n\n')
      out.push('\n')
      out.push('-'.repeat(cols - 1) + '\n')
      res.lines.forEach((line, i) => {
        if (line === null || i > 3) {
          return
        }

const hilitLine = []
        for (const arg of args) {
          const finder = line.toLowerCase().split(arg.toLowerCase())
          let p = 0
          for (const f of finder) {
            hilitLine.push(line.slice(p, p + f.length))
            const word = line.slice(p + f.length, p + f.length + arg.length)
            hilitLine.push(this.npm.chalk.blue(word))
            p += f.length + arg.length
          }
        }
        out.push(hilitLine.join('') + '\n')
      })

return out.join('')
    }).join('\n')

const finalOut = results.length && !this.npm.config.get('long')
      ? 'Top hits for ' + (args.map(JSON.stringify).join(' ')) + '\n' +
      '—'.repeat(cols - 1) + '\n' +
      formattedOutput + '\n' +
      '—'.repeat(cols - 1) + '\n' +
      '(run with -l or --long to see more context)'
      : formattedOutput

return finalOut.trim()
  }
}

module.exports = HelpSearch