Fix TS 4.7 compatibility #3024

RebeccaStevens · 2022-05-18T05:30:31Z

See TS 4.7-rc Release Notes for details.

novemberborn · 2022-05-18T08:37:59Z

@RebeccaStevens is this a required change for TypeScript 4.7 / Node.js 16 compatibility?

I do want to use this feature to distribute ESM and CJS type definitions. I was thinking we'd look at that when 4.7 ships as part of AVA 5. (We can drop Node.js 12 support anyway.)

RebeccaStevens · 2022-05-18T08:51:12Z

From my testing so far, it seems to be required.

I did read somewhere that top level exports should still grab the top level "types" field from package.json if there isn't a more specific one defined in the "exports" field. But from my testing this doesn't seem to be the case at the moment. (Maybe it will be fixed when 4.7 stable is released).

RebeccaStevens · 2022-05-18T09:15:40Z

See this comment for why I added .d.cts files.
microsoft/TypeScript#46408 (comment)

Edit: This doesn't work as I expected. I'll probably revert the last commit but it seem like a bad idea to dupe all the type files. Maybe a build step would be wanted to this?

Alternatively, it seem that if the .js file extension is used instead of .cjs for the CJS, both ESM and CJS can use the same .d.ts file.

novemberborn · 2022-05-20T08:37:58Z

index.d.cts

@@ -0,0 +1,2 @@
+export * from ".";
+export { default } from ".";


What does this imply? Can we model the module.exports = test behavior, as well as exporting the types?

Hey, I've gotten a bit better of an idea now as to how this new typing thing works. I'll update this pr soon to improve things.

RebeccaStevens · 2022-05-20T12:47:10Z

@novemberborn From my testing, this latest push I made seems to be working properly.

~~Will want to wait for a reply to this comment first before proceeding though.~~

RebeccaStevens · 2022-05-21T08:24:08Z

Seems like everything is good to go.

novemberborn · 2022-05-22T15:31:31Z

@RebeccaStevens what do you think about making TS 4.7 the minimum version in AVA 5? I think that would make it possible to include some tests for these new file formats, no?

I've tried some local files but I can't get test.cts to compile:

const test = require('ava')

test('foo', t => t.pass())

{
  "compilerOptions": {
    "target": "es2022",
    "moduleResolution": "node16",
    "strict": true,
  }
}

test.cts:3:13 - error TS7006: Parameter 't' implicitly has an 'any' type.

3 test('foo', t => t.pass())
              ~


Found 1 error in test.cts:3

RebeccaStevens · 2022-05-23T11:02:36Z

So in .cts files, it seems that you need to use import test = require("ava") to get the right types.
In .cjs files, const test = require("ava") should work but it seems like it's loading the esm types instead of the cjs types. I'm not sure why this is, it might be a TypeScript bug.

I haven't been following Ava 5's development so I can't really comment on it requiring TS 4.7+. However, it should still be possible to write tests for these new types without this requirement; the tests would just have to run in TS 4.7 environment.

novemberborn · 2022-05-23T11:56:42Z

So in .cts files, it seems that you need to use import test = require("ava") to get the right types.

That's… surprising. Does const test = require("ava") work in .ts files targeting CommonJS?

In .cjs files, const test = require("ava") should work but it seems like it's loading the esm types instead of the cjs types. I'm not sure why this is, it might be a TypeScript bug.

😞

I haven't been following Ava 5's development so I can't really comment on it requiring TS 4.7+. However, it should still be possible to write tests for these new types without this requirement; the tests would just have to run in TS 4.7 environment.

There isn't any development as such. Dropping Node.js 12 requires a major bump, so once this is in AVA 4 it could be nice to upgrade to TS 4.7 as the recommended/tested setup.

I've added the 4.7 RC to the test matrix.

RebeccaStevens · 2022-05-27T13:34:59Z

@novemberborn TS 4.7 has launched. Is there any blockers left for this?

Also, with regards to Ava 5, I think it would be a good idea to up level all the code to esm and then down level to cjs with a build tool. The current approach of just defining esm that imports the cjs code can lead to a few issues. I could look into creating a PR for this if you like. Has any work been done specifically for Ava 5 yet?

RebeccaStevens · 2022-05-29T10:29:16Z

