Skip to content
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.

Sign up for GitHub

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(v2): better & nice looking error overlay #2096

Merged
merged 2 commits into from
Dec 6, 2019
Merged

feat(v2): better & nice looking error overlay #2096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dd2fad
wip: better error overlay and use websocket instead of sockjs
endiliey Dec 5, 2019
9ef1235
refactor
endiliey Dec 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions packages/docusaurus/src/commands/start.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import path from 'path';
import portfinder from 'portfinder';
import openBrowser from 'react-dev-utils/openBrowser';
import {prepareUrls} from 'react-dev-utils/WebpackDevServerUtils';
import errorOverlayMiddleware from 'react-dev-utils/errorOverlayMiddleware';
import evalSourceMapMiddleware from 'react-dev-utils/evalSourceMapMiddleware';
import webpack from 'webpack';
import WebpackDevServer from 'webpack-dev-server';
import merge from 'webpack-merge';
Expand Down Expand Up @@ -135,15 +137,20 @@ export async function start(
rewrites: [{from: /\/*/, to: baseUrl}],
},
disableHostCheck: true,
// Enable overlay on browser. E.g: display errors
overlay: true,
// Disable overlay on browser since we use CRA's overlay error reporting
overlay: false,
host,
before: app => {
before: (app, server) => {
app.use(baseUrl, express.static(path.resolve(siteDir, STATIC_DIR_NAME)));

// This lets us fetch source contents from webpack for the error overlay
app.use(evalSourceMapMiddleware(server));
// This lets us open files from the runtime error overlay.
app.use(errorOverlayMiddleware());

// TODO: add plugins beforeDevServer and afterDevServer hook
},
};
WebpackDevServer.addDevServerEntrypoints(config, devServerConfig);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer needed cause we dont want to use the default client from webpack-dev-server. We use CRA's

const compiler = webpack(config);
const devServer = new WebpackDevServer(compiler, devServerConfig);
devServer.listen(port, host, err => {
Expand Down
9 changes: 6 additions & 3 deletions packages/docusaurus/src/webpack/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@ export function createClientConfig(props: Props): Configuration {
const config = createBaseConfig(props, false);

const clientConfig = merge(config, {
entry: {
main: path.resolve(__dirname, '../client/clientEntry.js'),
},
entry: [
// Instead of the default WebpackDevServer client, we use a custom one
// like CRA to bring better experience.
!isProd && require.resolve('react-dev-utils/webpackHotDevClient'),
path.resolve(__dirname, '../client/clientEntry.js'),
].filter(Boolean) as string[],
optimization: {
// Keep the runtime chunk separated to enable long term caching
// https://twitter.com/wSokra/status/969679223278505985
Expand Down