Skip to content
This repository has been archived by the owner on Sep 23, 2023. It is now read-only.

feat: add devServer config entry for users #263

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions templates/js/config/devServerProxy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/**
* Use the mock proxy
*
* If isMock is true, mockTarget is valid, target is invalid.
*/
const isMock = false;

/**
* Change the proxy env
* 'test', 'dev', etc. target is valid, mockTarget is invalid.
*/

const env = "dev";


/**
* This is the default devServer proxy config, you can use it in proxyCustomConfig or not.
*/
const DEFAULT_PROXY_CONFIG = {
secure: false,
changeOrigin: true,
};

/**
* Config your proxy api here.
*/
const config = {
"/api": {
target: {
dev: "https://api.dev.com/",
test: "https://api.test.com/",
},
mockTarget: "https://api.mock.com/",
proxyCustomConfig: { ...DEFAULT_PROXY_CONFIG },
},
"/apiAnother": {
target: {
dev: "https://api.another.dev.com/",
test: "https://api.another.test.com/",
},
mockTarget: "https://api.another.mock.com/",
proxyCustomConfig: { ...DEFAULT_PROXY_CONFIG },
},
};

const proxyConfig = () =>
Object.entries(config).reduce((acc, [configKey, configValue]) => {
// Avoid incorrect 'target' config in proxyCustomConfig
delete configValue.proxyCustomConfig["target"];
acc[configKey] = {
target: isMock ? configValue.mockTarget : configValue.target[env],
...configValue.proxyCustomConfig,
};
return acc;
}, {});

module.exports = () => proxyConfig();
22 changes: 18 additions & 4 deletions templates/js/direflow-webpack.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
const { webpackConfig } = require('direflow-scripts');
const devServerProxy = require("./config/devServerProxy");

/**
* Webpack configuration for Direflow Component
* Additional webpack plugins / overrides can be provided here
*/
module.exports = (config, env) => ({
...webpackConfig(config, env),
// Add your own webpack config here (optional)
});
module.exports = {
webpack: (config, env) => {
return {
...webpackConfig(config, env),
// Add your own webpack config here (optional)
};
},
devServer: function (configFunction) {
return function (proxy, allowedHost) {
// Config your own devServer proxy in ./config/devServerProxy.js
proxy = devServerProxy();

const config = configFunction(proxy, allowedHost);
return config;
};
},
};
57 changes: 57 additions & 0 deletions templates/ts/config/devServerProxy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/**
* Use the mock proxy
*
* If isMock is true, mockTarget is valid, target is invalid.
*/
const isMock = false;

/**
* Change the proxy env
* 'test', 'dev', etc. target is valid, mockTarget is invalid.
*/

const env = "dev";


/**
* This is the default devServer proxy config, you can use it in proxyCustomConfig or not.
*/
const DEFAULT_PROXY_CONFIG = {
secure: false,
changeOrigin: true,
};

/**
* Config your proxy api here.
*/
const config = {
"/api": {
target: {
dev: "https://api.dev.com/",
test: "https://api.test.com/",
},
mockTarget: "https://api.mock.com/",
proxyCustomConfig: { ...DEFAULT_PROXY_CONFIG },
},
"/apiAnother": {
target: {
dev: "https://api.another.dev.com/",
test: "https://api.another.test.com/",
},
mockTarget: "https://api.another.mock.com/",
proxyCustomConfig: { ...DEFAULT_PROXY_CONFIG },
},
};

const proxyConfig = () =>
Object.entries(config).reduce((acc, [configKey, configValue]) => {
// Avoid incorrect 'target' config in proxyCustomConfig
delete configValue.proxyCustomConfig["target"];
acc[configKey] = {
target: isMock ? configValue.mockTarget : configValue.target[env],
...configValue.proxyCustomConfig,
};
return acc;
}, {});

module.exports = () => proxyConfig();
22 changes: 18 additions & 4 deletions templates/ts/direflow-webpack.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
const { webpackConfig } = require('direflow-scripts');
const devServerProxy = require("./config/devServerProxy");

/**
* Webpack configuration for Direflow Component
* Additional webpack plugins / overrides can be provided here
*/
module.exports = (config, env) => ({
...webpackConfig(config, env),
// Add your own webpack config here (optional)
});
module.exports = {
webpack: (config, env) => {
return {
...webpackConfig(config, env),
// Add your own webpack config here (optional)
};
},
devServer: function (configFunction) {
return function (proxy, allowedHost) {
// Config your own devServer proxy in ./config/devServerProxy.js
proxy = devServerProxy();

const config = configFunction(proxy, allowedHost);
return config;
};
},
};