Skip to content

Commit e8aeb57

Browse files
add comment that explains when stream-browserify is needed
1 parent 0e16e0b commit e8aeb57

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

lib/generators/react_on_rails/templates/base/base/config/webpack/webpackConfig.js.tt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,16 @@ const serverWebpackConfig = require('./serverWebpackConfig');
66
const webpackConfig = (envSpecific) => {
77
const clientConfig = clientWebpackConfig();
88
const serverConfig = serverWebpackConfig();
9+
// The stream module is used on the server side for streaming server side rendering.
10+
// It's not needed on the client side, so we can remove it.
911
clientConfig.resolve.fallback = { stream: false };
10-
// Remove the next line if you used "node" target in serverWebpackConfig.js
12+
// If you are using "node" target in serverWebpackConfig.js, you can remove the fallback configuration below
13+
// since Node.js has built-in stream support.
14+
//
15+
// If you are using "web" target in serverWebpackConfig.js and need server-side rendering streaming using RORP:
16+
// 1. Install the stream-browserify package: npm install stream-browserify
17+
// 2. Replace the line below with:
18+
// serverConfig.resolve.fallback = { stream: require.resolve('stream-browserify') };
1119
serverConfig.resolve.fallback = { stream: false };
1220

1321
if (envSpecific) {

spec/dummy/config/webpack/webpackConfig.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ const webpackConfig = (envSpecific) => {
55
const clientConfig = clientWebpackConfig();
66
const serverConfig = serverWebpackConfig();
77
clientConfig.resolve.fallback = { stream: false };
8-
// Remove the next line if you used "node" target in serverWebpackConfig.js
8+
// If you are using "node" target in serverWebpackConfig.js, you can remove the fallback configuration below
9+
// since Node.js has built-in stream support.
10+
//
11+
// If you are using "web" target in serverWebpackConfig.js and need server-side rendering streaming using RORP:
12+
// 1. Install the stream-browserify package: npm install stream-browserify
13+
// 2. Replace the line below with:
14+
// serverConfig.resolve.fallback = { stream: require.resolve('stream-browserify') };
915
serverConfig.resolve.fallback = { stream: false };
1016

1117
if (envSpecific) {

0 commit comments

Comments
 (0)