Add full diagnostics to tserror #1706

paulbrimicombe · 2022-04-01T13:00:41Z

This PR addresses Add error locations to TSError #1705
I've been through a few iterations and I think the nicest API is to have a mapping of the error locations for each diagnostic code.
- This allows clients to look up the location of each error code and also iterate through the object values depending on their requirements.
I've added tests for the errors that are thrown when using ts-node as a library.
- I opted to keep the tests separate for each of the assertions (error message, diagnostic codes, etc.) to make each different feature clear. I'm happy to change this.

cspotcode · 2022-04-01T15:48:59Z

Thanks for this, always happy to support consumers of our API doing cool things.

I'm inclined to expose the diagnostics directly, in exactly the form that typescript provides. That way, consumers will have everything they need no matter what they're trying to accomplish. Is that compatible with your use-case?

paulbrimicombe · 2022-04-04T12:52:32Z

Thanks for this, always happy to support consumers of our API doing cool things.

I'm inclined to expose the diagnostics directly, in exactly the form that typescript provides. That way, consumers will have everything they need no matter what they're trying to accomplish. Is that compatible with your use-case?

This is a very good plan. I've updated this PR to return the full diagnostics in the TSError. I could have moved things like the diagnostic code extraction into the TSError constructor but opted not to because that would be a breaking change strictly. Let me know what you think @cspotcode !

cspotcode

Looks good thanks again. I have one question and one note for myself.

I can do that work when I merge; I am trying to re-organize the tests slowly over time. Years ago, they were all in index.spec.ts. I'm trying to break that file apart a little bit at a time.

cspotcode · 2022-04-16T17:22:57Z

src/index.ts

+  constructor(
+    diagnosticText: string,
+    public diagnosticCodes: number[],
+    diagnostics: ReadonlyArray<_ts.Diagnostic> = []


Is this argument optional to avoid a breaking change to our API surface, since TSError is part of our API?

Is this argument optional to avoid a breaking change to our API surface, since TSError is part of our API?

Yes, that's exactly why it's optional — I didn't want to make this a breaking change.

cspotcode · 2022-04-16T17:24:15Z

src/test/index.spec.ts

+          "Argument of type '123' " +
+          "is not assignable to parameter of type 'string | undefined'.",
+      });
+    });


Note to self: consider moving these tests into a new spec file, perhaps tserror.spec.ts or throws-diagnostics.spec.ts Consider also combining it with pre-existing tests for diagnostics.

codecov · 2022-04-16T17:30:02Z

Codecov Report

Merging #1706 (b6e01c8) into main (511e0e7) will increase coverage by 0.06%.
The diff coverage is 75.00%.

Impacted Files	Coverage Δ
src/index.ts	`79.09% <75.00%> (-0.14%)`	⬇️
src/esm.ts	`84.95% <0.00%> (-0.23%)`	⬇️
dist-raw/node-errors.js	`100.00% <0.00%> (ø)`
dist-raw/node-cjs-helpers.js
dist-raw/node-esm-default-get-format.js
dist-raw/node-package-json-reader.js
dist-raw/node-cjs-loader-utils.js
dist-raw/node-repl-await.js
dist-raw/node-internal-errors.js	`94.11% <0.00%> (ø)`
... and 6 more

This reverts commit 30b78bd.

paulbrimicombe · 2022-04-25T08:29:16Z

