Move to ESM, remove `index.d.ts` requirement #186

tommy-mitchell · 2023-03-15T05:16:54Z

Closes #183.
Closes #191.
Closes #175.

Checklist:

Update tsconfig.tsd.json
- Set module to node16
- Set target to ES2020
Update package.json
- Add "type": "module"
- Update to AVA v5.2.0, add tsx for transpilation
- Inline clean script
Add .js to relative imports in source and test files
Make sure that Node builtins use the node: protocol
Update dependencies
Update tsd's defaults (tsd doesn't catch missing extensions in declaration files #191)

We should also update the assertion definitions to use const type parameters.

Speaking of tests, trying to run AVA causes errors with @tsd/typescript:

npx ava source/test/test.ts

(node:69218) ExperimentalWarning: --experimental-loader is an experimental feature. This feature could change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
  Uncaught exception in source/test/test.ts

  SyntaxError: The requested module '@tsd/typescript' does not provide an export named 'TypeFormatFlags'

  ✘ source/test/test.ts exited with a non-zero exit code: 1
  ─

  1 uncaught exception

In addition, updating AVA means that t.throwsAsync can also return undefined:

test('failure', async t => {
	const cwd = path.join(__dirname, 'fixtures/failure');
	const {exitCode} = await t.throwsAsync<ExecaError>(execa('../../../cli.js', {cwd}));
	//=> Property 'exitCode' does not exist on type 'ExecaError | undefined'.

	t.is(exitCode, 1);
});

cc: @sindresorhus

tommy-mitchell · 2023-03-15T07:21:49Z

Using tsx would resolve #175 as well.

mrazauskas · 2023-03-15T08:15:46Z

By the way, this is 100% breaking change for programmatic API users. Perhaps #75 could be considered? Would be enough to return an object. This would make it easier to add any additional props in the future.

The #75 was needed for jest-runner-tsd, but it was rather unclear if that will ever happen. I fork tsd and released tsd-lite. You might be interested to look around:

@tsd/typescript package is moved to peer dependencies to allow testing on different versions of TS;
works with monorepos;
has less bugs. For instance, Non-type exports defined by package.json exports are typed as any #174 or test pass with both expectType and expectNotType, pls help me understand #141 is not an issue.

sindresorhus · 2023-03-16T06:10:04Z

What's the benefit of using .tsx? It's not clear to me.

sindresorhus · 2023-03-16T06:10:37Z

I think what you want is this: https://devblogs.microsoft.com/typescript/announcing-typescript-5-0-beta/#allowimportingtsextensions

sindresorhus · 2023-03-16T06:11:22Z

SyntaxError: The requested module '@tsd/typescript' does not provide an export named 'TypeFormatFlags'

The ES module resolution is stricter about exports. Make sure it's actually exported correctly.

tommy-mitchell · 2023-03-16T08:23:20Z

What's the benefit of using .tsx? It's not clear to me.

tsx is a tool like ts-node for transpiling TS in-memory. The name comes from modeling npx. It’s faster than ts-node and works better with ESM, but skips type checking.

The naming is unfortunate.

avajs/ava#2593 (comment)

sindresorhus · 2023-04-04T00:47:39Z

tsx is a tool like ts-node for transpiling TS in-memory. The name comes from modeling npx. It’s faster than ts-node and works better with ESM, but skips type checking.

Ok. We definitely want type checking to ensure they are valid. But we could also just run tsc --noEmit before to type check.

sindresorhus · 2023-04-04T00:48:01Z

Let me know if anything is blocked on me commenting on something.

tommy-mitchell · 2023-04-04T00:54:44Z

But we could also just run tsc --noEmit before to type check.

I decided to go with that as well. I've been doing more locally, you're fine.

SyntaxError: The requested module '@tsd/typescript' does not provide an export named 'TypeFormatFlags'

TypeFormatFlags is an enum exported bytypescript itself. I'm going to see if using ts-node works instead.

Re: #75, should we close that PR and open a new one? It's definitely stale, and the diff is pretty extraneous at this point. I can open a reminder issue.

sindresorhus · 2023-04-04T01:43:31Z

Re: #75, should we close that PR and open a new one? It's definitely stale, and the diff is pretty extraneous at this point. I can open a reminder issue.

Yes

tommy-mitchell · 2023-04-04T02:47:06Z

Seems like the issue with the tests is that they are being transpiled to CJS, but since "type": "module" is set the tests throw.

Related, is there a reason that we have tsconfig.tsd.json and not tsconfig.json?

sindresorhus · 2023-04-04T02:51:13Z

Related, is there a reason that we have tsconfig.tsd.json and not tsconfig.json?

#100

tommy-mitchell · 2023-04-04T03:35:16Z

I've uploaded some more changes (tests are still failing). I'll resolve the merge conflicts.