microsoft/TypeScript#49299

novemberborn · 2022-05-29T15:20:43Z

The current approach of just defining esm that imports the cjs code can lead to a few issues.

Could you elaborate?

Has any work been done specifically for Ava 5 yet?

No, it's just that removing Node.js 12 from the test matrix requires a major version bump, so we have an opportunity to set some new baselines.

This is both tidier and ensures they're included in the package. Also rename the import in main.d.cts.

novemberborn · 2022-05-29T16:49:04Z

I can't figure this out.

{
  "name": "tmp.78i8xvt0sd",
  "version": "1.0.0",
  "devDependencies": {
    "@sindresorhus/tsconfig": "^3.0.1",
    "@types/node": "^16.11.36",
    "ava": "github:RebeccaStevens/ava#node16-types-exports",
    "typescript": "^4.7.2"
  }
}

{
  "extends": "@sindresorhus/tsconfig"
}

But for test.ts and test.cts:

const test = require('ava')

test('pass', t => t.pass())

I get:

> npx tsc --noEmit
test.cts:3:14 - error TS7006: Parameter 't' implicitly has an 'any' type.

3 test('pass', t => t.pass())
               ~

test.ts:3:14 - error TS7006: Parameter 't' implicitly has an 'any' type.

3 test('pass', t => t.pass())
               ~


Found 2 errors in 2 files.

Errors  Files
     1  test.cts:3
     1  test.ts:3

It's fine for ESM, but CommonJS doesn't seem to be working with TS 4.7.

novemberborn · 2022-05-29T16:53:00Z

Changing to import test = require('ava') makes it worse:

test.ts:1:23 - error TS7016: Could not find a declaration file for module 'ava'. '/avajs/ava/entrypoints/main.cjs' implicitly has an 'any' type.
  If the 'ava' package actually exposes this module, try adding a new declaration (.d.ts) file containing `declare module 'ava';`

1 import test = require('ava')

novemberborn · 2022-05-29T16:54:18Z

@sindresorhus what's your understanding of all this?

I've also tried with the following main.d.cts but it makes no difference:

import type {TestFn} from './test-fn.js';

/** Call to declare a test, or chain to declare hooks or test modifiers */
declare const test: TestFn;

/** Call to declare a test, or chain to declare hooks or test modifiers */
export = test;

RebeccaStevens · 2022-05-30T03:05:54Z

@novemberborn It looks like my attempt to reuse code has failed and we're going to need to duplicate the type files :(

Oh well. I'll push a fix soon.

RebeccaStevens · 2022-05-30T03:29:49Z

@novemberborn Push a fix, though I may have undone some of your commits. Feel free to remake them.

RebeccaStevens · 2022-05-30T07:39:38Z

With typescript@next the following is valid and thus wouldn't require duplicated the type files.

import type TestFn from "../index.js" assert { "resolution-mode": "import" };

declare const test: typeof TestFn;
export = test;

RebeccaStevens · 2022-05-30T10:26:00Z

With TypeScript 4.8 we can go back to reusing definitions?

I think so but we'll have to wait and see.

RebeccaStevens · 2022-05-30T10:26:57Z

It is my understanding this is just how TS 4.7 is meant to behave?

Yes, I believe so.

RebeccaStevens · 2022-05-30T10:37:05Z

The current approach of just defining esm that imports the cjs code can lead to a few issues.

Could you elaborate?

main.mjs imports main.cjs:

export {default} from '../lib/worker/main.cjs';

So some of the issue we are experiencing with this PR can happen with the actually JavaScript when mixing esm and cjs. There's an issue open in chai which uses this same approach.
Additionally, in environments that only support esm and not cjs, everything will fail.

novemberborn · 2022-05-30T11:20:33Z

Everything is fine but VScode is still using TS 4.6 be default. If you tell VScode to use the workspace version of TS then problem goes away.

It's not working with npx tsc though:

test.ts:2:14 - error TS2305: Module '"ava"' has no exported member 'Macro'.

2 import type {Macro} from 'ava'
               ~~~~~

novemberborn · 2022-05-30T11:21:50Z

The current approach of just defining esm that imports the cjs code can lead to a few issues.

Could you elaborate?

