typecheck tests and bump typescript-eslint #2674

turadg · 2024-12-30T17:58:02Z

evergreen

Description

The typescript-eslint dep was behind so I tried to bump it. The major version breaking change required linted files to be included in a tsconfig. Files in demo, scripts and test were linted but not typechecked, so I added those to the tsconfigs. Then I did a bunch of work to get them to green.

I tried to commit incrementally and mostly stick to one package per commit. There are no stacked changes so you could review by file in HEAD and not miss anything.

Security Considerations

none

Scaling Considerations

none

Documentation Considerations

none

Testing Considerations

CI

Compatibility Considerations

Some slight changes to type interfaces but no breaking runtime changes

Upgrade Considerations

Update NEWS.md for user-facing changes.
? necessary?

hack around, /opt/agoric/endo/packages/bundle-source/demo/reexport-fortune-ts.js 0:0 error Parsing error: /opt/agoric/endo/packages/bundle-source/demo/reexport-fortune-ts.js was not found by the project service. Consider either including it in the tsconfig.json or including it in allowDefaultProject /opt/agoric/endo/packages/bundle-source/demo/reexport-meaning-js.js 0:0 error Parsing error: /opt/agoric/endo/packages/bundle-source/demo/reexport-meaning-js.js was not found by the project service. Consider either including it in the tsconfig.json or including it in allowDefaultProject

