TypeScript definitions for config & lifecycles

[jpage-godaddy]

Summary

• Create types for the core gasket engine
• Create core interfaces which plugins can extend
• Add config & lifecycle typings for all plugins
• Add unit tests to check that type validation works

Changelog

TBD

[decompil3d]

Should there be something before the & or is this a typescript syntax that I'm not familiar with?

[jpage-godaddy]

It's something TypeScript supports. | as well. It's just a syntax thing that lets you do a list of unions/intersections in a nicer-looking way.

[decompil3d]

Ok, that's fine. I'm just surprised that a leading & is allowed. I'd have expected something more like:

type HttpsSettings =
  CustomHttpsSettings &
  Omit<
     SecureContextOptions,
     keyof CustomHttpsSettings | 'secureProtocol' | 'secureOptions'
     >;

[kinetifex]

Perhaps we can lint on code styles here (see comment).

[decompil3d]

Not really related to this PR, but @kinetifex -- should this move to terser?

[kinetifex]

It should be updated, but we'll probably go with swc modification.

[kinetifex]

Very cool and thorough @jpage-godaddy! There are some lifecycles that are executed from the @gasket/cli package that were missed. Also, what are you thinking for the non-plugin packages? - Not going to block on those for the PR, but it'd be good to have follow-up tickets/issues so we do not lose track.

The only thing blocking really is just marking the test package as private. Besides that, some possible lint cleanup, and what are your thoughts on a follow-up to include .ts type files with our linting rules?

[jpage-godaddy]

There are some lifecycles that are executed from the @gasket/cli package that were missed.

Thanks. Added those.

Also, what are you thinking for the non-plugin packages?

It can be much the same, just adding to a .d.ts (or converting the package to TypeScript and auto-generating that, which is easier IMO). Could be pretty incremental, maybe could have a ticket per package?

The only thing blocking really is just marking the test package as private.

Fixed.

...what are your thoughts on a follow-up to include .ts type files with our linting rules?

If eslint supports that sure! I'd think we'd have to switch to eslint-config-godaddy-typescript or similar in order for TypeScript to be recognized, but I don't know how well that works when the majority of the codebase is not TypeScript.