A couple highlights: moved to xo for linting, updated the test script, and consolidated the tests via macros (still need to do so for the CLI tests).

tommy-mitchell · 2023-04-05T01:27:05Z

SyntaxError: The requested module '@tsd/typescript' does not provide an export named 'TypeFormatFlags'

The ES module resolution is stricter about exports. Make sure it's actually exported correctly.

Turns out this is because the TypeScript compiler is CJS: microsoft/TypeScript#32949

source/test/cli.ts

sindresorhus · 2023-08-31T11:19:50Z

@tommy-mitchell Just a reminder that this is still open. If you're simply busy, feel free to ignore this.

tommy-mitchell · 2023-08-31T16:38:35Z

@sindresorhus this is on my todo list, I’ve got some local changes that are unpushed. If you have some time, I’d love your feedback on #196

sindresorhus · 2023-11-07T17:34:36Z

source/lib/config.ts

 	);

 	const combinedCompilerOptions = {
 		...tsConfigCompilerOptions,
 		...packageJsonCompilerOptions,
 	};

-	const module = combinedCompilerOptions.module ?? ModuleKind.CommonJS;
+	const module = combinedCompilerOptions.module ?? ts.ModuleKind.CommonJS;


Suggested change

const module = combinedCompilerOptions.module ?? ts.ModuleKind.CommonJS;

const module = combinedCompilerOptions.module ?? (pkg.type === 'module' ? ts.ModuleKind.Node16 : ts.ModuleKind.CommonJS);

?

Thoughts on these defaults?

