Skip to content

Commit 2cb0e47

Browse files
committed
Add section CAUTION
1 parent 80f2354 commit 2cb0e47

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,25 @@ implemented, please [file an issue], or consider make a [new pull request].
3030
- [ ] Create a `create-react-app`-like package initialiser __!!!__
3131
- [ ] Integrate another end-to-end testing framework to replace [Spectron]
3232

33+
---
34+
35+
## 🚨 🚧 CAUTION 🚧 🚨
36+
- [Spectron] has officially been deprecated by the [Electron] team on
37+
February 1, 2022, thus, its' integration has also been dropped from this
38+
boilerplate on `v4+`.
39+
40+
A replacement will be integrated in future version (pending for `v5`).
41+
Currently evaluating different options including [Playwright] and
42+
[WebdriverIO].
43+
44+
*See - [Spectron Deprecation Notice]*
45+
46+
- `mocha` has been dropped and replaced by [Jest] on `v4+`. If you're using
47+
`mocha` as your unit testing framework, please reference to `package.json`
48+
from [`v3.0.0`].
49+
50+
---
51+
3352
## Getting started
3453
1. Clone this repository, or if you're hosting your Electron project on GitHub,
3554
click [`Use this template`] to create a new project.
@@ -241,6 +260,10 @@ Electron React TypeScript Webpack Boilerplate is open source software
241260
[file an issue]: https://www.electronjs.org
242261
[new pull request]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/compare
243262
[Spectron]: https://github.com/electron-userland/spectron
263+
[Playwright]: https://playwright.dev
264+
[WebdriverIO]: https://webdriver.io
265+
[Spectron Deprecation Notice]: https://www.electronjs.org/blog/spectron-deprecation-notice
266+
[`v3.0.0`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/releases/tag/v3.0.0
244267
[`Use this template`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/generate
245268
[`tsconfig-paths`]: https://github.com/dividab/tsconfig-paths
246269
[`tsconfig-paths-webpack-plugin`]: https://github.com/dividab/tsconfig-paths-webpack-plugin

0 commit comments

Comments
 (0)