Document compatibility of tslib with typescript

Open
#148 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the README and investigate the compatibility of tslib 1.x and 2.x across the TypeScript versions discussed in the issue, especially the proposed TypeScript 3.9 boundary. Done means the README clearly lists confirmed minimum or supported TypeScript versions and tells users when updating to tslib 2.x is safe.

Written by the indexing model from the issue text.

Description

enhancement

We are seeing numerous packages which depend on tslib 1.x and 2.x. We'd like to de-duplicate these, but there doesn't seem to be clear docs on if it's safe to update to the latest tslib 2.x when using older TypeScript versions to build. Some folks internally have mentioned that if you're on TS < 3.9, use 1.x. Else it's ok to use 2.x. I'd like to confirm if that's the case.

If there are specific TypeScript minbar versions before we ask everyone to update to 2.x, it would be great to list them in the README so that people can be aware, and also so that we can communicate the dependency. We wouldn't want to ask someone to upgrade, if it's not compatible with the TypeScript version they're using.

Dominant language
TypeScript
Stars
1.3k
Forks
145
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/tslib

All issues in microsoft/tslib

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.