main.mjs imports main.cjs:
export {default} from '../lib/worker/main.cjs';
So some of the issue we are experiencing with this PR can happen with the actually JavaScript when mixing esm and cjs. There's an issue open in chai which uses this same approach. Additionally, in environments that only support esm and not cjs, everything will fail.

We're not considering any tools that compile the AVA code. This all seems to be working fine given that we have CJS and ESM entrypoints.

RebeccaStevens · 2022-05-30T11:38:10Z

Everything is fine but VScode is still using TS 4.6 be default. If you tell VScode to use the workspace version of TS then problem goes away.

It's not working with npx tsc though:
test.ts:2:14 - error TS2305: Module '"ava"' has no exported member 'Macro'.

2 import type {Macro} from 'ava'
               ~~~~~

It's working for me. Try ./node_modules/.bin/tsc; you might have an older version of TS install globally that npx tsc is referring to.

RebeccaStevens · 2022-05-30T11:40:39Z

The current approach of just defining esm that imports the cjs code can lead to a few issues.

Could you elaborate?

main.mjs imports main.cjs:
export {default} from '../lib/worker/main.cjs';
So some of the issue we are experiencing with this PR can happen with the actually JavaScript when mixing esm and cjs. There's an issue open in chai which uses this same approach. Additionally, in environments that only support esm and not cjs, everything will fail.
We're not considering any tools that compile the AVA code. This all seems to be working fine given that we have CJS and ESM entrypoints.

It works fine at a surface level but it's kind of fragile.

novemberborn · 2022-05-30T11:53:50Z

I think the type exports are only missing for the CJS files. Which makes sense because they're not exported there.

I'm not sure how to combine a type export with the export = syntax though.

RebeccaStevens · 2022-05-30T12:03:17Z

I think the type exports are only missing for the CJS files. Which makes sense because they're not exported there.

I'm not sure how to combine a type export with the export = syntax though.

Same. As far as I know, it's not possible but maybe some one else can find a solution.

In TS 4.8, the types will be able to be imported with a resolution mode assertion, thus allowing the types to be used in a cjs environment. But ideally we'd like to work without needing this.

novemberborn · 2022-05-30T12:30:00Z

OK, so then we can't use export = test. With an export default test you can do import ava = require('ava') and ava.default() in *.cts files. Which isn't ideal but let's blame TS 4.7.

A CJS target, using ESM syntax, works fine. But I suspect we then don't need any separate files.

novemberborn · 2022-05-30T12:31:09Z

But I suspect we then don't need any separate files.

Hold that thought…

novemberborn · 2022-05-30T12:34:28Z

@RebeccaStevens see my commits. Does this work all right for you?

novemberborn · 2022-05-30T12:36:18Z

It's probably best to think about the import and export stuff as TypeScript syntax, which is then emitted into JavaScript based on the configuration. And it is still the recommended syntax, even in .d.cts files, except for .cts files which are just weird.

RebeccaStevens · 2022-05-30T12:38:44Z

I believe with allowSyntheticDefaultImports, .cts files can use import test from "Ava".

RebeccaStevens · 2022-05-30T12:42:55Z

@RebeccaStevens see my commits. Does this work all right for you?

No, I'm getting errors in cjs context.

novemberborn · 2022-05-30T12:55:28Z

I believe with allowSyntheticDefaultImports, .cts files can use import test from "Ava".

Ah yes that seems to work.

No, I'm getting errors in cjs context.

Could you share the specific syntax? My local test files seem fine 😕

RebeccaStevens · 2022-05-30T13:58:45Z

Here's some screenshots of how things appear on my end.

RebeccaStevens · 2022-05-30T14:00:39Z

We should be able to resolve the missing types in cjs based on this comment: microsoft/TypeScript#49299 (comment)

novemberborn · 2022-05-30T14:29:42Z

We should be able to resolve the missing types in cjs based on this comment: microsoft/TypeScript#49299 (comment)

Aha! Let's try that.

Your CTS failure is because with my changes that now has to be import ava = require('ava') with ava.default(), which is super awkward.

novemberborn · 2022-05-30T15:39:43Z

We should be able to resolve the missing types in cjs based on this comment: microsoft/TypeScript#49299 (comment)

Aha! Let's try that.

