FM / commands

/snap/node/11691/lib/node_modules/npm/lib/commands/

/snap/node/11691/lib/node_modules/npm/lib/commands

Name	Size	Mode	Actions
access.js	6189	0644	edit dl rm
adduser.js	1321	0644	edit dl rm
audit.js	3221	0644	edit dl rm
bugs.js	847	0644	edit dl rm
cache.js	7292	0644	edit dl rm
ci.js	4325	0644	edit dl rm
completion.js	9116	0644	edit dl rm
config.js	11444	0644	edit dl rm
dedupe.js	1443	0644	edit dl rm
deprecate.js	2182	0644	edit dl rm
diff.js	8191	0644	edit dl rm
dist-tag.js	5654	0644	edit dl rm
docs.js	449	0644	edit dl rm
doctor.js	10347	0644	edit dl rm
edit.js	1804	0644	edit dl rm
exec.js	3500	0644	edit dl rm
explain.js	3661	0644	edit dl rm
explore.js	2211	0644	edit dl rm
find-dupes.js	634	0644	edit dl rm
fund.js	6610	0644	edit dl rm
get.js	577	0644	edit dl rm
help-search.js	5650	0644	edit dl rm
help.js	3752	0644	edit dl rm
hook.js	3453	0644	edit dl rm
init.js	7018	0644	edit dl rm
install-ci-test.js	373	0644	edit dl rm
install-test.js	370	0644	edit dl rm
install.js	5277	0644	edit dl rm
link.js	5381	0644	edit dl rm
ll.js	234	0644	edit dl rm
login.js	1318	0644	edit dl rm
logout.js	1453	0644	edit dl rm
ls.js	18629	0644	edit dl rm
org.js	4121	0644	edit dl rm
outdated.js	7880	0644	edit dl rm
owner.js	5988	0644	edit dl rm
pack.js	2665	0644	edit dl rm
ping.js	873	0644	edit dl rm
pkg.js	3641	0644	edit dl rm
prefix.js	335	0644	edit dl rm
profile.js	10819	0644	edit dl rm
prune.js	799	0644	edit dl rm
publish.js	7552	0644	edit dl rm
query.js	3595	0644	edit dl rm
rebuild.js	2241	0644	edit dl rm
repo.js	1278	0644	edit dl rm
restart.js	310	0644	edit dl rm
root.js	295	0644	edit dl rm
run-script.js	6221	0644	edit dl rm
sbom.js	4616	0644	edit dl rm
search.js	1877	0644	edit dl rm
set.js	671	0644	edit dl rm
shrinkwrap.js	2712	0644	edit dl rm
star.js	1911	0644	edit dl rm
stars.js	1052	0644	edit dl rm
start.js	300	0644	edit dl rm
stop.js	295	0644	edit dl rm
team.js	4461	0644	edit dl rm
test.js	295	0644	edit dl rm
token.js	6160	0644	edit dl rm
uninstall.js	1561	0644	edit dl rm
unpublish.js	5394	0644	edit dl rm
unstar.js	183	0644	edit dl rm
update.js	1765	0644	edit dl rm
version.js	3628	0644	edit dl rm
view.js	13106	0644	edit dl rm
whoami.js	527	0644	edit dl rm

Edit: /snap/node/11691/lib/node_modules/npm/lib/commands/help-search.js (5650B)

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

cmd: