Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(did-you-mean): succeed if cwd is not a package #3747

Merged
merged 1 commit into from Sep 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 15 additions & 14 deletions lib/utils/did-you-mean.js
Expand Up @@ -3,25 +3,26 @@ const readJson = require('read-package-json-fast')
const { cmdList } = require('./cmd-list.js')

const didYouMean = async (npm, path, scmd) => {
const bestCmd = cmdList
let best = cmdList
.filter(cmd => distance(scmd, cmd) < scmd.length * 0.4 && scmd !== cmd)
.map(str => ` npm ${str} # ${npm.commands[str].description}`)

const pkg = await readJson(`${path}/package.json`)
const { scripts } = pkg
// We would already be suggesting this in `npm x` so omit them here
const runScripts = ['stop', 'start', 'test', 'restart']
const bestRun = Object.keys(scripts || {})
.filter(cmd => distance(scmd, cmd) < scmd.length * 0.4 &&
!runScripts.includes(cmd))
.map(str => ` npm run ${str} # run the "${str}" package script`)

const { bin } = pkg
const bestBin = Object.keys(bin || {})
.filter(cmd => distance(scmd, cmd) < scmd.length * 0.4)
.map(str => ` npm exec ${str} # run the "${str}" command from either this or a remote npm package`)

const best = [...bestCmd, ...bestRun, ...bestBin]
try {
const { bin, scripts } = await readJson(`${path}/package.json`)
best = best.concat(
Object.keys(scripts || {})
.filter(cmd => distance(scmd, cmd) < scmd.length * 0.4 &&
!runScripts.includes(cmd))
.map(str => ` npm run ${str} # run the "${str}" package script`),
Object.keys(bin || {})
.filter(cmd => distance(scmd, cmd) < scmd.length * 0.4)
.map(str => ` npm exec ${str} # run the "${str}" command from either this or a remote npm package`)
)
} catch (_) {
// gracefully ignore not being in a folder w/ a package.json
}

if (best.length === 0)
return ''
Expand Down
71 changes: 46 additions & 25 deletions test/lib/utils/did-you-mean.js
Expand Up @@ -5,34 +5,55 @@ const dym = require('../../../lib/utils/did-you-mean.js')
t.test('did-you-mean', t => {
npm.load(err => {
t.notOk(err)
t.test('nistall', async t => {
const result = await dym(npm, npm.localPrefix, 'nistall')
t.match(result, 'npm install')
})
t.test('sttest', async t => {
const result = await dym(npm, npm.localPrefix, 'sttest')
t.match(result, 'npm test')
t.match(result, 'npm run posttest')
t.test('with package.json', t => {
const testdir = t.testdir({
'package.json': JSON.stringify({
bin: {
npx: 'exists',
},
scripts: {
install: 'exists',
posttest: 'exists',
},
}),
})
t.test('nistall', async t => {
const result = await dym(npm, testdir, 'nistall')
t.match(result, 'npm install')
})
t.test('sttest', async t => {
const result = await dym(npm, testdir, 'sttest')
t.match(result, 'npm test')
t.match(result, 'npm run posttest')
})
t.test('npz', async t => {
const result = await dym(npm, testdir, 'npxx')
t.match(result, 'npm exec npx')
})
t.test('qwuijbo', async t => {
const result = await dym(npm, testdir, 'qwuijbo')
t.match(result, '')
})
t.end()
})
t.test('npz', async t => {
const result = await dym(npm, npm.localPrefix, 'npxx')
t.match(result, 'npm exec npx')
t.test('with no package.json', t => {
const testdir = t.testdir({})
t.test('nistall', async t => {
const result = await dym(npm, testdir, 'nistall')
t.match(result, 'npm install')
})
t.end()
})
t.test('qwuijbo', async t => {
const result = await dym(npm, npm.localPrefix, 'qwuijbo')
t.match(result, '')
t.test('missing bin and script properties', async t => {
const testdir = t.testdir({
'package.json': JSON.stringify({
name: 'missing-bin',
}),
})

const result = await dym(npm, testdir, 'nistall')
t.match(result, 'npm install')
})
t.end()
})
})

t.test('missing bin and script properties', async t => {
const path = t.testdir({
'package.json': JSON.stringify({
name: 'missing-bin',
}),
})

const result = await dym(npm, path, 'nistall')
t.match(result, 'npm install')
})