oclif/plugin-not-found

"did you mean" plugin for oclif

@oclif/plugin-not-found

"did you mean" for oclif

Contributing

See contributing guide

plugin-not-found's Issues

`-version` edge case

-version prompts for version which is a pseudo-command and not found causing a re-prompt for version and turtles all the way down.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

'Did you mean version' does not register as a valid command

Steps to reproduce

Create a new multicommand project. Select all defaults.

npx oclif multi testcli

Install plugin-not-found.

npm install @oclif/plugin-not-found

Add to package.json as described here

After linking and running the cli with a misspelt version, the following happens:

don't suggest hidden commands

Suggestion is only displayed for few seconds

plugin-not-found/src/index.ts

Line 30 in 0634f4c

response = await cli.prompt(`Did you mean ${color.blueBright(suggestion)}? [y/n]`, {timeout: 4900})

Why is the suggestion only displayed for a few seconds? It could be great to have no timeout (and the user exit the command or just press no) or even better have the possibility to customize it with no timeout or the timeout of our choice

Incorrect suggested commands from the `not-found` plugin

Do you want to request a feature or report a bug?

Report a bug

What is the current behavior?

If I enter mycommand login help or mycommand help login instead of mycommand login --help the suggested commands from the not-found plugin are confusing and inaccurate.

➜  mycommand login help
 ›   Warning: help login is not a devvit command.
Did you mean help login? [y/n]: 

➜  mycommand help login
 ›   Warning: help login is not a devvit command.
Did you mean help login? [y/n]: n
 ›   Error: Run mycommand help help for a list of available commands.

➜  mycommand help help
 ›   Warning: help help is not a devvit command.
Did you mean help? [y/n]: 

What is the expected behavior?

The recommendation should be mycommand help

"oclif": "4.0.3",
"@oclif/core": "3.10.0",
"@oclif/plugin-not-found": "3.0.2",

An in-range update of @types/node is breaking the build 🚨

The devDependency @types/node was updated from 10.10.0 to 10.10.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ✅ ci/circleci: node-latest: Your tests passed on CircleCI! (Details).
• ✅ ci/circleci: node-8: Your tests passed on CircleCI! (Details).
• ✅ continuous-integration/appveyor/branch: AppVeyor build succeeded (Details).
• ✅ codecov/project: No report found to compare against (Details).
• ✅ codecov/patch: Coverage not affected. (Details).
• ❌ Build: We could not find a valid build file. Please ensure that your repo contains a cloudbuild or a Dockerfile.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

[Security] Lodash vulnerability

Describe the bug
Lodash vulnerability has been fixed in some the dependencies of this plugin, namely - oclif, plugin-commands and plugin-warn-if-update-available

The versions of these to be bumped in this plugin.

Upgrade @oclif/core to v3

This plugin (along with a few others) depend on an old version of @oclif/core which depends on ts-node and typescript as production dependencies, significantly increasing the size of the final bundle. It looks like upgrading to v3 should resolve the issue.

An in-range update of @oclif/config is breaking the build 🚨

The devDependency @oclif/config was updated from 1.7.4 to 1.7.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@oclif/config is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ✅ ci/circleci: node-latest: Your tests passed on CircleCI! (Details).
• ✅ ci/circleci: node-8: Your tests passed on CircleCI! (Details).
• ❌ continuous-integration/appveyor/branch: AppVeyor build failed (Details).

---

Release Notes for v1.7.5

1.7.5 (2018-09-13)

Bug Fixes

• updated deps (01f51e6)

Commits

The new version differs by 2 commits.

• c69da5e chore(release): 1.7.5 [skip ci]
• 01f51e6 fix: updated deps

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Plugin hides failure of command if stdin is closed

When the plugin is installed, and the CLI is called with no available stdin (note: <&- is bash for "close stdin", but this also happens with e.g. < /dev/null)

$ my-cli this-does-not-exist <&-
 ›   Warning: this-does-not-exist is not a my-cli command.
Did you mean some-other-command? [y/n]:
$ echo $?
0

Then, the CLI exits with a zero (successful) exit code, even though no command was found or executed, and no answer was given to the not-found prompt.

This should instead be an error exit code.

It breaks when using pnpm (Rush)

Hello!

Thank you for this great library!

However, it fails with the error listed below, when used in the monorepo project with pnpm (Rush).

TypeError Plugin: my-cli: Cannot read property 'dim' of undefined
    at Object.<anonymous> (…/project/common/temp/node_modules/.pnpm/registry.npmjs.org/@oclif/color/0.0.0/node_modules/@oclif/color/lib/index.js:10:86)
    at Module._compile (internal/modules/cjs/loader.js:778:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:789:10)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3)
    at Module.require (internal/modules/cjs/loader.js:692:17)
    at require (internal/modules/cjs/helpers.js:25:18)
    at Object.<anonymous> (…/project/common/temp/node_modules/.pnpm/registry.npmjs.org/@oclif/plugin-not-found/1.2.3/node_modules/@oclif/plugin-not-found/lib/index.js:3:17)
    at Module._compile (internal/modules/cjs/loader.js:778:30)

Probably, you are requiring some dependencies incorrectly or has forgotten to explicitly specify all the used dependencies.