Add TypeScript definitions for public packages #6484
Conversation
|
| @@ -1,5 +1,4 @@ | |||
| // @flow strict-local | |||
| import type {FilePath} from '@parcel/types'; | |||
There was a problem hiding this comment.
Avoiding circular dependency... Perhaps we should consider whether the diagnostic types should move into the core types package and only the implementation should stay in this package?
| @@ -195,11 +195,11 @@ export class MemoryFS implements FileSystem { | |||
| } | |||
|
|
|||
| // eslint-disable-next-line require-await | |||
| async readFile(filePath: FilePath, encoding?: buffer$Encoding): Promise<any> { | |||
| async readFile(filePath: FilePath, encoding?: Encoding): Promise<any> { | |||
There was a problem hiding this comment.
We can't rely on these global flow types
| Validator as ValidatorOpts, | ||
| } from '@parcel/types'; | ||
|
|
||
| export declare class Transformer<T> { |
There was a problem hiding this comment.
Did this file manually because flow allows the type parameter on the constructor rather than the class but TS doesn't. Wanted to avoid the type param on the class in Flow otherwise you have to explicitly type the config on every plugin rather than it being inferred. This is because flow doesn't infer the types of exports in type first mode and forces you to type it explicitly (which is really annoying).
| @@ -875,6 +878,36 @@ export type TransformerResult = {| | |||
|
|
|||
| export type Async<T> = T | Promise<T>; | |||
|
|
|||
| export interface PluginLogger { | |||
There was a problem hiding this comment.
Moved this type here to avoid another circular dependency. Plus, better to expose an interface to plugins rather than an implementation.
Benchmark ResultsKitchen Sink 🚨
Timings
Cold BundlesNo bundles found, this is probably a failed build... Cached BundlesNo bundles found, this is probably a failed build... React HackerNews ✅
Timings
Cold BundlesNo bundle changes detected. Cached BundlesNo bundle changes detected. AtlasKit Editor 🚨
Timings
Cold BundlesNo bundles found, this is probably a failed build... Cached BundlesNo bundles found, this is probably a failed build... Three.js ✅
Timings
Cold BundlesNo bundle changes detected. Cached Bundles
|
|
Hi, And, I happened to also experiment with it on parcel codebase, on which there is pretty good progress - rebased it on current latest parcel version: https://github.com/zxbodya/parcel/tree/ts If one day, you decide to migrate parcel to TypeScript - that might be a good starting point 😄 There is still some type errors to be fixed, and also to review fixes I did manually after converting it to typescript, but generally it already should be in a pretty good shape, and can at least - can be used for generating type definitions. Drafted scripts to bundle
It should be usable, only thing - probably some type dependencies to be added in package.json files before merging it. |
Closes #5297. Fixes #3912.
This adds TypeScript definition files for public packages including
@parcel/core,@parcel/types, and@parcel/pluginalong with all dependencies. This will make it easier for people to develop plugins and use the Parcel API in TypeScript (or even just for autocomplete in VSCode).I tried to use flow-to-ts on these packages, and then run
tscto generate.d.tsfiles, but ran into some issues because the TS type system and Flow type system work significantly differently and I was getting lots of errors when TS checked the converted code.Instead, I opted for a hybrid approach. I used flow-to-ts to convert the type-only files (e.g.
@parcel/types), but wrote some hand written types for some packages containing code. This way, the bulk of changes will be handled automatically and kept in sync with the Flow types, but we don't need to worry about passing two type systems on all source code.