refactor: port load to typescript

[byCedric]

Description

Part of #659

Motivation and Context

It's kind of an old attempt from me, with some new mocking mechanisms. Instead of using proxyquire, it uses jest. With jest, we can actually import typescript, with proxyquire we cant... I also "made it work" in the CLI, by unpacking from default. Think there might be some things in here that we should change, like the any castings. Let me know what you think! 😁

Usage examples

How Has This Been Tested?

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[marionebl]

This amounts to a breaking change for CommonJS consumers. Can we emit the module to contain the module.exports = ... stanza instead? If i remember correctly there was a tsc settings for this...

[byCedric]

I'll check it out!

[marionebl]

Doesn't fix the breakage for external CommonJS consumers but we can use the default import interop babel provides.

[byCedric]

Maybe we should create a building library that works like bob. With such a tool we can build commonjs, module and just typescript definition files. I think that might be best to keep support for all platforms, right? Internally, we can just use the latest default module system.

[marionebl]

Looks good at first glance! I'll fiddle around a bit with the any types and check if we can avoid the CommonJS breakage

[byCedric]

Yeah, I agree with the any types. My main concern was the mocking part, so I focussed on that one. About the commonjs thing, do you want to have that globally? I can imagine this being an issue in more packages, and if we centralize it we can easily switch if we want to in a later major version.

[marionebl]

Yeah, I agree with the any types. My main concern was the mocking part, so I focussed on that one. About the commonjs thing, do you want to have that globally? I can imagine this being an issue in more packages, and if we centralize it we can easily switch if we want to in a later major version.

Good job on switching to jest mocking! Thinking about it we might speed up @commitlint/load unit tests by mocking cosmiconfig and moving the config fixtures inline. We can defer this though.

Regarding the TS setting to emit CommonJS module.exports - no luck in my research so far.

[marionebl]

No idea why the pluginloader test acts up now...

[byCedric]

I'll take a look tomorrow! I bet it's still repairable 😬

[byCedric]

@marionebl I may need some help finishing this one 😄 The types you added are great, but they also overlap with types from rules (#785). Maybe we can either update them to support this set, or update this to reuse them?

I also implemented the loadParserOpts, the rewrite for the new conventional changelog parsers. I'll merge master into this one with those changes.

[marionebl]

Maybe we can either update them to support this set, or update this to reuse them?

Yes, let's export and use the @commitlint/rules types where possible :)

[armano2]

this is not correct as prompt-cli has no src folder