function getModuleResolution(module: ts.ModuleKind): ts.ModuleResolutionKind { if (module === ts.ModuleKind.NodeNext) { return ts.ModuleResolutionKind.NodeNext; } if (module === ts.ModuleKind.Node16) { return ts.ModuleResolutionKind.Node16; } if (module === ts.ModuleKind.ES2020 || module === ts.ModuleKind.ES2022 || module === ts.ModuleKind.ESNext) { return ts.ModuleResolutionKind.Bundler; } // Fallback to Node16 return ts.ModuleResolutionKind.Node16; }

tommy-mitchell · 2024-02-23T02:22:29Z

Ended up removing the index.d.ts requirement in this PR because it was giving me trouble with tests. Merged the changes from main. Next steps:

Update tsd's defaults
Update PR description (e.g. this also includes a change the build script, added @sindresorhus/tsconfig, support for more ts extensions)
Fix test failures (CLI tests in particular don't seem to be working)
Update documentation to reflect ESM / index.d.ts changes (more doc improvements can be saved for another PR)

tommy-mitchell · 2024-02-23T02:23:23Z

Are we still supporting testing types in CJS packages after moving to ESM?

tommy-mitchell · 2024-02-23T02:35:22Z

Seems like xo is failing because it can't find a tsconfig.json, even though I set it in parserOptions.project:

file:///home/runner/work/tsd/tsd/node_modules/xo/lib/options-manager.js:163
		options.tsConfig = tsConfigResolvePaths(getTsconfig(options.tsConfigPath).config, options.tsConfigPath);
		                                                                         ^

TypeError: Cannot read properties of null (reading 'config')
    at handleTSConfig (file:///home/runner/work/tsd/tsd/node_modules/xo/lib/options-manager.js:163:76)
    at mergeWithFileConfig (file:///home/runner/work/tsd/tsd/node_modules/xo/lib/options-manager.js:137:19)
    at async parseOptions (file:///home/runner/work/tsd/tsd/node_modules/xo/lib/options-manager.js:578:51)
    at async Promise.all (index 0)
    at async getOptionGroups (file:///home/runner/work/tsd/tsd/node_modules/xo/lib/options-manager.js:594:21)
    at async Object.lintFiles (file:///home/runner/work/tsd/tsd/node_modules/xo/index.js:80:17)
    at async file:///home/runner/work/tsd/tsd/node_modules/xo/cli.js:212:18

tommy-mitchell · 2024-02-23T02:39:16Z

Seems like there should be a way for us to just tsconfig.json directly, I'll try to see if I can do that without running into the issues from #100.

sindresorhus · 2024-02-23T03:11:08Z

Are we still supporting testing types in CJS packages after moving to ESM?

No

tommy-mitchell added 4 commits March 14, 2023 23:28

chore(esm): update tsconfig

6224ac2

chore(esm): update package.json, add tsx for testing

88f2e6d

chore(ava): upgrade to v5.2.0

79789f1

chore(esm): update relative imports in source

28843f4

chore: update deps, move to xo

8a395db

sindresorhus mentioned this pull request Apr 4, 2023

tsd doesn't catch missing extensions in declaration files #191

Open

chore: merge, update, lint, add test macros

723cb47

tests(cli): add macros

8d4559b

tommy-mitchell added 2 commits April 4, 2023 20:43

refactor: update @tsd/typescript imports for ESM

5910563

tests: add more macros

3d54b57

tommy-mitchell commented Apr 5, 2023

View reviewed changes

source/test/cli.ts Show resolved Hide resolved

tests: start converting fixtures to ESM

47de976

tommy-mitchell mentioned this pull request Aug 16, 2023

Towards v1.0.0 #196

Open

Update config.ts

22a816d

sindresorhus added 3 commits November 8, 2023 00:35

Update package.json

c91e9ab

Update tsconfig.tsd.json

7f92ab4

Update main.yaml

69aff05

sindresorhus requested changes Nov 7, 2023

View reviewed changes

tommy-mitchell added 2 commits February 20, 2024 19:14

Merge branch 'main' into feat-transpile-tests

9c0a79a

update deps, remove index.d.ts rule, style updates, bundle types

13e610c

tommy-mitchell changed the title ~~Move to ESM~~ Move to ESM, remove index.d.ts requirement Feb 23, 2024

tommy-mitchell added 3 commits February 22, 2024 20:25

rename workflow to .yml to match editorconfig

1e98611

add Node.js 21 to test matrix

cc77650

provide tsconfig.tsd.json path to xo

ca4f46e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move to ESM, remove `index.d.ts` requirement #186

Move to ESM, remove `index.d.ts` requirement #186

tommy-mitchell commented Mar 15, 2023 •

edited

Loading

tommy-mitchell commented Mar 15, 2023

mrazauskas commented Mar 15, 2023

sindresorhus commented Mar 16, 2023

sindresorhus commented Mar 16, 2023

sindresorhus commented Mar 16, 2023 •

edited

Loading

tommy-mitchell commented Mar 16, 2023

sindresorhus commented Apr 4, 2023

sindresorhus commented Apr 4, 2023

tommy-mitchell commented Apr 4, 2023

sindresorhus commented Apr 4, 2023

tommy-mitchell commented Apr 4, 2023

sindresorhus commented Apr 4, 2023

tommy-mitchell commented Apr 4, 2023

tommy-mitchell commented Apr 5, 2023

sindresorhus commented Aug 31, 2023

tommy-mitchell commented Aug 31, 2023

sindresorhus Nov 7, 2023

tommy-mitchell Feb 23, 2024

tommy-mitchell commented Feb 23, 2024 •

edited

Loading

tommy-mitchell commented Feb 23, 2024 •

edited

Loading

tommy-mitchell commented Feb 23, 2024 •

edited

Loading

tommy-mitchell commented Feb 23, 2024

sindresorhus commented Feb 23, 2024

	const module = combinedCompilerOptions.module ?? ts.ModuleKind.CommonJS;
	const module = combinedCompilerOptions.module ?? (pkg.type === 'module' ? ts.ModuleKind.Node16 : ts.ModuleKind.CommonJS);

Move to ESM, remove index.d.ts requirement #186

Are you sure you want to change the base?

Move to ESM, remove index.d.ts requirement #186

Conversation

tommy-mitchell commented Mar 15, 2023 • edited Loading

tommy-mitchell commented Mar 15, 2023

mrazauskas commented Mar 15, 2023

sindresorhus commented Mar 16, 2023

sindresorhus commented Mar 16, 2023

sindresorhus commented Mar 16, 2023 • edited Loading

tommy-mitchell commented Mar 16, 2023

sindresorhus commented Apr 4, 2023

sindresorhus commented Apr 4, 2023

tommy-mitchell commented Apr 4, 2023

sindresorhus commented Apr 4, 2023

tommy-mitchell commented Apr 4, 2023

sindresorhus commented Apr 4, 2023

tommy-mitchell commented Apr 4, 2023

tommy-mitchell commented Apr 5, 2023

sindresorhus commented Aug 31, 2023

tommy-mitchell commented Aug 31, 2023

sindresorhus Nov 7, 2023

Choose a reason for hiding this comment

tommy-mitchell Feb 23, 2024

Choose a reason for hiding this comment

tommy-mitchell commented Feb 23, 2024 • edited Loading

tommy-mitchell commented Feb 23, 2024 • edited Loading

tommy-mitchell commented Feb 23, 2024 • edited Loading

tommy-mitchell commented Feb 23, 2024

sindresorhus commented Feb 23, 2024

Move to ESM, remove `index.d.ts` requirement #186

Move to ESM, remove `index.d.ts` requirement #186

tommy-mitchell commented Mar 15, 2023 •

edited

Loading

sindresorhus commented Mar 16, 2023 •

edited

Loading

tommy-mitchell commented Feb 23, 2024 •

edited

Loading

tommy-mitchell commented Feb 23, 2024 •

edited

Loading

tommy-mitchell commented Feb 23, 2024 •

edited

Loading