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.

Sign up for GitHub

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

Jump to bottom

Add message that we only support TS >= 4.1.0 #3319

Merged
merged 1 commit into from Oct 18, 2021
Merged

Add message that we only support TS >= 4.1.0 #3319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 14 additions & 1 deletion package.json
View file
Open in desktop
Expand Up @@ -6,7 +6,20 @@
"private": true,
"main": "index",
"module": "index.mjs",
"types": "index.d.ts",
"types": "NotSupportedTSVersion.d.ts",
"typesVersions": {
">=4.1.0": {
"*": [
"index.d.ts"
],
"*/*": [
Copy link
Member

Choose a reason for hiding this comment

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

This breaks the nested imports and redirects all of them to index.d.ts. Now it is not possible to import Parser or some other stuff from the internals.

Copy link
Member Author

Choose a reason for hiding this comment

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

@ardatan Released https://github.com/graphql/graphql-js/releases/tag/v16.0.0-rc.7
can you please test it?
Also added an integration test for it, so it shouldn't happen again.

Copy link
Member

Choose a reason for hiding this comment

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

@IvanGoncharov Thanks! I'll write the results here

"*/index.d.ts"
],
"*/*/*": [
"*/*"
]
}
},
"sideEffects": false,
"homepage": "https://github.com/graphql/graphql-js",
"bugs": {
Expand Down
16 changes: 15 additions & 1 deletion resources/build-npm.js
View file
Open in desktop
Expand Up @@ -18,6 +18,8 @@ if (require.main === module) {
fs.rmSync('./npmDist', { recursive: true, force: true });
fs.mkdirSync('./npmDist');

const packageJSON = buildPackageJSON();

const srcFiles = readdirRecursive('./src', { ignoreDir: /^__.*__$/ });
for (const filepath of srcFiles) {
const srcPath = path.join('./src', filepath);
Expand Down Expand Up @@ -48,11 +50,23 @@ if (require.main === module) {
'Fail to generate `*.d.ts` files, please run `npm run check`',
);

assert(packageJSON.types, 'Missing "types".');
const supportedTSVersions = Object.keys(packageJSON.typesVersions);
assert(
supportedTSVersions.length === 1,
'Property "typesVersions" should have exactly one key.',
);
// TODO: revisit once TS implements https://github.com/microsoft/TypeScript/issues/44795
fs.writeFileSync(
path.join('./npmDist', packageJSON.types),
// Provoke syntax error to show this message
`"Package 'graphql' support only TS versions that are ${supportedTSVersions[0]}".`,
);

fs.copyFileSync('./LICENSE', './npmDist/LICENSE');
fs.copyFileSync('./README.md', './npmDist/README.md');

// Should be done as the last step so only valid packages can be published
const packageJSON = buildPackageJSON();
writeGeneratedFile('./npmDist/package.json', JSON.stringify(packageJSON));

showDirStats('./npmDist');
Expand Down