Thanks very much for merging @cspotcode (sorry for the slow response — I've been on vacation).

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [ts-node](https://typestrong.org/ts-node) ([source](https://github.com/TypeStrong/ts-node)) | devDependencies | minor | [`10.7.0` -> `10.8.0`](https://renovatebot.com/diffs/npm/ts-node/10.7.0/10.8.0) | --- ### Release Notes <details> <summary>TypeStrong/ts-node</summary> ### [`v10.8.0`](https://github.com/TypeStrong/ts-node/releases/tag/v10.8.0) [Compare Source](TypeStrong/ts-node@v10.7.0...v10.8.0) Questions about this release? Ask in the official discussion thread: [#1767](TypeStrong/ts-node#1767) **Added** - Added support for `module=NodeNext`, `module=Node16`, `.mts`, `.cts`, `.mjs`, and `.cjs` file extensions ([#1414](TypeStrong/ts-node#1414), [#1694](TypeStrong/ts-node#1694), [#1744](TypeStrong/ts-node#1744), [#1745](TypeStrong/ts-node#1745), [#1727](TypeStrong/ts-node#1727), [#1717](TypeStrong/ts-node#1717), [#1753](TypeStrong/ts-node#1753), [#1757](TypeStrong/ts-node#1757)) [@cspotcode](https://github.com/cspotcode) - For best results, enable `experimentalResolver` ([docs](https://typestrong.org/ts-node/docs/options#experimentalresolver)) - See TypeScript's official documentation: https://www.typescriptlang.org/docs/handbook/esm-node.html - enables mixed-mode projects with both ESM and CommonJS - enables all supported file extensions in TypeScript 4.7 - Obeys package.json "type" - Added ability to include file extensions in CommonJS imports ([#1727](TypeStrong/ts-node#1727), [#1753](TypeStrong/ts-node#1753)) [@cspotcode](https://github.com/cspotcode) - Enables consistency with ESM, where file extensions are often mandatory - Resolves from emitted to source file extensions ([#1727](TypeStrong/ts-node#1727), [#1753](TypeStrong/ts-node#1753)) [@cspotcode](https://github.com/cspotcode) - Must enable `experimentalResolver`, will be enabled by default in a future version ([docs](https://typestrong.org/ts-node/docs/options#experimentalresolver)) - Typechecker requires importing the *emitted* file extension; ts-node resolves correctly to the *source* file. E.g. `import "./foo.js"` will execute `foo.ts` See also: [TypeScript issue #37582](microsoft/TypeScript#37582) - If typechecking is disabled, you can also use *source* file extensions. E.g. `import "./foo.ts"` - Added `experimentalSpecifierResolution` ([#1727](TypeStrong/ts-node#1727), [#1753](TypeStrong/ts-node#1753)) [@cspotcode](https://github.com/cspotcode) - the same as Node's `--experimental-specifier-resolution` ([Node docs](https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm)) - can also be specified in `tsconfig.json` for convenience, to avoid the CLI flag - allows omitting file extensions in ESM imports, plus a few other CommonJS-style conveniences - Adds `diagnostics` property to `TSError`, with array of TypeScript diagnostic objects from the compiler ([API docs](https://typestrong.org/ts-node/api/classes/TSError.html)) ([#1705](TypeStrong/ts-node#1705), [#1706](TypeStrong/ts-node#1706)) [@paulbrimicombe](https://github.com/paulbrimicombe) **Changed** - Renames option `experimentalResolverFeatures` to `experimentalResolver` ([docs](https://typestrong.org/ts-node/docs/options#experimentalresolver)) ([#1727](TypeStrong/ts-node#1727)) [@cspotcode](https://github.com/cspotcode) - Internal change to ESM loader for compatibility with forthcoming node versions: returns `shortCircuit: true` ([#1714](TypeStrong/ts-node#1714), [#1715](TypeStrong/ts-node#1715)) [@cspotcode](https://github.com/cspotcode) - Performance: Optimize filesystem stat calls in ESM loader and new CommonJS resolver ([#1758](TypeStrong/ts-node#1758), [#1759](TypeStrong/ts-node#1759)) [@cspotcode](https://github.com/cspotcode) - Performance, maintenance: Upgrade source-mapper dependency "[@cspotcode/source-map-support](https://github.com/cspotcode/source-map-support)" - Switches to "trace-mapping" for underlying source-map parsing ([#1729](TypeStrong/ts-node#1729)) [@cspotcode](https://github.com/cspotcode) **Fixed** - Fixed bug where REPL `.type` command was not showing any type information when using TypeScript nightly builds ([#1761](TypeStrong/ts-node#1761), [#1762](TypeStrong/ts-node#1762)) [@cspotcode](https://github.com/cspotcode) - Correctly suppress "Custom ESM Loaders" warning on newer node versions where the warning's prose changed ([#1701](TypeStrong/ts-node#1701)) [@cspotcode](https://github.com/cspotcode) - Fixed REPL bug where function signatures could not be entered across multiple lines ([#1667](TypeStrong/ts-node#1667), [#1677](TypeStrong/ts-node#1677)) [@d9k](https://github.com/d9k) - REPL treats unparenthesized object literals as objects, instead of as block scopes ([#1697](TypeStrong/ts-node#1697), [#1699](TypeStrong/ts-node#1699)) [@jhmaster2000](https://github.com/jhmaster2000) - Fixed bug where `preferTsExts` combined with third-party transpiler hooks could disrupt `nyc` code coverage ([#1755](TypeStrong/ts-node#1755)) [@cspotcode](https://github.com/cspotcode) - Fixed bug where `file://` URLs in stack traces did not always use percent-encoding ([#1738](TypeStrong/ts-node#1738), [#1726](TypeStrong/ts-node#1726), [#1729](TypeStrong/ts-node#1729)) [@cspotcode](https://github.com/cspotcode) - Fixed bug where v8-compile-cache-lib did not correctly unhook itself ([#1717](TypeStrong/ts-node#1717), [#1718](TypeStrong/ts-node#1718), [#1719](TypeStrong/ts-node#1719)) [@cspotcode](https://github.com/cspotcode) - This internal dependency is used to speed up loading the TypeScript compiler **Docs** - Many docs improvements ([#1682](TypeStrong/ts-node#1682)) [@cspotcode](https://github.com/cspotcode) - Options page: each option its own linkable header w/usage example ([#1606](TypeStrong/ts-node#1606)) [@cspotcode](https://github.com/cspotcode) - Categorize APIs in typedoc, make entrypoints more prominent ([#1456](TypeStrong/ts-node#1456)) [@cspotcode](https://github.com/cspotcode) - Clarify that the shorthand for `--project` is `-P`, not `-p` ([#1731](TypeStrong/ts-node#1731), [#1734](TypeStrong/ts-node#1734)) [@lobsterkatie](https://github.com/lobsterkatie) - Add common ESM errors to Troubleshooting page ([#1607](TypeStrong/ts-node#1607)) [@cspotcode](https://github.com/cspotcode) https://github.com/TypeStrong/ts-node/milestone/12 </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1367 Reviewed-by: crapStone <crapstone@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

paulbrimicombe added 2 commits April 1, 2022 13:30

Add error locations to TSErrors

4938d99

Simplify tests / code formatting

428e506

cspotcode added this to the 10.8.0 milestone Apr 1, 2022

Expose the full TypeScript diagnostics on TSErrors

7fb714a

paulbrimicombe changed the title ~~Add error locations to tserror~~ Add full diagnostics to tserror Apr 4, 2022

cspotcode approved these changes Apr 16, 2022

View reviewed changes

cspotcode added 15 commits April 16, 2022 13:57

Test re-org and deduplication

f7afcab

lintfix

e0560d8

fix

b5d6ef6

bang head against wall

a5f64f5

lintfix

47f769b

fix

992796b

fix

52fcbda

fix

5143a48

fix

9a0d071

fix

08a95c6

tweaks

30b78bd

Revert "tweaks"

217e955

This reverts commit 30b78bd.

fix

715d3ac

finally

cd107ed

fix

b6e01c8

cspotcode merged commit deef947 into TypeStrong:main Apr 17, 2022

cspotcode linked an issue Apr 17, 2022 that may be closed by this pull request

Add error locations to TSError #1705

Closed

paulbrimicombe deleted the add-error-locations-to-tserror branch April 26, 2022 08:04

sync-by-unito bot mentioned this pull request Jun 1, 2022

build(deps-dev): bump ts-node from 10.2.1 to 10.8.0 numbersprotocol/capture-lite#1678

Closed

This was referenced Jul 1, 2022

build(deps-dev): bump ts-node from 10.2.1 to 10.8.1 numbersprotocol/capture-lite#1768

Closed

build(deps-dev): bump ts-node from 10.2.1 to 10.8.2 numbersprotocol/capture-lite#1788

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add full diagnostics to tserror #1706

Add full diagnostics to tserror #1706

paulbrimicombe commented Apr 1, 2022

cspotcode commented Apr 1, 2022

paulbrimicombe commented Apr 4, 2022

cspotcode left a comment

cspotcode Apr 16, 2022

paulbrimicombe Apr 25, 2022

cspotcode Apr 16, 2022

codecov bot commented Apr 16, 2022 •

edited

paulbrimicombe commented Apr 25, 2022

Add full diagnostics to tserror #1706

Add full diagnostics to tserror #1706

Conversation

paulbrimicombe commented Apr 1, 2022

cspotcode commented Apr 1, 2022

paulbrimicombe commented Apr 4, 2022

cspotcode left a comment

Choose a reason for hiding this comment

cspotcode Apr 16, 2022

Choose a reason for hiding this comment

paulbrimicombe Apr 25, 2022

Choose a reason for hiding this comment

cspotcode Apr 16, 2022

Choose a reason for hiding this comment

codecov bot commented Apr 16, 2022 • edited

Codecov Report

paulbrimicombe commented Apr 25, 2022

codecov bot commented Apr 16, 2022 •

edited