chore: get the TypeScript version range from root package.json #7367

auvred · 2023-07-28T16:40:52Z

PR Checklist

Addresses an existing open issue: fixes Repo: Automate version ranges in website's Versioning.md #6389
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

The goal of this PR is to refactor all possible places where the TypeScript version/version range is hardcoded and might be taken from the root package.json.

I found the following places (but there may be a few more here):

Typescript version range in docs/users/Dependency_Versions.mdx

typescript-eslint/docs/users/Dependency_Versions.mdx

Line 19 in d89b847

> The version range of TypeScript currently supported is `>=3.3.1 <5.2.0`.

It looks exactly the same as before, but now it has become dynamic
Available TypeScript versions in the playground (thanks to Repo: Automate version ranges in website's Versioning.md #6389 (comment))

Now it contains only versions that satisfy version range from root package.json
Typescript version range in docs/users/Versioning.mdx

~~Will be~~ Removed in docs: remove duplicated package versions description #7343

typescript-eslint/docs/users/Versioning.mdx

Line 51 in d89b847

> The version range of TypeScript currently supported is `>=4.3.5 <5.2.0`.

[Postponed] Probably this range also should be taken from the root package.json (Maybe I'm wrong)

typescript-eslint/packages/typescript-estree/src/parseSettings/warnAboutTSVersion.ts

Lines 5 to 9 in d89b847

    
           /** 
        
            * This needs to be kept in sync with /docs/users/Versioning.mdx 
        
            * in the typescript-eslint monorepo 
        
            */ 
        
           const SUPPORTED_TYPESCRIPT_VERSIONS = '>=4.3.5 <5.2.0';

But the only thing that prevents this from being done is "rootDir": "." in the tsconfig.json

typescript-eslint/packages/typescript-estree/tsconfig.json

Line 5 in d89b847

"rootDir": "."

typescript-eslint/packages/typescript-estree/tsconfig.build.json

Line 6 in d89b847

"rootDir": "./src",

So we can't just import package.json from the repository root. Is there any other way do get this done? Or this constant and range in package.json must be independent?

[Postponed] Also not sure what to do with this list

Should it also be updated automatically?

typescript-eslint/packages/typescript-estree/src/version-check.ts

Lines 14 to 23 in d89b847

    
           const versions = [ 
        
             '4.3', 
        
             '4.4', 
        
             '4.5', 
        
             '4.6', 
        
             '4.7', 
        
             '4.8', 
        
             '4.9', 
        
             '5.0', 
        
           ] as const;

typescript-eslint · 2023-07-28T16:40:54Z

Thanks for the PR, @auvred!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

netlify · 2023-07-28T16:40:56Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`bf4911a`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/64ceafc89f18160008d58ab4
😎 Deploy Preview	https://deploy-preview-7367--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

nx-cloud · 2023-07-28T16:48:13Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit bf4911a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 35 targets

Sent with 💌 from NxCloud.

JoshuaKGoldberg · 2023-07-31T04:37:45Z

For the hardcodings that are making things more difficult, I think it's ok to skip them for now. We can always file a followup issue to revisit. I'd rather get this partially fixed than wait on weird intricacies.

Worst case scenario, I bet website-eslint could include version ranges...

auvred · 2023-07-31T09:46:00Z

Hi! I looked through the website-eslint and didn't find anything there at all about the typescript versions.

So, should I skip last two tasks for now?

JoshuaKGoldberg · 2023-07-31T14:19:57Z

Yeah let's skip for now

JoshuaKGoldberg

💯 love it, thanks @auvred!

I can file a followup issue on the postponed stuff.

codecov · 2023-08-05T19:35:04Z

Codecov Report

Merging #7367 (2323c06) into main (dfcafae) will not change coverage.
Report is 5 commits behind head on main.
The diff coverage is n/a.

❗ Current head 2323c06 differs from pull request most recent head bf4911a. Consider uploading reports for the commit bf4911a to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7367   +/-   ##
=======================================
  Coverage   87.41%   87.41%           
=======================================
  Files         381      381           
  Lines       13316    13316           
  Branches     3936     3936           
=======================================
  Hits        11640    11640           
  Misses       1298     1298           
  Partials      378      378

Flag	Coverage Δ
unittest	`87.41% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

chore: get the TypeScript version range from root package.json

2a69d67

chore: revert changes in yarn.lock

ce230e3

auvred marked this pull request as ready for review July 31, 2023 15:56

Merge branch 'main' into chore/6389

2323c06

JoshuaKGoldberg approved these changes Aug 5, 2023

View reviewed changes

Merge branch 'main' into chore/6389

f6ff8de

Merge branch 'main' into chore/6389

bf4911a

JoshuaKGoldberg merged commit 8352759 into typescript-eslint:main Aug 5, 2023

github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: get the TypeScript version range from root package.json #7367

chore: get the TypeScript version range from root package.json #7367

auvred commented Jul 28, 2023 •

edited

Loading

typescript-eslint bot commented Jul 28, 2023

netlify bot commented Jul 28, 2023 •

edited

Loading

nx-cloud bot commented Jul 28, 2023 •

edited

Loading

JoshuaKGoldberg commented Jul 31, 2023

auvred commented Jul 31, 2023

JoshuaKGoldberg commented Jul 31, 2023

JoshuaKGoldberg left a comment

codecov bot commented Aug 5, 2023 •

edited

Loading

	/**
	* This needs to be kept in sync with /docs/users/Versioning.mdx
	* in the typescript-eslint monorepo
	*/
	const SUPPORTED_TYPESCRIPT_VERSIONS = '>=4.3.5 <5.2.0';

	const versions = [
	'4.3',
	'4.4',
	'4.5',
	'4.6',
	'4.7',
	'4.8',
	'4.9',
	'5.0',
	] as const;

chore: get the TypeScript version range from root package.json #7367

chore: get the TypeScript version range from root package.json #7367

Conversation

auvred commented Jul 28, 2023 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Jul 28, 2023

netlify bot commented Jul 28, 2023 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Jul 28, 2023 • edited Loading

☁️ Nx Cloud Report

JoshuaKGoldberg commented Jul 31, 2023

auvred commented Jul 31, 2023

JoshuaKGoldberg commented Jul 31, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

codecov bot commented Aug 5, 2023 • edited Loading

Codecov Report

auvred commented Jul 28, 2023 •

edited

Loading

netlify bot commented Jul 28, 2023 •

edited

Loading

nx-cloud bot commented Jul 28, 2023 •

edited

Loading

codecov bot commented Aug 5, 2023 •

edited

Loading