chore/update-typescript-eslint-and-module-resolution #624

kanej · 2025-01-13T17:15:55Z

Slang@19 supports being used from commonjs (which the vscode extension is). However, to get access to the exported types we require updating the module resolution we are using to node16 for typescript builds.
This module resolution option requires we update the version of typescript being used.
This PR:

Updates a cut of packages that need updating to work with [email protected], including

the microsoft language server lib
lodash types
node types
esbuild
eslint and plugins

Updates typescript to version [email protected]
Applies some linting fixes and some naming convention eslint disable lines
Turns off the typescript libcheck

socket-security · 2025-01-13T17:20:19Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@solidity-parser/[email protected]	None	`0`	9.24 MB	fvictorio
npm/@types/[email protected] 🔁 npm/@types/[email protected]	None	`0`	9.12 kB	types
npm/@types/[email protected] 🔁 npm/@types/[email protected]	None	`0`	868 kB	types
npm/@types/[email protected] 🔁 npm/@types/[email protected], npm/@types/[email protected]	None	`+1`	2.38 MB	types
npm/@types/[email protected] 🔁 npm/@types/[email protected]	None	`0`	7.46 kB	types
npm/@types/[email protected] 🔁 npm/@types/[email protected], npm/@types/[email protected]	None	`0`	23.3 kB	types
npm/@types/[email protected] 🔁 npm/@types/[email protected]	None	`0`	693 kB	types
npm/@typescript-eslint/[email protected] 🔁 npm/@typescript-eslint/[email protected]	None	`+8`	5.45 MB	jameshenry
npm/@typescript-eslint/[email protected] 🔁 npm/@typescript-eslint/[email protected]	None	`+4`	1.4 MB	jameshenry
npm/[email protected] 🔁 npm/[email protected]	None	`0`	22.7 MB	typescript-bot

🚮 Removed packages: npm/[email protected], npm/[email protected]

View full report↗︎

codecov · 2025-01-13T17:23:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.53%. Comparing base (1ddb6d7) to head (cdedcbc).

Additional details and impacted files

@@             Coverage Diff              @@
##           development     #624   +/-   ##
============================================
  Coverage        54.52%   54.53%           
============================================
  Files              226      226           
  Lines             5199     5200    +1     
  Branches           800      800           
============================================
+ Hits              2835     2836    +1     
  Misses            2127     2127           
  Partials           237      237

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This was previously implicit and depended on a the root build. This clashes with my attempts to update the typescript version, so I am scoping the e2e tests to their own build.

alcuadrado · 2025-01-18T18:12:42Z

test/e2e/tsconfig.json

+    "target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "lib": ["es2023"],


Are these compatible with recent versions of vscode?

This is based on:

VSCode is on Node 20

The tsconfig for working with Node 20 suggests the target and lib selection above: https://www.npmjs.com/package/@tsconfig/node20

However, this was only tentative, it should all be reviewed once the all the parts allow a run through of Slang with WASM.

There is a question about whether we should target Node 18 rather than Node 20 so that we are keeping to the Hardhat node version support promise. This wouldn't affect the VSCode library but you can run the language server independently.

I think that if it works with vscode is enough. We don't need to keep the same support, as vscode updates on a different cadence.

This brings coc inline with the eslint config pattern found for other packages in the repo. It showed up as an issue when attempting to update the typescript version.

The language server was 2 years out of date. To maximize ease of integration with typescript@5 we are updating to the latest version.

The latest version of lodash types is been taken to better work with typescript@5.

Eslint and its plugins are 2 years out of date. They have been brought up to the same version used in the Hardhat repo. We initially tried to jump straight to `eslint@10` but backed out with the config format changes. We will look at this again with the repo modernization efforts.

Node 20 is now the version used in VSCode. The types have been updated to reflect the new node versions.

To package the extension we use a bundler, esbuild needs to be updated to match the new version of typescript.

We need better module resolution support as we deal with Slang's ESM packages, specifically the loading of TS types from commonjs.

To support pulling in more modern ts libraries like Slang@18, we want to swap to `node16` module resolution. This is not ESM, but the modern version of commonjs. It lets us use TS types from Slang from the VSCode extension's commonjs packages.

This is a hack that we should accept temporarily. A library that the language server node library uses fails more refined typechecking in typescript@5. For the moment checking types in dependent packages is skipped.

The update to eslint revealed this equality error.

New rules are affecting our naming conventions. Rather than disable the rule I have scattered disable lines. This is a tradeoff, but we expect a revamp of the eslint rules based on HH3 in the near future.

antico5 · 2025-01-30T12:32:34Z

coc/package.json

-    "coc.nvim": "^0.0.80",
-    "esbuild": "^0.16.0",
-    "eslint": "^7.23.0"
+    "coc.nvim": "^0.0.80"


Won't our build/lint scripts fail if we remove those dev dependencies?

antico5 · 2025-01-30T12:57:58Z

@kanej Besides the 1 question I left, I'm seeing the "package" step on the CI is failing. I don't see any changes in the bundle script so it's interesting. Should I look into it ?

github-actions bot added the status:ready This issue is ready to be worked on label Jan 13, 2025

kanej force-pushed the chore/update-to-slang-with-wasm branch from 207ffc4 to 13847f6 Compare January 13, 2025 17:20

