1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
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 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+)(\.[^/\\]*)?$/
class Help extends BaseCommand {
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get description () {
return 'Get help on npm'
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get name () {
return 'help'
}
/* istanbul ignore next - see test/lib/load-all-commands.js */
static get usage () {
return ['<term> [<terms..>]']
}
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(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 }))
}
exec (args, cb) {
this.help(args).then(() => cb()).catch(cb)
}
async help (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(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(f)
mans = mans.sort((a, b) => {
// Because of the glob we know the manNumberRegex will pass
const aManNumber = a.match(manNumberRegex)[1]
const bManNumber = b.match(manNumberRegex)[1]
// man number sort first so that 1 aka commands are preferred
if (aManNumber !== bManNumber)
return aManNumber - bManNumber
return a.localeCompare(b, 'en')
})
const man = mans[0]
if (man)
await this.viewMan(man)
else
return this.helpSearch(args)
}
helpSearch (args) {
return new Promise((resolve, reject) => {
this.npm.commands['help-search'](args, (err) => {
// This would only error if args was empty, which it never is
/* istanbul ignore next */
if (err)
return reject(err)
resolve()
})
})
}
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')
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
|