feat: allow disabling manual restart for ts watchmode

[m4tt72]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

When running the REPL, the server interferes with the REPL especially when running REPL from within a docker container.

This is implemented in Nodemon: https://github.com/remy/nodemon/blob/main/faq.md#nodemon-doesnt-work-with-my-repl

Issue Number: N/A

What is the new behavior?

Allow manual restart to be disabled, this will prevent nest from listening to STDIN and allow REPL to take over.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

[m4tt72]

Here's a Codesandbox example: https://codesandbox.io/p/sandbox/great-paper-96fkjj

Notice when setting restartable to true, which is the default value, the REPL behaves in a weird way. Setting it to false disables the rs input and allows the REPL to capture user input

[m4tt72]

@kamilmysliwiec any opinions for this issue? Also, I'm not sure if this is considered a new feature or a bugfix

[kamilmysliwiec]

That's a great catch @m4tt72, thank you! Turns out this feature may have broken existing REPL setups which is definitely unexpected. Perhaps we should turn it off by default then? And let it control with a dedicated flag (as implemented in this repository)?

I'm also wondering if we should rename this attribute to be manualRestart instead of restartable (which is quite generic - that's my main concern)

[m4tt72]

That's a great catch @m4tt72, thank you! Turns out this feature may have broken existing REPL setups which is definitely unexpected. Perhaps we should turn it off by default then? And let it control with a dedicated flag (as implemented in this repository)?

I'm also wondering if we should rename this attribute to be manualRestart instead of restartable (which is quite generic - that's my main concern)

Thank you @kamilmysliwiec for the reply.

Of course, I don't mind changing the variable name, I was following how nodemon did it, I will push a commit to set it to false 🚀

[kamilmysliwiec]

Excellent! Could you also create a PR to the docs (preferably this section https://docs.nestjs.com/cli/monorepo#global-compiler-options ?) adding the new configuration attribute?

[m4tt72]

@kamilmysliwiec done, documentation for this option is ready nestjs/docs.nestjs.com#2730

[kamilmysliwiec]

LGTM

[micalevisk]

@m4tt72 could you please update the nest-cli.json schema definition at https://github.com/SchemaStore/schemastore as well? an example of such change: SchemaStore/schemastore#2561