Skip to content

Commit f20a80e

Browse files
DavertMikclaude
andcommitted
refactor: drop TestCafe/Protractor/Nightmare branches
CodeceptJS 4.x ships only Playwright, Puppeteer, WebDriver and Appium as browser helpers — TestCafe, Protractor, and Nightmare were removed in the 3.x → 4.x cut. Strip the dead branches from every hook plus README and tests. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d92c929 commit f20a80e

9 files changed

Lines changed: 14 additions & 42 deletions

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Better to see once.
2020

2121
### setHeadlessWhen
2222

23-
Toggle headless mode for Puppeteer, WebDriver, TestCafe and Playwright on condition.
23+
Toggle headless mode for Puppeteer, WebDriver and Playwright on condition.
2424

2525
Usage:
2626

@@ -37,14 +37,14 @@ setHeadlessWhen(process.env.HEADLESS);
3737
exports.config = {
3838
helpers: {
3939
// standard config goes here
40-
WebDriver: {}
40+
WebDriver: {}
4141
// or Puppeteer
42-
// or TestCafe
42+
// or Playwright
4343
}
4444
}
4545
```
4646

47-
* For Puppeteer, TestCafe, Playwright: it enables `show: true`.
47+
* For Puppeteer, Playwright: it enables `show: true`.
4848
* For WebDriver with Chrome or Firefox browser: it adds `--headless` option to chrome/firefox options inside `desiredCapabilities`.
4949

5050
### setHeadedWhen
@@ -102,7 +102,7 @@ exports.config = {
102102
// standard config goes here
103103
},
104104
// or Puppeteer
105-
// or TestCafe,
105+
// or Playwright,
106106
REST: {
107107
// standard config goes here
108108
// onRequest: <= will be set by hook
@@ -118,7 +118,7 @@ exports.config = {
118118

119119
### setBrowser
120120

121-
Changes browser in config for Playwright, Puppeteer, WebDriver & TestCafe:
121+
Changes browser in config for Playwright, Puppeteer and WebDriver:
122122

123123
```js
124124
import { setBrowser } from '@codeceptjs/configure'
@@ -162,7 +162,7 @@ setBrowserConfig({
162162

163163
### setTestHost
164164

165-
Changes url in config for Playwright, Puppeteer, WebDriver & TestCafe:
165+
Changes url in config for Playwright, Puppeteer, WebDriver and Appium:
166166

167167
```js
168168
import { setTestHost } from '@codeceptjs/configure'
@@ -181,7 +181,7 @@ Good ideas for config hooks:
181181

182182
* Setting the same window size for all browser helpers.
183183
* Configuring `run-multiple`
184-
* Changing browser in WebDriver or Protractor depending on environment variable.
184+
* Changing browser in WebDriver depending on environment variable.
185185

186186
To create a custom hook follow this rules.
187187

hooks/setBrowser.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,9 @@ export default function (browser) {
1313
checkAllowedBrowser('Playwright', ['chromium', 'webkit', 'firefox'])
1414
cfg.helpers.Playwright.browser = browser
1515
}
16-
if (cfg.helpers.TestCafe) {
17-
checkAllowedBrowser('TestCafe', ['chromium', 'chrome', 'chrome-canary', 'ie', 'edge', 'firefox', 'opera', 'safari'])
18-
cfg.helpers.TestCafe.browser = browser
19-
}
2016
if (cfg.helpers.WebDriver) {
2117
cfg.helpers.WebDriver.browser = browser
2218
}
23-
if (cfg.helpers.Protractor) {
24-
cfg.helpers.Protractor.browser = browser
25-
}
2619
})
2720

2821
function checkAllowedBrowser(engine, values = []) {

hooks/setBrowserConfig.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import setWindowSize from './setWindowSize.js'
44
import setHeadedWhen from './setHeadedWhen.js'
55
import setHeadlessWhen from './setHeadlessWhen.js'
66

7-
const BROWSER_HELPERS = ['Playwright', 'Puppeteer', 'WebDriver', 'Appium', 'TestCafe', 'Protractor', 'Nightmare']
7+
const BROWSER_HELPERS = ['Playwright', 'Puppeteer', 'WebDriver', 'Appium']
88

99
/**
1010
* Apply a bag of browser helper overrides in a single call. Dispatches the

hooks/setHeadedWhen.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,6 @@ export default function (when) {
1111
if (cfg.helpers.Playwright) {
1212
cfg.helpers.Playwright.show = true
1313
}
14-
if (cfg.helpers.Nightmare) {
15-
cfg.helpers.Nightmare.show = true
16-
}
17-
if (cfg.helpers.TestCafe) {
18-
cfg.helpers.TestCafe.show = true
19-
}
2014
if (cfg.helpers.WebDriver) {
2115
if (cfg.helpers.WebDriver.browser === 'chrome') {
2216
if (

hooks/setHeadlessWhen.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ export default function (when) {
1212
if (cfg.helpers.Playwright) {
1313
cfg.helpers.Playwright.show = false
1414
}
15-
if (cfg.helpers.Nightmare) {
16-
cfg.helpers.Nightmare.show = false
17-
}
18-
if (cfg.helpers.TestCafe) {
19-
cfg.helpers.TestCafe.show = false
20-
}
2115
if (cfg.helpers.WebDriver) {
2216
if (cfg.helpers.WebDriver.browser === 'chrome') {
2317
cfg.helpers.WebDriver.desiredCapabilities = merge(

hooks/setSharedCookies.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { container, config, event, output } from '../codeceptjs.js'
22

3-
const browserHelpers = ['WebDriver', 'Protractor', 'Playwright', 'Puppeteer', 'TestCafe', 'Nightmare']
3+
const browserHelpers = ['WebDriver', 'Playwright', 'Puppeteer']
44

55
export default function () {
66
config.addHook(cfg => {

hooks/setTestHost.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { config } from '../codeceptjs.js'
22

3-
const supportedHelpers = ['Playwright', 'WebDriver', 'Puppeteer', 'Appium', 'TestCafe', 'Protractor', 'Nightmare']
3+
const supportedHelpers = ['Playwright', 'WebDriver', 'Puppeteer', 'Appium']
44

55
export default function (url) {
66
config.addHook(cfg => {

hooks/setWindowSize.js

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,6 @@ export default function (width, height) {
2626
cfg.helpers.Playwright.windowSize = `${width}x${height}`
2727
}
2828

29-
if (cfg.helpers.Protractor) {
30-
cfg.helpers.Protractor.windowSize = `${width}x${height}`
31-
}
32-
if (cfg.helpers.Nightmare) {
33-
cfg.helpers.Nightmare.windowSize = `${width}x${height}`
34-
}
35-
if (cfg.helpers.TestCafe) {
36-
cfg.helpers.TestCafe.windowSize = `${width}x${height}`
37-
}
3829
if (cfg.helpers.WebDriver) {
3930
cfg.helpers.WebDriver.windowSize = `${width}x${height}`
4031
}

test/index.test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ describe('Hooks tests', () => {
109109
})
110110

111111
describe('#setWindowSize', () => {
112-
for (const helper of ['Protractor', 'TestCafe', 'Nightmare', 'WebDriver', 'Puppeteer', 'Playwright']) {
112+
for (const helper of ['WebDriver', 'Puppeteer', 'Playwright']) {
113113
test('should set window size for ' + helper, () => {
114114
Config.reset()
115115
const config = { helpers: {} }
@@ -130,7 +130,7 @@ describe('Hooks tests', () => {
130130
})
131131

132132
describe('#setBrowser', () => {
133-
for (const helper of ['Protractor', 'TestCafe', 'WebDriver', 'Playwright']) {
133+
for (const helper of ['WebDriver', 'Playwright']) {
134134
test('should set browser to firefox for ' + helper, () => {
135135
Config.reset()
136136
const config = { helpers: {} }
@@ -150,7 +150,7 @@ describe('Hooks tests', () => {
150150
})
151151

152152
describe('#setTestHost', () => {
153-
for (const helper of ['Protractor', 'TestCafe', 'WebDriver', 'Playwright', 'Puppeteer']) {
153+
for (const helper of ['WebDriver', 'Playwright', 'Puppeteer', 'Appium']) {
154154
test('should set url for ' + helper, () => {
155155
Config.reset()
156156
const config = { helpers: {} }

0 commit comments

Comments
 (0)