search

mozilla-rally / rally-sdk

This is the Rally partner support library, `rally.js`, used to manage the lifecycle of Rally studies.
0 stars 4 forks source link

convert rally.js to typescript #1

Closed rhelmer closed 3 years ago

rhelmer commented 3 years ago

The types are somewhat loose, but I used a package recommended by the official webextension-polyfill directory, and it's pretty nice for checking the webextension types.

rhelmer commented 3 years ago

Largely looks good to me – would be happy to merge this but it'd be good to get this into publish-ready state even as-is in a follow-on, which would require:

1. making sure we do the js compilation so that people can pick ts or js (may make sense to not require ts for study partners, unclear!)

2. surfacing types for this and publishing them on NPM

3. getting reasonable types for the parameters we _do_ have. Most of these should be definable easily with Interfaces or primitives

OK I did these except for 2, @hamilton would you mind taking another glance? I'd like to tackle that as part of cleaning up the NPM publishing process as a separate issue.

rhelmer commented 3 years ago

Largely looks good to me – would be happy to merge this but it'd be good to get this into publish-ready state even as-is in a follow-on, which would require:

1. making sure we do the js compilation so that people can pick ts or js (may make sense to not require ts for study partners, unclear!)

This is done and documented in README.

2. surfacing types for this and publishing them on NPM

Filed https://github.com/mozilla-rally/rally-sdk/issues/6

3. getting reasonable types for the parameters we _do_ have. Most of these should be definable easily with Interfaces or primitives

I made some headway on this, the more I learn about typescript the more I see we can do here :)