You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit was created on GitHub.com and signed with GitHub’s verified signature.
BREAKING CHANGE
The package is ESM only ("type": "module"), like NestJS 12 and commander 15. CommonJS projects keep working without changes: Node >= 22.12 loads ES modules with require(), and TypeScript resolves the types with module: commonjs or nodenext
The exports field only exposes the main entry point: deep imports (nestjs-console/dist/...) are not possible any more, import everything from nestjs-console
Jest in CommonJS mode needs to load ES modules, as it already does for commander 15 and NestJS 12: run it with --experimental-vm-modules (Node >= 24.9), or compile nestjs-console and commander with a Jest transform (see the wiki page "Upgrade from v11 to v12")
Added
Parameter decorators @Arg(name?, ...pipes), @Opt(name?, ...pipes) and @Cmd() to inject the arguments, the options and the command. Pipes receive arguments with the type param and options with the type query, so the ValidationPipe validates and transforms them (eg a DTO of options). Custom decorators made with createParamDecorator work too
Guards (@UseGuards), interceptors (@UseInterceptors), pipes (@UsePipes) and exception filters (@UseFilters) on decorated commands and their classes. ExecutionContext.getType() returns 'console' (CONSOLE_CONTEXT_TYPE). Only the commands that use a parameter decorator or an enhancer run in this execution context, where the global enhancers (APP_GUARD...) apply too with NestJS >= 10; the other commands are executed as before
Option settings: choices, env, conflicts, implies, preset, hidden, helpGroup (commander >= 14), defaultValueDescription. Options and arguments can also be commander Option and Argument instances
Bootstrap cli option to configure the root cli (name, version, description, exitOverride, output, global options...)
BootstrapConsole.run(): init the application, execute the command, print the error and set process.exitCode on failure, and always close the application (so onModuleDestroy hooks run)
runCommand(argv, options) to test commands: returns the data, the error, the exit code and the output of commander, and accepts a create function to use a TestingModule with overridden providers
Shell completion for bash, zsh and fish with the bootstrap completion option (my-cli completion zsh), tested in the 3 shells in CI
Interactive prompts: PromptService (input, confirm, password, select), injectable in any provider, and the prompt setting of options and arguments to ask the missing values when the terminal is interactive (a list for choices, yes/no for flags). The bootstrap prompt option changes the streams, and runCommand() accepts answers
Typed options: the @ConsoleOption() property decorator declares the options on a class (flags from the property name, numbers parsed), added to the commands that inject the class with @Opt(), or with getClassOptions(MyOptions)
CI tests every supported major of NestJS (9 to 12) and commander (11 to 15)
Fixed
A group declared with @Console({ command: 'parent.child' }) was registered at the root when its parent group was scanned after it. Missing parent groups are now created
Commands inherited from a grand parent class were not registered
Settings of the root cli (exitOverride(), configureOutput(), showHelpAfterError()...) were not applied to the sub commands, eg a command error exited the process even with exitOverride(). They are now inherited like with commander .command(), unless the sub command sets its own
An async hook (preAction...) that failed caused an unhandled rejection instead of rejecting boot()
Options kept their values between two boot() calls (fixed with commander >= 13, which resets them before each parse), and a lone --no-* root option had no default value
boot() never settled when no command was executed. It now resolves with data undefined and the root cli
Clear errors when ConsoleModule is not imported and when boot() is called before init()
Changed
The cli is executed with the public parseAsync() of commander instead of private methods, the decorators are found with the public DiscoveryService of NestJS instead of the private container, and only the public entry points of NestJS are imported
Compile to ES2022 (Node >= 22)
Removed the protected responseListener event emitter of the ConsoleService
The examples and the smoke test run compiled code instead of ts-node, Jest runs the tests as ES modules