docs: set the minimum TypeScript requirement to 3.8 #128
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The TypeScript version is tested in the `ts-support` package.
Member
Author
|
#129 introduces a shared TypeScript configuration. I suggest we don't use it in the new package that tests the minimum TypeScript supported version to avoid any side effects of the shared configuration. With this test package, we want to ensure that external applications can work with this TS version, so it is better to mimic such applications as much as possible. And so, to not depend on resources of |
tbouffard
commented
Nov 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
We use a recent TypeScript version to build maxGraph but applications that integrates it may be forced to use old TypeScript versions.
We never explain what is the minimum TypeScript version requires to use
maxGraph. The changes proposed here are a first step to make this information available.It is only informative for now (mentioned in the README) and the minimum TypeScript version is tested in the
ts-supportpackage (part of the 'build' GitHub workflow).Notice that I only tested with TypeScript 3.8 (and greater) but the maxGraph types provided in the npm package may work with older TypeScript versions.
Description for the changelog
Set the minimum TypeScript requirement to version 3.8
Other info
I said that this Pull Request is a first step because it is possible to make the build chain of the application integrating maxGraph aware of the TypeScript version requirements.
It starts by declaring the minimum version in the package.json file.
microsoft/TypeScript#32166 provides detailed information about how to enforce this with all TypeScript versions and workarounds to get more explicit error messages when the version is too old.
I can work on implementing this improvements later once this Pull Request has been merged.