Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: migrate the Config type test to TSTyche #14687

Merged
merged 9 commits into from
Dec 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
- name: ts integration
run: yarn test-ts --selectProjects ts-integration
- name: type tests
run: yarn test-ts --selectProjects type-tests
run: yarn tstyche --target 5.0,latest && yarn test-ts --selectProjects type-tests
- name: verify TypeScript@5.0 compatibility
run: yarn verify-old-ts
- name: run ESLint with type info
Expand Down
5 changes: 4 additions & 1 deletion jest.config.ts.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ export default {
modulePathIgnorePatterns: baseConfig.modulePathIgnorePatterns,
roots: ['<rootDir>/packages'],
runner: 'jest-runner-tsd',
testMatch: ['**/__typetests__/**/*.test.ts'],
testMatch: [
'**/__typetests__/**/*.test.ts',
'!**/packages/jest-types/__typetests__/config.test.ts',
],
Comment on lines +30 to +33
Copy link
Contributor Author

@mrazauskas mrazauskas Nov 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks clumsy for now, but the diff is more readable.

},
],
reporters: ['default', 'github-actions'],
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
"strip-json-comments": "^3.1.1",
"tempy": "^1.0.0",
"ts-node": "^10.5.0",
"tstyche": "^1.0.0-beta.6",
"typescript": "^5.0.4",
"webpack": "^5.68.0",
"webpack-node-externals": "^3.0.0",
Expand Down Expand Up @@ -110,7 +111,7 @@
"test-ci-partial:parallel": "yarn jest --color --config jest.config.ci.mjs",
"test-leak": "yarn jest -i --detectLeaks --color jest-mock jest-diff jest-repl pretty-format",
"test-ts": "yarn jest --config jest.config.ts.mjs",
"test-types": "yarn test-ts --selectProjects type-tests",
"test-types": "yarn tstyche && yarn test-ts --selectProjects type-tests",
"test": "yarn lint && yarn jest",
"typecheck": "yarn typecheck:examples && yarn typecheck:tests",
"typecheck:examples": "tsc -p examples/angular --noEmit && tsc -p examples/expect-extend --noEmit && tsc -p examples/typescript --noEmit",
Expand Down
211 changes: 111 additions & 100 deletions packages/jest-types/__typetests__/config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,115 +5,126 @@
* LICENSE file in the root directory of this source tree.
*/

import {expectAssignable, expectNotAssignable} from 'tsd-lite';
import type {Config} from '@jest/types';
import {describe, expect, test} from 'tstyche';
import type {Config} from 'jest';
mrazauskas marked this conversation as resolved.
Show resolved Hide resolved

expectAssignable<Config.InitialOptions>({});
const config: Config = {};

