Proposal: Convert to TypeScript

[mefellows]

We already have TypeScript bindings, which are neat, it's time to make the whole code base type safe!

I'd think we need to look at the following:

• Convert all code to TypeScript!
• Make all tests pass
• Upgrade to latest @pact-foundation/pact-node 5.1.x
• Creating the scaffolding to enable a staged migration from JS => TS
• Modifying the TravisCI builds to publishing ES5 compatible code
• Updating WebPack configuration to parse TS
• Moving parts of pact-node to this repository, or adding type declarations to that repository
• Typescript bindings are not present in standalone pact-web npm package #92
• Add 'InteractionObject' to declared namespace in 'pact.d.ts' #117
• All examples pass and are run as part of CI
• Bring across the standard release process from master
• Remove old "docs" folder (TS annotations are live and better)
• Removing the old type declarations
• Port latest karma examples (a62d00f and 93cba30)
• Add in type checks / guards for common native JS scenarios
• Ensure style/formatting consistent throughout (e.g. semi-colon use, spacing, editor config etc. - update lint rules and ensure they are applied)
• Ensuring compatibility with pact-web, refactor common code and create test for pact-web to prove it
• Review Suggestion: rename (alias for backwards compatibility) finalize() to writePact() #119 and make any backwards incompatible change as part of this
• Pact-js doesn't support date matching #120 More matchers?
• Review tests
• Fix any remaining TODOs
• Release under Pact Foundation (Proposal: use @pact-foundation scope for pact dependency for consistency #116)
• Review public facing API (Clean up packaging)
• Write TS integration test

Changes from master that need to come across before this becomes a thing:

• feat(pact-server): allow to run pact mock server on a host other than localhost #115
• fix(verification): pass validation error message on  #114
• fix(src): fix typo in error message #101
• Fix incorrect Error text in eachLike DSL #99
• feat(karma): relax consumer/provider requirement in MockService #96
• feat(example): adding example for the AVA test framework #80
• docs(ava): refactor ava test to reflect proper testing conventions #127 Slash in consumer name results in folders being created #126

[mboudreau]

What's the progress on this? I might be able to use my experience in TS to help out.

[mefellows]

It's probably around 90% complete - see https://github.com/pact-foundation/pact-js/tree/feat/typescript.

I think I have the next couple of nights free (incl. tonight) so after tending to other issues/PR's etc. i'll get it into as good a shape as I can and then perhaps we can collab on getting it over the line?

[mboudreau]

Sounds good bud.

…

On Mon., 16 Oct. 2017, 8:17 pm Matt Fellows, ***@***.***> wrote: It's probably around 90% complete - see https://github.com/pact-foundation/pact-js/tree/feat/typescript. I think I have the next couple of nights free (incl. tonight) so after tending to other issues/PR's etc. i'll get it into as good a shape as I can and then perhaps we can collab on getting it over the line? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#76 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAjA5NmYd_yI_W5aaAlCedvkQZwhmozWks5ssx8ygaJpZM4On39u> .

[mefellows]

@mboudreau see above checklist.

I think we're at the point where it's about adding all of the type / other guards in, getting some cleanliness happening and getting a beta 5.x.x out to start testing with other components / implementations.

[mefellows]

Closing: Beta now available at https://www.npmjs.com/package/@pact-foundation/pact and code merged to master for any cleanup.