-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
feat(jest-runner): improve typings by exposing TestRunner
abstract classes
#12646
Merged
Merged
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
b7c9690
feat: improve types
mrazauskas 55f8241
refactor private
mrazauskas f15bc6f
add type tests
mrazauskas 3448a06
override
mrazauskas a5a6c41
remove override
mrazauskas 18872be
change log entry
mrazauskas 924f002
noImplicitOverride
mrazauskas a76432d
Revert "noImplicitOverride"
mrazauskas 707d50a
test constructor types
mrazauskas b8ca3db
expose TestContext type
mrazauskas 1f4c7cf
tweak test
mrazauskas 71ed106
clean up
mrazauskas 4557714
test
mrazauskas 2e178ab
cleaner
mrazauskas 1994afd
bring back jest-jasmine2 devDep
mrazauskas 02db4aa
add and expose UnsubscribeFn
mrazauskas 231e14c
split with comments
mrazauskas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import type {UnsubscribeFn} from 'emittery'; | ||
import {expectType} from 'tsd-lite'; | ||
import type {Test, TestEvents} from '@jest/test-result'; | ||
import type {Config} from '@jest/types'; | ||
import {CallbackTestRunner, EmittingTestRunner} from 'jest-runner'; | ||
import type { | ||
OnTestFailure, | ||
OnTestStart, | ||
OnTestSuccess, | ||
TestRunnerContext, | ||
TestRunnerOptions, | ||
TestWatcher, | ||
} from 'jest-runner'; | ||
|
||
const globalConfig = {} as Config.GlobalConfig; | ||
const runnerContext = {} as TestRunnerContext; | ||
|
||
class CallbackRunner extends CallbackTestRunner { | ||
async runTests( | ||
tests: Array<Test>, | ||
watcher: TestWatcher, | ||
onStart: OnTestStart, | ||
onResult: OnTestSuccess, | ||
onFailure: OnTestFailure, | ||
options: TestRunnerOptions, | ||
): Promise<void> { | ||
expectType<Config.GlobalConfig>(this._globalConfig); | ||
expectType<TestRunnerContext>(this._context); | ||
|
||
return; | ||
} | ||
} | ||
|
||
const callbackRunner = new CallbackRunner(globalConfig, runnerContext); | ||
|
||
expectType<boolean | undefined>(callbackRunner.isSerial); | ||
expectType<false>(callbackRunner.supportsEventEmitters); | ||
|
||
class EmittingRunner extends EmittingTestRunner { | ||
async runTests( | ||
tests: Array<Test>, | ||
watcher: TestWatcher, | ||
options: TestRunnerOptions, | ||
): Promise<void> { | ||
expectType<Config.GlobalConfig>(this._globalConfig); | ||
expectType<TestRunnerContext>(this._context); | ||
|
||
return; | ||
} | ||
|
||
on<Name extends keyof TestEvents>( | ||
eventName: string, | ||
listener: (eventData: TestEvents[Name]) => void | Promise<void>, | ||
): UnsubscribeFn { | ||
return () => {}; | ||
} | ||
} | ||
|
||
const emittingRunner = new EmittingRunner(globalConfig, runnerContext); | ||
|
||
expectType<boolean | undefined>(emittingRunner.isSerial); | ||
expectType<true>(emittingRunner.supportsEventEmitters); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"extends": "../../../tsconfig.json", | ||
"compilerOptions": { | ||
"noUnusedLocals": false, | ||
"noUnusedParameters": false, | ||
"skipLibCheck": true, | ||
|
||
"types": [] | ||
}, | ||
"include": ["./**/*"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was hoping that
override
here in a test could catch some drift (hence #12648). Apparentlyoverride
has no effect in this case, because methods are markedabstract
.In the other hand,
abstract
requires to implement those methods in a derived class. So to have this test passing is still good.