typescript: add support for typescript 5.0.x, 5.1.x #288

legobeat · 2023-05-12T04:36:27Z

This lifts the current typescript version restriction to allow running on version 5.
It also updates the package devDependency typescript accordingly.
yarn dedupe and minor-bump related deps
- CVE-2022-46175/ GHSA-9c47-m6qq-7p4h

socket-security · 2023-05-12T04:37:26Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Mrtenz · 2023-05-12T08:15:17Z

Did you verify that the ESLint plugin works with TypeScript 5? Might have to bump that too.

mcmire · 2023-05-12T14:42:06Z

Good timing. I was just thinking about this yesterday!

legobeat · 2023-05-20T01:00:51Z

Did you verify that the ESLint plugin works with TypeScript 5? Might have to bump that too.

Seems fine (and tests are now running on ts5) but it did seem warranted to bump eslint-plugin-jsdoc (included here now).

Also lifted the peerDependency range of the same plugin to allow existing users to upgrade config package while staying on the same plugin version.

legobeat · 2023-05-20T01:07:43Z

packages/base/package.json

@@ -35,7 +35,7 @@
    "eslint": "^8.27.0",
    "eslint-config-prettier": "^8.5.0",
    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-jsdoc": "^39.6.2 || ^41 || ^43.0.7",


For background of motivation of the specific version, see #290.

Minimize upgrade overhead (keep existing ^39.6.2)

Maintenance fixes for existing users without breaking rules (^41)

Forwards-compatibility with new rules while allowing for node 14 (^43.0.7)

Open to holding off on introducing 43 here if considered premature or out of scope.

Hmm. Wouldn't using this with v43 cause the error that #290 is meant to resolve? Perhaps we should wait for that PR before introducing this.

@legobeat What do you think about @Gudahtt's comment?

In order to unblock this and break the relationship between the two PRs, I'm dropping ^43.0.7 from this one.

Gudahtt · 2023-05-26T12:44:18Z

