Rewrite Got in TypeScript

[sindresorhus]

We want typings available and keeping a type definition file in sync with the actual codebase is a lot of work in itself and it's easy for them to get out of sync. I also think the codebase could benefit from being written in TypeScript, as the code is quite complex and it's easy to make subtle mistakes.

[ferdaber]

This looks like an interesting project- I'd like to help! I can start with at least adding the TypeScript build/test steps.

[sindresorhus]

@ferdaber Yes, that would be helpful. See https://github.com/sindresorhus/is for how to do the TS setup. Should use https://github.com/sindresorhus/tsconfig and https://github.com/xojs/tslint-xo.

[sindresorhus]

The TS setup is done, so now it's possible to convert to TS file-by-file. If you want to contribute, pick one or more files you think you can manage and have fun. Just rename the .js file to .ts and try to build ($ npm run build). Make sure you read https://github.com/sindresorhus/typescript-definition-style-guide for the style we use and document all public interfaces (you can steal text from the readme) (bonus points for documenting private ones too). Also try not to do files that are touched a lot in the open PRs, to avoid conflicts.

Note: To import a TS file into a JS file, you need to use require('foo').default instead of require('foo').

[ricardorojass]

Hi everyone, I'd like to help with this project, I'll be going to rewrite source/errors.js in TS.

[michaeldera]

I would love to help rewrite the files in TypeScript, is there a specific file I can go for?

[sindresorhus]

@michaeldera Pick any .js file you think you can handle and that's not already being worked on in an open PR ;)

For example: https://github.com/sindresorhus/got/blob/master/source/create.js

[michaeldera]

@michaeldera Pick any .js file you think you can handle and that's not already being worked on in an open PR ;)

For example: https://github.com/sindresorhus/got/blob/master/source/create.js

Now working on create.js

[Magellol]

Started to tackle https://github.com/sindresorhus/got/blob/master/source/as-stream.js in #720 👍

[michaeldera]

#721 converted create.js to TypeScript. Ran into one issue and could use help with that. I added the details in the PR

[sindresorhus]

We are still looking for help getting this done. 🙌

Left to do:

• source/as-promise.js
• source/normalize-arguments.js
• source/request-as-event-emitter.js
• source/index.js (the above files should be done first)

When these are done, we'll need help converting the tests to TypeScript.

[ghost]

fwiw and feel free to disagree but since a lot of people will consume this package in a JS project (meaning I'm just making this assumption) then tests should probably remain in JS. Consumers calling from JS into TS do not get the benefit of static type safety and accordingly the Got APIs should not make any assumptions about validity of arguments passed in.

If the tests are written in TS and say an API function takes a number (and is typed as such) then when one tries to write a test that passes in, say, a string instead of a number then TS will produce a compile error. To work around the difficulty of writing tests to check the robustness of APIs against any arbitrary types of values thrown at them, one ends up doing a lot of any cast gymnastics.

[tobenna]

I can do source/normalize-arguments.js

[sindresorhus]

To work around the difficulty of writing tests to check the robustness of APIs against any arbitrary types of values thrown at them, one ends up doing a lot of any cast gymnastics.

I've been doing that in other TS-written modules. It's not a big problem to write a few as any.

[sindresorhus]

@tobenna 👍 Great

[paulmelnikow]

I will give source/request-as-event-emitter.js a shot!

Added: Making progress: master...paulmelnikow:request-as-event-emitter-ts

[sindresorhus]

I decided to disable strict-mode for now and move the rest of the files over to TS so the TS migration would not be blocking other work. The rest of the work is moved into #758

Thanks for all the help everyone. ❤️