Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tslib to support new __spreadArray helper #133

Merged
merged 3 commits into from Dec 18, 2020
Merged

Conversation

rbuckton
Copy link
Member

@rbuckton rbuckton commented Nov 13, 2020

This applies the same change from microsoft/TypeScript#41523. This also deprecates __spread and __spreadArrays, as they have been subsumed by __spreadArray. If we want to remove __spread and __spreadArrays, that would require a major version bump.

@rbuckton rbuckton requested a review from orta November 13, 2020 01:41
@rbuckton
Copy link
Member Author

export declare function __spreadArrays(...args: any[][]): any[];
export declare function __spreadArray(to: any[], from: any[]): any[];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is more correct:

Suggested change
export declare function __spreadArray(to: any[], from: any[]): any[];
export declare function __spreadArray<T, U>(to: T[], from: ReadonlyArray<U>): Array<T | U>;

Although this would be even more correct, it depends on TypeScript 4.0:

export declare function __spreadArray<T extends any[], U extends readonly any[]>(to: T, from: U): [...T, ...U];

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types here are fairly simplistic. If we were going to add generics here we would want to add them to other functions as well, but that's out of scope for now.

@ExE-Boss
Copy link
Contributor

Do note that /modules/index.js also needs updating.

@orta
Copy link
Contributor

orta commented Nov 18, 2020

Thanks! Got a local repro for the fail

@orta
Copy link
Contributor

orta commented Nov 18, 2020

Great catch on the modules/index.js - ideally that would have just failed the build, will look at that now

Copy link
Contributor

@orta orta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good to me, and I've validated the CI works as expected.

I'll leave you to decide whether the generic change above is worth it here.

@rbuckton
Copy link
Member Author

@DanielRosenwasser this will probably need to be published before we merge microsoft/TypeScript#41523 so anyone using our nightlies can get a working copy of tslib.

@Finesse
Copy link

Finesse commented Feb 11, 2021

Which version of TypeScript will start using __spreadArray instead of __spread and __spreadArrays?

@ExE-Boss
Copy link
Contributor

ExE-Boss commented Feb 11, 2021

@Finesse TypeScript is using __spreadArray as of TypeScript 4.2 beta (microsoft/TypeScript@44ec8dd).

Gusted added a commit to darkreader/darkreader that referenced this pull request Mar 7, 2021
- Since Typescript 4.2 some Helpers to transpile to 4.2 are deprecated/removed. This includes __spread and __spreadArrays microsoft/TypeScript#41523.
- We heavily use the spread syntax in Dark Reader and thus need those helper functions.
- Due the upgrade of 4.2, tslib was outdated and didn't had the new helper function `__spreadArray`.
- After good hours of skimming trough the compiler and using the wrong commands to update tslib(default to 1.x). manually updating it to 2.1 which includes this new functions microsoft/tslib#133
https://github.com/microsoft/tslib/releases/tag/2.1.0
the API can be properly compiled again.
- Resolves #My personal issues with the API.
Gusted added a commit to darkreader/darkreader that referenced this pull request Mar 7, 2021
- Since Typescript 4.2 some Helpers to transpile to 4.2 are deprecated/removed. This includes __spread and __spreadArrays microsoft/TypeScript#41523.
- We heavily use the spread syntax in Dark Reader and thus need those helper functions.
- Due the upgrade of 4.2, tslib was outdated and didn't had the new helper function `__spreadArray`.
- After good hours of skimming trough the compiler and using the wrong commands to update tslib(default to 1.x). manually updating it to 2.1 which includes this new functions microsoft/tslib#133
https://github.com/microsoft/tslib/releases/tag/2.1.0
the API can be properly compiled again.
- Resolves #My personal issues with the API.

Note to myself: Now their are 2 versions installed `2.1.10` and `1.14.1` properly configuration setups should default to 2.1.10. But for sakes if I get into problems with this I hope I remember this note and don't waste some hours. Why `1.14.1`, I don't know. `npm --save-dev -E tslib` defaults to 1.14.1. It seems like an NPM bug `yarn add --dev -E tslib` gives the correct 2.1.10. Damn dependency hell =).
efokschaner added a commit to efokschaner/algorithm that referenced this pull request Jul 12, 2021
The version + features of typescript used to compile this lib means that tslib needs to be at version 2.0.0 minimum.

Because `antvis/algorithm` doesn't specify an explicit version, it is not guaranteed that developers receive the necessary version.
This causes the following error at import time:
```
./node_modules/@antv/algorithm/es/gaddi.js
Attempted import error: '__spreadArray' is not exported from 'tslib'.
```

You can see here all the other projects updating their tslib dependencies similarly in the references to this PR: microsoft/tslib#133

This relates to
antvis/G6#2702
and
antvis/G6#2713
it is likely necessary, but may not be sufficient, to fix those reported issues. There could be other `antvis` packages with the same issue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants