Release Notes

This page lists breaking changes and notable new features. Please be sure to read the release notes before upgrading from previous version.

TSTyche 5.0

TSTyche 5.0 ships with the new // @tstyche fixme comment directive and checkDeclarationFiles configuration option.

npm add -D tstyche@next

yarn add -D tstyche@next

pnpm add -D tstyche@next

Requirements

expect()

Comment Directives

// @tstyche fixme

Marks an expect(), test() or describe() as supposed to fail.

import { expect, it } from "tstyche";
 
declare function test(cb: () => unknown): void;
declare function test(cb: () => Promise<unknown>): Promise<void>;
 
expect(test(() => {})).type.toBe<void>();
// @tstyche fixme -- This should work, see: #265
expect(test(() => Promise.resolve())).type.toBe<Promise<void>>();
 
it("() => unknown", () => {
  expect(test(() => {})).type.toBe<void>();
});
 
// @tstyche fixme -- Known bug, see: #345
it("() => Promise<unknown>", () => {
  expect(test(() => Promise.resolve())).type.toBe<Promise<void>>();
});

The runner implements the following logic:

• when an expect() is marked, make sure it actually fails,
• when a test() or describe() is marked, check if it has a failing child.

Configuration

checkDeclarationFiles

Check declaration files for type errors.

To maximize performance TSTyche only checks types of test and fixture files. When checkDeclarationFiles is enabled, type errors are also reported for declaration and ambient. In other words, all .d.ts files of the projected are checked. The files within the node_modules directory are not checked.

It is recommended to enable this option when a project has handcrafted or generated type declarations.

checkSuppressedErrors

The checkSuppressedErrors configuration option is enabled by default.

target

- "target": [">=5.2 <=5.3", "5.4.2", ">5.5"]
+ "target": ">=5.2 <=5.3 || 5.4.2 || >5.5"

Command Line

--target

- --target '>=5.2 <5.3, 5.4.2, >5.5'
+ --target '>=5.2 <=5.3 || 5.4.2 || >5.5'

Compiler Options

As a reminder, from now TSTyche sets the following default compiler options:

{
  "allowImportingTsExtensions": true, // not set for TypeScript 4.x
  "exactOptionalPropertyTypes": true,
  "jsx": "preserve",
  "module": "nodenext",
  "moduleResolution": "nodenext",
  "noUncheckedIndexedAccess": true,
  "resolveJsonModule": true,
  "strict": true,
  "target": "esnext",
  "verbatimModuleSyntax": true // not set for TypeScript 4.x
}