fix: Add node types to typings

[ffflorian]

No description provided.

[shadowspawn]

@ffflorian What problem is this Pull Request solving?

[ffflorian]

@shadowspan
commander's typings use interfaces from Node so the reference should be included. When I wanted to create typings for commander-remaining-args (see DefinitelyTyped/DefinitelyTyped#36148) I needed to reference Node's typings explicitly. This could've been avoided by just referencing them here.

[shadowspawn]

Related link:

• feat(typings): add typings to support TypeScript #646 (comment)

[ffflorian]

@shadowspawn

From the comment:

You can include the /// <reference types="node"> flag to access EventEmitter and anything else needed

Does that mean you approve?

[shadowspawn]

No it does not mean I approve, it means I have started looking into it. If you have good links for the details of what reference types does, I'll be reading up on that too. (I review Pull Requests fairly carefully and add more comments than you might expect.)

[ffflorian]

I review Pull Requests fairly carefully and add more comments than you might expect.

You don't know what I expect 🙂 I was just wondering what you meant by your comment, sorry. Take your time!

Here are the docs for reference types: https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html

In short:

Triple-slash references instruct the compiler to include additional files in the compilation process.

[shadowspawn]

Happy with the triple slash, thanks. I think it is the Right Thing to do. As a small bonus it changes the tsc error messages when node types are not installed, and that may help people recognise the problem quicker.

In part because we are shipping definitions ourselves now, I do not wish to list new minor contributors in the "Definitions by" please. On DefinitelyTyped that had the benefit of getting email notifications about related changes but that is no longer the case. (We have git history and GitHub contributors for author credit.)

[ffflorian]

@shadowspawn I removed the changes to the contributors line.

[shadowspawn]

Thanks @ffflorian

[abetomo]

Thank you!

[shadowspawn]

Merging into release/3.0.0 branch

[shadowspawn]

Already had two approvals. Merged into v3 and will be included in that release. Closing to make it clear that should not be merged into master.

Thank you for your contributions.

[ffflorian]

Thanks @shadowspawn @abetomo, looking forward to v3!

[shadowspawn]

Available now as a prerelease. See #1001

[shadowspawn]

Shipped in v3: https://github.com/tj/commander.js/releases/tag/v3.0.0