-
Notifications
You must be signed in to change notification settings - Fork 74
fix!: remove global helpers (it,describe,...) #1261
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
Open
KuznetsovRoman
wants to merge
1
commit into
testplane@9
Choose a base branch
from
TESTPLANE-188.rm_global_types
base: testplane@9
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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 hidden or 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,16 @@ | ||
| import type { | ||
| GlobalAfterEachType, | ||
| GlobalBeforeEachType, | ||
| GlobalDescribeType, | ||
| GlobalHermioneType, | ||
| GlobalItType, | ||
| GlobalTestplaneType, | ||
| TestplaneGlobals, | ||
| } from "./types/globals"; | ||
|
|
||
| export const it: GlobalItType = (globalThis as unknown as TestplaneGlobals).it; | ||
| export const describe: GlobalDescribeType = (globalThis as unknown as TestplaneGlobals).describe; | ||
| export const beforeEach: GlobalBeforeEachType = (globalThis as unknown as TestplaneGlobals).beforeEach; | ||
| export const afterEach: GlobalAfterEachType = (globalThis as unknown as TestplaneGlobals).afterEach; | ||
| export const testplane: GlobalTestplaneType = (globalThis as unknown as TestplaneGlobals).testplane; | ||
| export const hermione: GlobalHermioneType = (globalThis as unknown as TestplaneGlobals).hermione; | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -6,11 +6,11 @@ import "./browser/types"; | |
| // Declares global expect function | ||
| import "expect-webdriverio"; | ||
|
|
||
| import { GlobalHelper } from "./types"; | ||
| export { run as runCli } from "./cli"; | ||
| export { Testplane as default } from "./testplane"; | ||
| export { Key } from "@testplane/webdriverio"; | ||
| export * from "./mock"; | ||
| export * from "./globals"; | ||
|
|
||
| export * as unstable from "./unstable"; | ||
|
|
||
|
|
@@ -46,24 +46,3 @@ export type { SaveStateData } from "./browser/commands/saveState"; | |
|
|
||
| import type { TestDefinition, SuiteDefinition, TestHookDefinition } from "./test-reader/test-object/types"; | ||
| export type { TestDefinition, SuiteDefinition, TestHookDefinition }; | ||
|
|
||
| declare global { | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Now we dont pollute global by default |
||
| /* eslint-disable no-var */ | ||
| // Here, we ignore clashes of types between Mocha and Testplane, because in production we don't include @types/mocha, | ||
| // but we need mocha types in development, so this is an issue only during development. | ||
| ///@ts-expect-error: see explanation above | ||
| var it: TestDefinition; | ||
| // @ts-expect-error: see explanation above | ||
| var describe: SuiteDefinition; | ||
| // @ts-expect-error: see explanation above | ||
| var beforeEach: TestHookDefinition; | ||
| // @ts-expect-error: see explanation above | ||
| var afterEach: TestHookDefinition; | ||
|
|
||
| var testplane: GlobalHelper; | ||
| /** | ||
| * @deprecated Use `testplane` instead | ||
| */ | ||
| var hermione: GlobalHelper; | ||
| /* eslint-enable no-var */ | ||
| } | ||
This file contains hidden or 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 hidden or 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,18 @@ | ||
| import type { GlobalHelper } from "."; | ||
| import type { SuiteDefinition, TestDefinition, TestHookDefinition } from "../test-reader/test-object/types"; | ||
|
|
||
| export type GlobalItType = TestDefinition; | ||
| export type GlobalDescribeType = SuiteDefinition; | ||
| export type GlobalBeforeEachType = TestHookDefinition; | ||
| export type GlobalAfterEachType = TestHookDefinition; | ||
| export type GlobalTestplaneType = GlobalHelper; | ||
| export type GlobalHermioneType = GlobalHelper; | ||
|
|
||
| export type TestplaneGlobals = { | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Instead, we have type of testplane-related globals to use |
||
| it: GlobalItType; | ||
| describe: GlobalDescribeType; | ||
| beforeEach: GlobalBeforeEachType; | ||
| afterEach: GlobalAfterEachType; | ||
| testplane: GlobalTestplaneType; | ||
| hermione: GlobalHermioneType; | ||
| }; | ||
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.
Types of globals are exported instead of being declared
So user could type:
Also same exported types will be used in "@testplane/globals"