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.

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: added node externals config parameter #305

Merged
merged 4 commits into from
Jan 5, 2021
Merged
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
46 changes: 46 additions & 0 deletions __tests__/features/node-externals.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { aver, rebuild, testFeature } from '../utils/feature';

testFeature(
'node-externals',
() => {
test('externals options should be set correctly', async () => {
expect(
aver.renderer?.webpackServerConfig.nodeExternalsOptions.allowlist
).toEqual(expect.arrayContaining([/\.css$/, 'test']));

await rebuild({
webpack: {
nodeExternals: {
allowlist: 'another test'
}
}
});

expect(
aver.renderer?.webpackServerConfig.nodeExternalsOptions.allowlist
).toEqual(expect.arrayContaining([/\.css$/, 'another test']));

await rebuild({
webpack: {
nodeExternals: {
includeAbsolutePaths: true
}
}
});

expect(
aver.renderer?.webpackServerConfig.nodeExternalsOptions
.includeAbsolutePaths
).toBeTruthy();
});
},
{
config: {
webpack: {
nodeExternals: {
allowlist: ['test']
}
}
}
}
);
11 changes: 11 additions & 0 deletions __tests__/fixtures/node-externals/src/App.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<div id="app"></div>
</template>

<script>
export default {
metaInfo() {
return {};
}
};
</script>
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Object {
"resources": Array [],
},
},
"nodeExternals": Object {},
"postcss": Object {},
"process": Object {
"env": Object {},
Expand Down
3 changes: 3 additions & 0 deletions packages/@averjs/config/lib/configs/renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { StyleResourcesLoaderOptions } from 'style-resources-loader';
import { ProcessOptions, AcceptedPlugin } from 'postcss';
import PostCSSPresetEnv from 'postcss-preset-env';
import { Options as BabelPresetOptions } from '@babel/preset-env';
import { Options as NodeExternalsOptions } from 'webpack-node-externals';

export type BabelOptions = Partial<
BabelPresetOptions & {
Expand All @@ -25,6 +26,7 @@ export interface AverWebpackConfig {
| ((payload: { isServer: boolean }, config: BabelOptions) => void);
additionalExtensions?: string[];
transpileDependencies?: (string | RegExp)[];
nodeExternals?: NodeExternalsOptions;
postcss?: {
preset?: PostCSSPresetEnv.pluginOptions;
sourceMap?: boolean;
Expand Down Expand Up @@ -71,6 +73,7 @@ export default (isProd: boolean): AverWebpackConfig => ({
babel: {},
additionalExtensions: ['js'],
transpileDependencies: [],
nodeExternals: {},
postcss: {},
runtimeChunk: 'single',
css: {
Expand Down
32 changes: 20 additions & 12 deletions packages/@averjs/renderer/lib/config/server.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
import webpack, { Configuration } from 'webpack';
import WebpackBaseConfiguration from './base';
import path from 'path';
import nodeExternals from 'webpack-node-externals';
import nodeExternals, { Options } from 'webpack-node-externals';
import VueSSRServerPlugin from 'vue-server-renderer/server-plugin';
import cloneDeep from 'lodash/cloneDeep';
import Core from '@averjs/core';

export default class WebpackServerConfiguration extends WebpackBaseConfiguration {
get nodeExternalsOptions() {
const options = { ...(this.webpackConfig.nodeExternals || {}) };
const allowList = options.allowlist;
delete options.allowlist;

return {
allowlist: [
/es6-promise|\.(?!(?:js|json)$).{1,5}$/i,
/\.css$/,
/\?vue&type=style/,
...this.babelLoader.transpileDeps,
...(Array.isArray(allowList) ? allowList : [allowList])
],
modulesDir: 'node_modules',
...options
} as Options;
}

constructor(aver: Core) {
super(true, aver);
}
Expand Down Expand Up @@ -43,17 +61,7 @@ export default class WebpackServerConfiguration extends WebpackBaseConfiguration
.end()
.optimization.splitChunks({})
.end()
.externals(
nodeExternals({
allowlist: [
/es6-promise|\.(?!(?:js|json)$).{1,5}$/i,
/\.css$/,
/\?vue&type=style/,
...this.babelLoader.transpileDeps
],
modulesDir: 'node_modules'
})
);
.externals(nodeExternals(this.nodeExternalsOptions));

if (typeof this.webpackConfig?.server === 'function')
this.webpackConfig.server(this.chainConfig);
Expand Down
8 changes: 6 additions & 2 deletions packages/@averjs/renderer/lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ export default class Renderer {
cb: RendererCallback | null = null;
templates: Templates[];

webpackClientConfig: WebpackClientConfiguration;
webpackServerConfig: WebpackServerConfiguration;
clientConfig: Configuration = {};
serverConfig: Configuration = {};

Expand All @@ -59,15 +61,17 @@ export default class Renderer {
this.distPath = aver.config.distPath;
this.isProd = aver.config.isProd;
this.templates = aver.config.templates || [];
this.webpackClientConfig = new WebpackClientConfiguration(this.aver);
this.webpackServerConfig = new WebpackServerConfiguration(this.aver);
}

async setup() {
this.prepareTemplates();

this.clientConfig = await new WebpackClientConfiguration(this.aver).config(
this.clientConfig = await this.webpackClientConfig.config(
this.options.static || false
);
this.serverConfig = await new WebpackServerConfiguration(this.aver).config(
this.serverConfig = await this.webpackServerConfig.config(
this.options.static || false
);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/@averjs/renderer/lib/utils/babel-loader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export default class BabelLoader {
.filter((Boolean as unknown) as ExcludesFalse);
}

presetConfig() {
presetConfig(): BabelOptions {
let config = {
buildTarget: this.isServer ? 'server' : 'client'
} as BabelOptions;
Expand Down