kanej force-pushed the development branch from c572b8a to 1ddb6d7 Compare January 14, 2025 23:37

chore: add tsconfig and build for e2e

af10d73

This was previously implicit and depended on a the root build. This clashes with my attempts to update the typescript version, so I am scoping the e2e tests to their own build.

kanej force-pushed the chore/update-to-slang-with-wasm branch 2 times, most recently from 02960b6 to 123d3c6 Compare January 15, 2025 18:40

kanej changed the base branch from development to chore/move-tests-build-to-own-tsconfig January 15, 2025 18:41

alcuadrado reviewed Jan 18, 2025

View reviewed changes

kanej changed the base branch from chore/move-tests-build-to-own-tsconfig to development January 29, 2025 20:47

kanej changed the title ~~Chore/update to slang with wasm~~ chore/update-typescript-eslint-and-module-resolution Jan 29, 2025

kanej changed the base branch from development to chore/move-tests-build-to-own-tsconfig January 29, 2025 20:51

kanej force-pushed the chore/update-to-slang-with-wasm branch 6 times, most recently from e9043b2 to 5f6c757 Compare January 30, 2025 11:10

kanej added 5 commits January 30, 2025 11:13

chore: add eslint config for coc

07dfec7

This brings coc inline with the eslint config pattern found for other packages in the repo. It showed up as an issue when attempting to update the typescript version.

chore: bump version of language server

45082c8

The language server was 2 years out of date. To maximize ease of integration with typescript@5 we are updating to the latest version.

chore: bump version of lodash types

b8f0e47

The latest version of lodash types is been taken to better work with typescript@5.

chore: bump verion of @types/node to latest

fd1952c

Node 20 is now the version used in VSCode. The types have been updated to reflect the new node versions.

kanej force-pushed the chore/update-to-slang-with-wasm branch from 5f6c757 to 471a696 Compare January 30, 2025 11:21

kanej marked this pull request as ready for review January 30, 2025 11:27

kanej changed the base branch from chore/move-tests-build-to-own-tsconfig to development January 30, 2025 11:28

kanej added 3 commits January 30, 2025 11:53

chore: bump version of esbuild

f91800b

To package the extension we use a bundler, esbuild needs to be updated to match the new version of typescript.

chore: update version of typescript

9542c62

We need better module resolution support as we deal with Slang's ESM packages, specifically the loading of TS types from commonjs.

chore: bump node target in tsconfig

e693f98

To support pulling in more modern ts libraries like Slang@18, we want to swap to `node16` module resolution. This is not ESM, but the modern version of commonjs. It lets us use TS types from Slang from the VSCode extension's commonjs packages.

kanej added 3 commits January 30, 2025 11:54

chore: disable lib check on server

078b622

This is a hack that we should accept temporarily. A library that the language server node library uses fails more refined typechecking in typescript@5. For the moment checking types in dependent packages is skipped.

chore: fix linting error on t.type

ed398d6

The update to eslint revealed this equality error.

chore: update eslint errors

91c7944

New rules are affecting our naming conventions. Rather than disable the rule I have scattered disable lines. This is a tradeoff, but we expect a revamp of the eslint rules based on HH3 in the near future.

kanej force-pushed the chore/update-to-slang-with-wasm branch from 471a696 to 91c7944 Compare January 30, 2025 12:03

antico5 reviewed Jan 30, 2025

View reviewed changes

kanej force-pushed the chore/update-to-slang-with-wasm branch from 5e4f1bf to 91c7944 Compare January 30, 2025 13:42

antico5 added 2 commits January 30, 2025 12:17

Recreate package-lock.json

244a6e4

Update bundle script - @solidity-parser got hoisted

cdedcbc

kanej linked an issue Jan 30, 2025 that may be closed by this pull request

Update to typescript 5 and node 16 module resolution #631

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore/update-typescript-eslint-and-module-resolution #624

chore/update-typescript-eslint-and-module-resolution #624

kanej commented Jan 13, 2025 •

edited

Loading

socket-security bot commented Jan 13, 2025 •

edited

Loading

codecov bot commented Jan 13, 2025 •

edited

Loading

alcuadrado Jan 18, 2025

kanej Jan 20, 2025

alcuadrado Jan 20, 2025

antico5 Jan 30, 2025

antico5 commented Jan 30, 2025

		"target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
		"lib": ["es2023"],

chore/update-typescript-eslint-and-module-resolution #624

Are you sure you want to change the base?

chore/update-typescript-eslint-and-module-resolution #624

Conversation

kanej commented Jan 13, 2025 • edited Loading

socket-security bot commented Jan 13, 2025 • edited Loading

codecov bot commented Jan 13, 2025 • edited Loading

Codecov Report

alcuadrado Jan 18, 2025

Choose a reason for hiding this comment

kanej Jan 20, 2025

Choose a reason for hiding this comment

alcuadrado Jan 20, 2025

Choose a reason for hiding this comment

antico5 Jan 30, 2025

Choose a reason for hiding this comment

antico5 commented Jan 30, 2025

kanej commented Jan 13, 2025 •

edited

Loading

socket-security bot commented Jan 13, 2025 •

edited

Loading

codecov bot commented Jan 13, 2025 •

edited

Loading