Skip to content

Commit cb8df13

Browse files
committed
Add path alias setting guide
1 parent b86996c commit cb8df13

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ Be aware that starting Webpack will only compile your files to `dist` folder
5151
but won't start the Electron app. Use `npm start` command to start your
5252
Electron app once the files are compiled.
5353

54+
__*Starting from `v4.0.0`, you no longer need to manually config your module
55+
path alias in `webpack.config.js`. All module path alias set in `tsconfig.json`
56+
will be configured in Webpack automatically thanks to [`tsconfig-paths`] and
57+
[`tsconfig-paths-webpack-plugin`].*__
58+
5459
## Build your Electron app package
5560
Different from the official [Electron quick start guide], this boilerplate uses
5661
[`electron-builder`] instead of [Electron Forge] to package your Electron app.
@@ -130,6 +135,8 @@ Electron React TypeScript Webpack Boilerplate is open source software
130135
[`electron-builder`]: https://github.com/electron-userland/electron-builder
131136
[file an issue]: https://www.electronjs.org
132137
[`Use this template`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/generate
138+
[`tsconfig-paths`]: https://github.com/dividab/tsconfig-paths
139+
[`tsconfig-paths-webpack-plugin`]: https://github.com/dividab/tsconfig-paths-webpack-plugin
133140
[Electron quick start guide]: https://www.electronjs.org/docs/latest/tutorial/quick-start
134141
[Electron Forge]: https://github.com/electron-userland/electron-forge
135142
[`electron-builder`'s document]: https://www.electron.build

0 commit comments

Comments
 (0)