packages/typescript/package.json

  },
  "peerDependencies": {
    "@metamask/eslint-config": "^11.0.0",
    "@typescript-eslint/eslint-plugin": "^5.42.1",
    "@typescript-eslint/parser": "^5.42.1",
    "eslint": "^8.27.0",
-    "typescript": "~4.8.4"
+    "typescript": "~4.8.4 || ^5.0.0"


We had been intentionally using ~ ranges for TypeScript to prevent it from being used on TypeScript versions that may not be compatible with the plugin we're using. i.e. to prevent this error:

WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.

Without this, it's easy to upgrade and not notice any incompatibility until you run the linter locally and see that message.

I agree. It's annoying that @typescript-eslint isn't automatically compatible with future versions of TypeScript, but I think it's better for our projects to not get updated to a new version of TypeScript prematurely than it is to have to keep the TypeScript versions manually updated. What do you think about changing this to:

Suggested change

"typescript": "~4.8.4 || ^5.0.0"

"typescript": "~4.8.4 || ~5.0.0"

Let's at least support 5.1. Changing to ~4.8.4 || ~5.0 || ~5.1.

Gudahtt · 2023-05-26T12:50:45Z

packages/base/package.json

-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^39.6.2 || ^41 || ^43.0.7",


The versions referenced in each README should be updated as well

What do we recommend that people install for new projects? Should it be ^43.0.7?

Good question. I guess that could stay the same for now, though the eslint-plugin-import reference should be updated at least, since the minimum has been increased

READMEs updated. Changed recommendation to ^41.1.2.

socket-security · 2023-06-14T05:19:59Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
eslint-plugin-jsdoc	41.1.2	None	`+6`	2.37 MB	gajus

🚮 Removed packages: [email protected]

mcmire · 2023-07-12T16:48:46Z

The version ranges are getting a bit complicated — I hope we can simplify them in the future — but I can live with them. I can approve this once the conflicts are resolved.

legobeat · 2023-07-12T20:02:31Z

@mcmire rebased

mcmire

Looks good!

legobeat requested a review from a team as a code owner May 12, 2023 04:36

legobeat marked this pull request as draft May 12, 2023 04:36

legobeat marked this pull request as ready for review May 12, 2023 04:38

legobeat force-pushed the typescript-5 branch from 30953b7 to 5c75d33 Compare May 12, 2023 09:24

legobeat force-pushed the typescript-5 branch from 1a918ab to c978abc Compare May 12, 2023 21:58

legobeat marked this pull request as draft May 12, 2023 22:08

legobeat force-pushed the typescript-5 branch from c978abc to b77308d Compare May 20, 2023 00:58

legobeat marked this pull request as ready for review May 20, 2023 01:01

legobeat commented May 20, 2023

View reviewed changes

legobeat mentioned this pull request May 20, 2023

jsdoc: remove deprecated rule jsdoc/newline-after-description #290

Merged

legobeat requested review from mcmire, Mrtenz and Gudahtt May 20, 2023 01:23

legobeat force-pushed the typescript-5 branch from 1721ccb to 27222b7 Compare May 26, 2023 10:20

Gudahtt reviewed May 26, 2023

View reviewed changes

legobeat force-pushed the typescript-5 branch from 27222b7 to 1219f4b Compare June 14, 2023 05:18

legobeat requested review from Gudahtt and a team July 7, 2023 06:22

legobeat force-pushed the typescript-5 branch from 1219f4b to d2d9035 Compare July 10, 2023 08:52

legobeat changed the title ~~typescript: add support for typescript@^5.0.0~~ typescript: add support for typescript 5.0, 5.1 Jul 10, 2023

legobeat changed the title ~~typescript: add support for typescript 5.0, 5.1~~ typescript: add support for typescript 5.0.x, 5.1.x Jul 10, 2023

legobeat force-pushed the typescript-5 branch from 3d0e3a6 to c0b4847 Compare July 12, 2023 19:50

deps: eslint-plugin-jsdoc@^39.6.2->^41.1.2

73fd832

legobeat added 8 commits July 13, 2023 04:50

commonjs/peerDeps: allow eslint-plugin-jsdoc peerDep 39,41,43

67e165b

typescript: add support for typescript@^5.0.0

bf9f0d7

eslint-plugin-import@^2.26.0->^2.27.5

a28300e

yarn dedupe

0cf6802

drop eslint-plugin-jsdoc v43 support

d7a754d

update READMEs wuth updated eslint-plugin-jsdoc version

ce589f7

update READMEs wuth updated eslint-plugin-import version

75cecbf

update typescript version range

2a27b25

legobeat force-pushed the typescript-5 branch from c0b4847 to 2a27b25 Compare July 12, 2023 19:54

mcmire approved these changes Jul 12, 2023

View reviewed changes

legobeat merged commit c430e96 into MetaMask:main Jul 12, 2023

legobeat mentioned this pull request Sep 1, 2023

peerDeps(base): allow eslint-plugin-jsdoc ^43.0.7 #319

Merged

legobeat mentioned this pull request Apr 15, 2024

BREAKING: Bump all ESLint dependencies #351

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

typescript: add support for typescript 5.0.x, 5.1.x #288

typescript: add support for typescript 5.0.x, 5.1.x #288

legobeat commented May 12, 2023 •

edited

Loading

socket-security bot commented May 12, 2023 •

edited

Loading

Mrtenz commented May 12, 2023

mcmire commented May 12, 2023

legobeat commented May 20, 2023 •

edited

Loading

legobeat May 20, 2023 •

edited

Loading

Gudahtt May 26, 2023

mcmire Jul 7, 2023

legobeat Jul 10, 2023 •

edited

Loading

Gudahtt May 26, 2023

mcmire Jul 7, 2023

legobeat Jul 10, 2023

Gudahtt May 26, 2023

mcmire Jul 7, 2023

Gudahtt Jul 7, 2023 •

edited

Loading

legobeat Jul 10, 2023 •

edited

Loading

socket-security bot commented Jun 14, 2023 •

edited

Loading

mcmire commented Jul 12, 2023 •

edited

Loading

legobeat commented Jul 12, 2023

mcmire left a comment

	"typescript": "~4.8.4 \|\| ^5.0.0"
	"typescript": "~4.8.4 \|\| ~5.0.0"

typescript: add support for typescript 5.0.x, 5.1.x #288

typescript: add support for typescript 5.0.x, 5.1.x #288

Conversation

legobeat commented May 12, 2023 • edited Loading

socket-security bot commented May 12, 2023 • edited Loading

Mrtenz commented May 12, 2023

mcmire commented May 12, 2023

legobeat commented May 20, 2023 • edited Loading

legobeat May 20, 2023 • edited Loading

Choose a reason for hiding this comment

Gudahtt May 26, 2023

Choose a reason for hiding this comment

mcmire Jul 7, 2023

Choose a reason for hiding this comment

legobeat Jul 10, 2023 • edited Loading

Choose a reason for hiding this comment

Gudahtt May 26, 2023

Choose a reason for hiding this comment

mcmire Jul 7, 2023

Choose a reason for hiding this comment

legobeat Jul 10, 2023

Choose a reason for hiding this comment

Gudahtt May 26, 2023

Choose a reason for hiding this comment

mcmire Jul 7, 2023

Choose a reason for hiding this comment

Gudahtt Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

legobeat Jul 10, 2023 • edited Loading

Choose a reason for hiding this comment

socket-security bot commented Jun 14, 2023 • edited Loading

mcmire commented Jul 12, 2023 • edited Loading

legobeat commented Jul 12, 2023

mcmire left a comment

Choose a reason for hiding this comment

legobeat commented May 12, 2023 •

edited

Loading

socket-security bot commented May 12, 2023 •

edited

Loading

legobeat commented May 20, 2023 •

edited

Loading

legobeat May 20, 2023 •

edited

Loading

legobeat Jul 10, 2023 •

edited

Loading

Gudahtt Jul 7, 2023 •

edited

Loading

legobeat Jul 10, 2023 •

edited

Loading

socket-security bot commented Jun 14, 2023 •

edited

Loading

mcmire commented Jul 12, 2023 •

edited

Loading