expectAssignable<Config.InitialOptions>({
coverageThreshold: {
'./src/api/very-important-module.js': {
branches: 100,
functions: 100,
lines: 100,
statements: 100,
},
'./src/components/': {
branches: 40,
statements: 40,
},
'./src/reducers/**/*.js': {
statements: 90,
},
global: {
branches: 50,
functions: 50,
lines: 50,
statements: 50,
},
},
projects: [
// projects can be globs or objects
'./src/**',
{
displayName: 'A Project',
rootDir: './src/components',
},
],
});
describe('Config', () => {
test('coverageThreshold', () => {
expect(config).type.toBeAssignable({
coverageThreshold: {
'./src/api/very-important-module.js': {
branches: 100,
functions: 100,
lines: 100,
statements: 100,
},
'./src/components/': {
branches: 40,
statements: 40,
},
'./src/reducers/**/*.js': {
statements: 90,
},
global: {
branches: 50,
functions: 50,
lines: 50,
statements: 50,
},
},
});
});

const doNotFake: Array<Config.FakeableAPI> = [
'Date',
'hrtime',
'nextTick',
'performance',
'queueMicrotask',
'requestAnimationFrame',
'cancelAnimationFrame',
'requestIdleCallback',
'cancelIdleCallback',
'setImmediate',
'clearImmediate',
'setInterval',
'clearInterval',
'setTimeout',
'clearTimeout',
];
test('fakeTimers', () => {
const doNotFake = [
'Date' as const,
'hrtime' as const,
'nextTick' as const,
'performance' as const,
'queueMicrotask' as const,
'requestAnimationFrame' as const,
'cancelAnimationFrame' as const,
'requestIdleCallback' as const,
'cancelIdleCallback' as const,
'setImmediate' as const,
'clearImmediate' as const,
'setInterval' as const,
'clearInterval' as const,
'setTimeout' as const,
'clearTimeout' as const,
Comment on lines +42 to +56
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we have to as const them all? can we just do that for the entire array instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as const on the whole array results in different type. In that case this would be a readonly tuple of string literal types, but the option expects an array of string literal types. The test is not passing. (To make the test pass, it is enough to have doNotFake: [...doNotFake], but that looks odd.)

I work on one idea which could improve this in the future. For now this is an assignability test and that is how it currently works. I mean, it works and it tests the right thing! That is very good for the first release of TSTyche. And future will bring in improvements for sure.

];

expectAssignable<Config.InitialOptions>({
fakeTimers: {
advanceTimers: true,
doNotFake,
enableGlobally: true,
now: 1_483_228_800_000,
timerLimit: 1000,
},
});
expect(config).type.toBeAssignable({
fakeTimers: {
advanceTimers: true,
Comment on lines +59 to +61
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comparing inferred type with and inferred type. Looks simple, but that was not possible with tsd.

doNotFake,
enableGlobally: true,
now: 1_483_228_800_000,
timerLimit: 1000,
},
});

expectAssignable<Config.InitialOptions>({
fakeTimers: {
advanceTimers: 40,
now: Date.now(),
},
});
expect(config).type.toBeAssignable({
fakeTimers: {
advanceTimers: 40,
now: Date.now(),
},
});

expectNotAssignable<Config.InitialOptions>({
fakeTimers: {
now: new Date(),
},
});
expect(config).type.not.toBeAssignable({
fakeTimers: {
now: new Date(),
},
});

expectAssignable<Config.InitialOptions>({
fakeTimers: {
enableGlobally: true,
legacyFakeTimers: true as const,
},
});
expect(config).type.toBeAssignable({
fakeTimers: {
enableGlobally: true,
legacyFakeTimers: true as const,
},
});

expectNotAssignable<Config.InitialOptions>({
fakeTimers: {
advanceTimers: true,
legacyFakeTimers: true as const,
},
});
expect(config).type.not.toBeAssignable({
fakeTimers: {
advanceTimers: true,
legacyFakeTimers: true as const,
},
});

expectNotAssignable<Config.InitialOptions>({
fakeTimers: {
doNotFake,
legacyFakeTimers: true as const,
},
});
expect(config).type.not.toBeAssignable({
fakeTimers: {
doNotFake,
legacyFakeTimers: true as const,
},
});

expectNotAssignable<Config.InitialOptions>({
fakeTimers: {
legacyFakeTimers: true as const,
now: 1_483_228_800_000,
},
});
expect(config).type.not.toBeAssignable({
fakeTimers: {
legacyFakeTimers: true as const,
now: 1_483_228_800_000,
},
});

expect(config).type.not.toBeAssignable({
fakeTimers: {
legacyFakeTimers: true as const,
timerLimit: 1000,
},
});
});

expectNotAssignable<Config.InitialOptions>({
fakeTimers: {
legacyFakeTimers: true as const,
timerLimit: 1000,
},
test('projects', () => {
expect(config).type.toBeAssignable({
projects: [
// projects can be globs or objects
'./src/**',
{
displayName: 'A Project',
rootDir: './src/components',
},
],
});
});
});
3 changes: 3 additions & 0 deletions tstyche.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"testFileMatch": ["**/packages/jest-types/__typetests__/config.test.ts"]
}
15 changes: 15 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3060,6 +3060,7 @@ __metadata:
strip-json-comments: ^3.1.1
tempy: ^1.0.0
ts-node: ^10.5.0
tstyche: ^1.0.0-beta.6
typescript: ^5.0.4
webpack: ^5.68.0
webpack-node-externals: ^3.0.0
Expand Down Expand Up @@ -21109,6 +21110,20 @@ __metadata:
languageName: node
linkType: hard

"tstyche@npm:^1.0.0-beta.6":
version: 1.0.0-beta.6
resolution: "tstyche@npm:1.0.0-beta.6"
peerDependencies:
typescript: 4.x || 5.x
peerDependenciesMeta:
typescript:
optional: true
bin:
tstyche: ./build/bin.js
checksum: 197ef69d05b8a82f5d0d4a618ed36102d906badb537712d4399387f2ed822b076d37d8a4c2b8e2d13582fb733d0737794b6789a4635bde23bd41f520ddb8c337
languageName: node
linkType: hard

"tsutils@npm:^3.21.0":
version: 3.21.0
resolution: "tsutils@npm:3.21.0"
Expand Down
Loading