Work around: dist/types.d.cts:558:16 - error TS2300: Duplicate identifier 'Compartment'. 558 export class Compartment { ~~~~~~~~~~~ types.d.ts:559:16 559 export class Compartment { ~~~~~~~~~~~ 'Compartment' was also declared here.

Without this building exported.js fails because it would overwrite the exported.d.ts in scm

boneskull · 2025-01-15T01:34:05Z

packages/bundle-source/demo/reexport-fortune-ts.js

maybe exclude this dir from typechecking? same with other frequent @ts-nocheck directives

boneskull · 2025-01-15T01:34:59Z

packages/bundle-source/test/endo-script-format.test.js

@@ -9,6 +9,7 @@ import bundleSource from '../src/index.js';
 * @param {string} entry
 * @param {Options} options
 */
+// @ts-expect-error 'Options' could be instantiated with a different subtype of constraint 'Partial<any>'.
 const generate = async (entry, options = {}) => {


Suggested change

const generate = async (entry, options = {}) => {

const generate = async (entry, options) => {

This should suppress the error, but then you'll need to supply an empty object somewhere below

boneskull · 2025-01-15T01:36:12Z

packages/bundle-source/test/no-transforms.test.js

@@ -11,6 +11,7 @@ test('no-transforms applies no transforms', async t => {
  const entryPath = url.fileURLToPath(
    new URL(`../demo/circular/a.js`, import.meta.url),
  );
+  // @ts-expect-error Property 'endoZipBase64' does not exist on type '{ moduleFormat: "endoScript"; source: string; } | { moduleFormat: "endoZipBase64"; endoZipBase64: string; endoZipBase64Sha512: string; } | { moduleFormat: "nestedEvaluate"; source: string; sourceMap: string; } | { ...; }'.


looks like we'll need to use @overload to define bundleSource

boneskull · 2025-01-15T01:38:21Z

packages/common/test/object-meta-map.test.js

@@ -11,6 +11,7 @@ test('test objectMetaMap', async t => {
        ? undefined
        : {
            ...desc,
+            // @ts-expect-error desc.value possibly undefined


I'd probably throw a t.assert.ok(desc.value) before this statement

boneskull

many comments and questions but nothing blockworthy

boneskull · 2025-01-15T01:41:01Z

packages/compartment-mapper/test/_parse-jsonp.js

@@ -19,6 +19,7 @@ export const parseJsonp = (bytes, _specifier, _location, _packageLocation) => {
    const compartment = new Compartment({
      __options__: true,
      globals: harden({
+        // @ts-expect-error


seems like we should enable the rule that requires an explanation for use of @ts-expect-error

boneskull · 2025-01-15T01:41:45Z

packages/compartment-mapper/test/bundle.test.js

@@ -11,6 +11,7 @@ const fixture = new URL(
  import.meta.url,
 ).toString();

+// @ts-expect-error XXX Node interface munging


I wanted this to actually work. 😄

@boneskull investigate why this is causing an error

boneskull · 2025-01-15T01:43:31Z

packages/compartment-mapper/test/scaffold.js

@@ -88,7 +89,7 @@ export function scaffold(
  assertFixture,
  fixtureAssertionCount,
  {
-    onError,
+    onError = /** @type {(t, {error, title})} */ (undefined),


imo this should be a @ts-expect-error instead of this thing that is plainly untrue 😄

boneskull · 2025-01-15T01:44:01Z

packages/daemon/test/move-hub.js

@@ -37,7 +37,8 @@ export const make = () => {
  };

  /**
-   * @type {NameHub['write']}
+   * @param {string[]} petNamePath


what was wrong with NameHub? do we still need that type?

boneskull · 2025-01-15T01:44:42Z

packages/eslint-plugin/lib/configs/internal.js

    '@typescript-eslint/restrict-plus-operands': 'warn',
+    // XXX override for RESM concession below
+    '@endo/no-optional-chaining': 'off',


wait, I thought this rule was actually needed?

boneskull · 2025-01-15T01:57:06Z

packages/ses/test/property-override.test.js

@@ -122,7 +122,9 @@ test('packages in-the-wild', t => {

  function testContent6() {
    const list = [];
-    list.push = function newPush() {};
+    list.push = function newPush(...args) {
+      return args.length;


boneskull · 2025-01-15T02:00:10Z

packages/ses/test/tame-date.test.js

@@ -16,7 +16,9 @@ test('lockdown start Date is powerful', t => {
 });

 test('lockdown Date.prototype.constructor is powerless', t => {
-  const SharedDate = Date.prototype.constructor;
+  const SharedDate = /** @type {DateConstructor} */ (


Is Date not Date.prototype.constructor? cc @erights

boneskull · 2025-01-15T02:00:55Z

packages/ses/tsconfig.json

@@ -2,12 +2,15 @@
  "extends": "../../tsconfig.eslint-base.json",
  "compilerOptions": {
    "allowJs": true,
+    "skipLibCheck": true,


skipLibCheck: false probably also why linting is slow

boneskull · 2025-01-15T02:01:34Z

packages/ses/types.d.ts

@@ -135,10 +135,12 @@ export type ModuleMapHook = (
  moduleSpecifier: string,
 ) => ModuleDescriptor | undefined;
 export type ImportHook = (moduleSpecifier: string) => Promise<ModuleDescriptor>;
-export type ImportNowHook = (moduleSpecifier: string) => ModuleDescriptor;
+export type ImportNowHook = (


Is this true? Can it return undefined?

boneskull · 2025-01-15T02:05:11Z

packages/zip/test/zip.test.js

@@ -19,6 +19,7 @@ test('zip round trip', async t => {

  const reader = new ZipReader(writer.snapshot());
  const text = textDecoder.decode(reader.read('hello/hello.txt'));
+  // @ts-expect-error undefined if file not found


would probably assert the result is truthy instead

turadg added 30 commits December 30, 2024 10:01

chore: bump yarn to 4.6

1e12520

chore(deps): bump lint deps

1d2b1d1

chore(deps): bump prettier 3.4.2

49542b9

chore(deps): major bump typescript-eslint (8.18.2)

4dd027a

lint(types): include "test"

8e29780

chore(types): conform

efc3c6d

chore(types): conform 'where"

ae2f3d1

chore(types): conform "stream"

090b7b7

chore(types): conform "syrup"

f6a36a2

lint: allow optional chaining in tests

fff384e

chore(types): conform "ses"

ae19195

chore(types): conform "pass-style"

ad663a1

chore(types): conform 'module-source'

67f40c9

chore(types): conform 'netstring'

532026c

chore(types): conform 'exo'

42634d6

chore(types): conform 'far'

9d9f878

chore(types): conform 'eventual-send'

d3ba182

chore(types): conform 'captp'

5f1988c

chore(types): conform 'bundle-source'

f7846f2

chore(types): conform 'cli'

08faeb0

test: s/strip/elide/

5e5ed6c

chore(types): conform 'evasive-transform'

eaf3fad

chore(types): conform 'ses-ava'

2add234

lint(types): remove 'strict' in evasive-transform

fd9a25a

chore(types): conform 'compartment-mapper'

f8b96b6

chore(types): conform 'stream-node'

d43cf2a

chore(types): conform 'lp32'

266c10e

chore(types): conform 'import-bundle'

d6897d4

chore(types): conform 'nat'

dc9a3ee

chore(types): conform 'immutable-arraybuffer'

5616803

turadg added 8 commits December 30, 2024 12:27

chore(types): conform 'common'

3944089

chore(types): conform 'init'

a3f89e1

chore(types): conform 'zip'

1d04823

chore(types): conform 'daemon'

30fce0f

lint: include eslint-ed files in tsconfig

3c5dce5

chore(types): conform

00cd946

chore(deps): repair typescript-eslint config

7d467c8

turadg requested review from kriskowal and boneskull December 30, 2024 17:58

turadg added 3 commits December 30, 2024 13:27

fixup! test: s/strip/elide/

fd3c3f7

lint: skipLibCheck in ses

e4059e5

Work around: dist/types.d.cts:558:16 - error TS2300: Duplicate identifier 'Compartment'. 558 export class Compartment { ~~~~~~~~~~~ types.d.ts:559:16 559 export class Compartment { ~~~~~~~~~~~ 'Compartment' was also declared here.

build: omit d.ts twin from ts build

8298cdc

Without this building exported.js fails because it would overwrite the exported.d.ts in scm

turadg mentioned this pull request Jan 3, 2025

linting is too slow #2621

Open

boneskull reviewed Jan 15, 2025

View reviewed changes

boneskull approved these changes Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

typecheck tests and bump typescript-eslint #2674

typecheck tests and bump typescript-eslint #2674

turadg commented Dec 30, 2024 •

edited

Loading

boneskull Jan 15, 2025 •

edited

Loading

boneskull Jan 15, 2025

boneskull Jan 15, 2025 •

edited

Loading

boneskull Jan 15, 2025

boneskull left a comment

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

boneskull Jan 15, 2025

	const generate = async (entry, options = {}) => {
	const generate = async (entry, options) => {

typecheck tests and bump typescript-eslint #2674

Are you sure you want to change the base?

typecheck tests and bump typescript-eslint #2674

Conversation

turadg commented Dec 30, 2024 • edited Loading

Description

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Compatibility Considerations

Upgrade Considerations

boneskull Jan 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boneskull Jan 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boneskull left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

turadg commented Dec 30, 2024 •

edited

Loading

boneskull Jan 15, 2025 •

edited

Loading

boneskull Jan 15, 2025 •

edited

Loading