ts-node

Questions about this release? Ask in the official discussion thread

Breaking changes are prefixed with [BREAKING]

Added

• Adds --show-config to log the resolved configuration (docs) (#1100, #1243)

• Bundle and re-export @tsconfig/node* configurations for convenience (docs) (#1202, #1236, #1313)

• Default to appropriate @tsconfig/node* configuration based on node and typescript versions (docs) (#1202, #1236, #1313)

• Automatically reference @types/node; use globally-installed @types/node if not locally installed (#1240, #1257)

• Add swc integration and new --transpiler option to use third-party transpilers for a massive speed boost on large codebases (docs) (#779, #1160)

• Add scopeDir API option (docs)

• Add projectSearchDir API option (docs)

• Add --cwd-mode and ts-node-cwd to resolve config file relative to cwd, not entrypoint script

Changed

• breaking

  **** Make --script-mode default behavior; resolve tsconfig relative to entrypoint script instead of cwd (#949, #1197, #1155)

  • In most cases this change will have no noticeable effect

  • Primarily benefits portable shell scripts on your $PATH, because ts-node will respect the script's local tsconfig.json

  • Use --cwd-mode or ts-node-cwd if you need legacy behavior

• breaking

  **** ignore rules evaluate relative to tsconfig.json directory, otherwise cwd

• breaking

  **** Remove support for node 10. Minimum supported version is node 12

• Rename --dir to --cwd; rename TS_NODE_DIR to TS_NODE_CWD

  • --dir and TS_NODE_DIR are deprecated but still parsed for backwards-compatibility

  • --dir effectively changed the working directory of ts-node; renaming makes this behavior more obvious

Deprecated

• deprecated

  Deprecate TS_NODE_SCOPE

• deprecated

  Deprecate --dir and TS_NODE_DIR

Removed

• breaking

  **** Internal APIs removed from type declarations

  • Removed DEFAULTS, normalizeSlashes, parse, split

  • No features were removed

  • This will only affect consumers of ts-node's programmatic API

Fixed

• breaking

  **** Fix #1229 and #1235: always throw ERR_REQUIRE_ESM when attempting to execute ESM as CJS, even when not using --loader ts-node/esm

  • This aligns our behavior with vanilla node

• breaking

  **** Fix #1225: compiler is loaded relative to tsconfig.json instead of entrypoint script

  • In most cases this change will have no noticable effect

• Fix #1217: REPL not always using passed stdout and stderr

• Fix #1220: ts-node ./index may execute the wrong file extension because tsconfig search poisons the require.resolve cache

• Fix #1322: Sourcemaps fail for filenames with spaces or other characters which are percent-encoded in URLs (#1160, #1330)

• Fix #1331: Resolution of node builtin modules in ESM loader fails on node >=12.20.0, <13

Docs

• New documentation website: typestrong.org/ts-node

  • README is generated to match the website

  • Added page explaining CommonJS vs ESM

  • Added page with Performance advice

  • Added Troubleshooting page

  • Organized and added to "Recipes" section with third-party tool integrations

  • Added TypeDoc-generated API docs

  • Work was spread across multiple tickets

  • Thanks to these contributors for PRs which improved our documentation

    • add troubleshooting tip for syntax errors

    • Clarify handling of tsx/jsx file extensions

• Added CONTRIBUTING.md to document the codebase and our development workflow

v9.1.1...v10.0.0
github.com/TypeStrong/ts-node/milestone/1