Except… the test function implements an interface. I'm not sure we can merge that with a namespace.

novemberborn · 2022-05-30T15:47:55Z

OK so we can do export const after: AfterFn etc, so that sort of works, except you can then also import type {after}.

novemberborn · 2022-05-31T09:11:38Z

I'm inclined to leave it like this. We can look at exporting test, serial and maybe some others as members in a future release which should improve ergonomics.

novemberborn · 2022-06-02T12:09:23Z

Thanks for your help with this @RebeccaStevens!

novemberborn reviewed May 20, 2022

View reviewed changes

fix: export type information for node16 module resolution

39abeec

RebeccaStevens force-pushed the node16-types-exports branch from 1c23d43 to 39abeec Compare May 20, 2022 12:44

novemberborn added 2 commits May 22, 2022 17:20

Test type definitions with TS 4.6 and 4.7

484fe31

Merge branch 'main' into node16-types-exports

36aab5e

novemberborn mentioned this pull request May 22, 2022

Add "types" entries to the "exports" property of package.json, to allow consumption from Typescript with the new Node16 module resolution strategy avajs/typescript#42

Closed

sindresorhus mentioned this pull request May 26, 2022

Require Node.js 14 and TypeScript 4.7 sindresorhus/ow#238

Merged

2 tasks

novemberborn mentioned this pull request May 29, 2022

Could not find a declaration file for module 'ava'. 'node_modules/ava/entrypoints/main.mjs' implicitly has an 'any' type. #2934

Closed

Test with official TS 4.7

7ed3a5a

Place .d.cts files in types/

f815557

This is both tidier and ensures they're included in the package. Also rename the import in main.d.cts.

Point at correct files

fdb302a

novemberborn changed the title ~~fix: export type information for node16 module resolution~~ Fix TS 4.7 compatibility May 29, 2022

RebeccaStevens force-pushed the node16-types-exports branch from b513102 to 7f58e5e Compare May 30, 2022 03:29

novemberborn added 2 commits May 30, 2022 14:33

Re-export using ESM syntax

254e78d

Move cts entrypoints

09766a9

novemberborn added 3 commits May 31, 2022 15:45

Update documentation for the test.default property

c153eba

Provide more examples on how to import AVA

ae3c570

Remove unnecessary entries from files list

2a54858

sindresorhus mentioned this pull request Jun 2, 2022

Typings issue with v3 sindresorhus/tsconfig#19

Closed

novemberborn merged commit c218a21 into avajs:main Jun 2, 2022

		@@ -0,0 +1,2 @@
		export * from ".";
		export { default } from ".";

Fix TS 4.7 compatibility #3024

Fix TS 4.7 compatibility #3024

Conversation

RebeccaStevens commented May 18, 2022

novemberborn commented May 18, 2022 • edited Loading

RebeccaStevens commented May 18, 2022

RebeccaStevens commented May 18, 2022 • edited Loading

novemberborn May 20, 2022

Choose a reason for hiding this comment

RebeccaStevens May 20, 2022

Choose a reason for hiding this comment

RebeccaStevens commented May 20, 2022 • edited Loading

RebeccaStevens commented May 21, 2022

novemberborn commented May 22, 2022

RebeccaStevens commented May 23, 2022

novemberborn commented May 23, 2022

RebeccaStevens commented May 27, 2022

RebeccaStevens commented May 29, 2022

novemberborn commented May 29, 2022

novemberborn commented May 29, 2022

novemberborn commented May 29, 2022

novemberborn commented May 29, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 30, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022

novemberborn commented May 30, 2022

RebeccaStevens commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 30, 2022

RebeccaStevens commented May 30, 2022

RebeccaStevens commented May 30, 2022 • edited Loading

novemberborn commented May 30, 2022

RebeccaStevens commented May 30, 2022 • edited Loading

RebeccaStevens commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 30, 2022

novemberborn commented May 31, 2022

novemberborn commented Jun 2, 2022

novemberborn commented May 18, 2022 •

edited

Loading

RebeccaStevens commented May 18, 2022 •

edited

Loading

RebeccaStevens commented May 20, 2022 •

edited

Loading

RebeccaStevens commented May 30, 2022 •

edited

Loading

RebeccaStevens commented May 30, 2022 •

edited

Loading