Skip to content

refactor: normalizer #3469

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

Merged
merged 3 commits into from
Jun 22, 2021
Merged

refactor: normalizer #3469

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b14a91
refactor: normalize util
anshumanv Jun 21, 2021
720d429
Merge branch 'master' into ref-norm
anshumanv Jun 22, 2021
b1be1a1
Merge branch 'master' into ref-norm
anshumanv Jun 22, 2021
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
209 changes: 105 additions & 104 deletions lib/utils/normalizeOptions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,92 +25,18 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
watch: watchOptions,
};

if (typeof options.static === 'undefined') {
options.static = [defaultOptionsForStatic];
} else if (typeof options.static === 'boolean') {
options.static = options.static ? [defaultOptionsForStatic] : false;
} else if (typeof options.static === 'string') {
options.static = [
{ ...defaultOptionsForStatic, directory: options.static },
];
} else if (Array.isArray(options.static)) {
options.static = options.static.map((item) => {
if (typeof item === 'string') {
return { ...defaultOptionsForStatic, directory: item };
}

return { ...defaultOptionsForStatic, ...item };
});
} else {
options.static = [{ ...defaultOptionsForStatic, ...options.static }];
}

if (options.static) {
const isAbsoluteUrl = require('is-absolute-url');

options.static.forEach((staticOption) => {
if (isAbsoluteUrl(staticOption.directory)) {
throw new Error('Using a URL as static.directory is not supported');
}

// ensure that publicPath is an array
if (typeof staticOption.publicPath === 'string') {
staticOption.publicPath = [staticOption.publicPath];
}

// ensure that watch is an object if true
if (staticOption.watch === true) {
staticOption.watch = defaultOptionsForStatic.watch;
}

// ensure that serveIndex is an object if true
if (staticOption.serveIndex === true) {
staticOption.serveIndex = defaultOptionsForStatic.serveIndex;
}
});
}

options.hot =
typeof options.hot === 'boolean' || options.hot === 'only'
? options.hot
: true;
options.liveReload =
typeof options.liveReload !== 'undefined' ? options.liveReload : true;

if (typeof options.port === 'string' && options.port !== 'auto') {
options.port = Number(options.port);
if (typeof options.allowedHosts === 'undefined') {
// allowedHosts allows some default hosts picked from
// `options.host` or `webSocketURL.hostname` and `localhost`
options.allowedHosts = 'auto';
}

const defaultWebSocketServerType = 'ws';
const defaultWebSocketServerOptions = { path: '/ws' };

if (typeof options.webSocketServer === 'undefined') {
options.webSocketServer = {
type: defaultWebSocketServerType,
options: defaultWebSocketServerOptions,
};
} else if (
typeof options.webSocketServer === 'string' ||
typeof options.webSocketServer === 'function'
if (
typeof options.allowedHosts === 'string' &&
options.allowedHosts !== 'auto' &&
options.allowedHosts !== 'all'
) {
options.webSocketServer = {
type: options.webSocketServer,
options: defaultWebSocketServerOptions,
};
} else {
options.webSocketServer = {
type: options.webSocketServer.type || defaultWebSocketServerType,
options: {
...defaultWebSocketServerOptions,
...options.webSocketServer.options,
},
};

if (typeof options.webSocketServer.options.port === 'string') {
options.webSocketServer.options.port = Number(
options.webSocketServer.options.port
);
}
// we store allowedHosts as array when supplied as string
options.allowedHosts = [options.allowedHosts];
}

if (!options.client) {
Expand Down Expand Up @@ -150,30 +76,17 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
options.client.hotEntry = options.hot;
}

options.devMiddleware = options.devMiddleware || {};

if (typeof options.allowedHosts === 'undefined') {
// allowedHosts allows some default hosts picked from
// `options.host` or `webSocketURL.hostname` and `localhost`
options.allowedHosts = 'auto';
}
if (
typeof options.allowedHosts === 'string' &&
options.allowedHosts !== 'auto' &&
options.allowedHosts !== 'all'
) {
// we store allowedHosts as array when supplied as string
options.allowedHosts = [options.allowedHosts];
}

if (typeof options.setupExitSignals === 'undefined') {
options.setupExitSignals = true;
}

if (typeof options.compress === 'undefined') {
options.compress = true;
}

options.devMiddleware = options.devMiddleware || {};

options.hot =
typeof options.hot === 'boolean' || options.hot === 'only'
? options.hot
: true;

// if the user enables http2, we can safely enable https
if ((options.http2 && !options.https) || options.https === true) {
options.https = {
Expand Down Expand Up @@ -306,6 +219,13 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
options.https.cert = options.https.cert || fakeCert;
}

options.liveReload =
typeof options.liveReload !== 'undefined' ? options.liveReload : true;

if (typeof options.port === 'string' && options.port !== 'auto') {
options.port = Number(options.port);
}

/**
* Assume a proxy configuration specified as:
* proxy: {
Expand Down Expand Up @@ -373,6 +293,87 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
}
}
}

if (typeof options.setupExitSignals === 'undefined') {
options.setupExitSignals = true;
}

if (typeof options.static === 'undefined') {
options.static = [defaultOptionsForStatic];
} else if (typeof options.static === 'boolean') {
options.static = options.static ? [defaultOptionsForStatic] : false;
} else if (typeof options.static === 'string') {
options.static = [
{ ...defaultOptionsForStatic, directory: options.static },
];
} else if (Array.isArray(options.static)) {
options.static = options.static.map((item) => {
if (typeof item === 'string') {
return { ...defaultOptionsForStatic, directory: item };
}

return { ...defaultOptionsForStatic, ...item };
});
} else {
options.static = [{ ...defaultOptionsForStatic, ...options.static }];
}

if (options.static) {
const isAbsoluteUrl = require('is-absolute-url');

options.static.forEach((staticOption) => {
if (isAbsoluteUrl(staticOption.directory)) {
throw new Error('Using a URL as static.directory is not supported');
}

// ensure that publicPath is an array
if (typeof staticOption.publicPath === 'string') {
staticOption.publicPath = [staticOption.publicPath];
}

// ensure that watch is an object if true
if (staticOption.watch === true) {
staticOption.watch = defaultOptionsForStatic.watch;
}

// ensure that serveIndex is an object if true
if (staticOption.serveIndex === true) {
staticOption.serveIndex = defaultOptionsForStatic.serveIndex;
}
});
}

const defaultWebSocketServerType = 'ws';
const defaultWebSocketServerOptions = { path: '/ws' };

if (typeof options.webSocketServer === 'undefined') {
options.webSocketServer = {
type: defaultWebSocketServerType,
options: defaultWebSocketServerOptions,
};
} else if (
typeof options.webSocketServer === 'string' ||
typeof options.webSocketServer === 'function'
) {
options.webSocketServer = {
type: options.webSocketServer,
options: defaultWebSocketServerOptions,
};
} else {
options.webSocketServer = {
type: options.webSocketServer.type || defaultWebSocketServerType,
options: {
...defaultWebSocketServerOptions,
...options.webSocketServer.options,
},
};

if (typeof options.webSocketServer.options.port === 'string') {
options.webSocketServer.options.port = Number(
options.webSocketServer.options.port
);
}
}
}

module.exports = normalizeOptions;