bmstefanski / nestjs-shell Goto Github PK

Issue type:

question
bug report
feature request

documentation issue

nestjs-shell version
1.0.7

[Nest CLI]
Nest CLI Version : 7.5.1

[Nest Platform Information]
platform-express version : 7.4.4
sequelize version : 0.1.1
common version : 7.4.4
core version : 7.4.4

Excepted behavior

no warning message when install nestjs-shell
Actual behavior or outcome (for issue)

npm WARN [email protected] requires a peer of @nestjs/common@^6.7.2 but none is installed. You must install peer dependencies yourself.
npm WARN [email protected] requires a peer of @nestjs/core@^6.7.2 but none is installed. You must install peer dependencies yourself.

When I install nestjs-config npm i nestjs-shell I get a npm warning message as I mentioned above. Are there any plans to upgrade the lib for compatibility with NestJS version 7 ?

Above you're using ShellModule but forgot to import it in L54 :p

Expected Behavior

The prompt message should appear once the shell is bootstrapped

Current Behavior

The prompt message appears only after either newline or backspace is hit.

Note that there is no red arrow on the first line (before .screenfetch) but only upcoming ones

Possible Solution

Add

rl.emit('line');

after

in order to emit 'line' immediately after bootstrap

Steps to Reproduce

Run the application as intended since this issue literally appears in README.md meaning that it exists as is

Environment

Node.js version 14.17.0

Possible Implementation

I can submit a PR with suggested changes if this is accepted as a valid issue

Hey, can you allow us more control over the behaviour of the interface? Passing Partial<ReadLineOptions> through shellFacade.bootstrap or have it return the readline interface?

My end goal is the implemented the following which would allow for an auto complete functionality

completer: (line: string) => {
    const commands = this.shellFacade.getAllCommands();
    const filteredCommands = commands
      .map((command) => command.name)
      .filter((command) => command.startsWith(line));

    return [filteredCommands, line];
  },