fix: 修复 configWebpack 缺少的 webpack 实例参数

remaxjs · May 6, 2020 · 52cb52a · 52cb52a · vercel · May 6, 2020
1 parent 9a325d6
commit 52cb52a
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 9 deletions.
diff --git a/docs/guide/advanced/plugin.md b/docs/guide/advanced/plugin.md
@@ -63,6 +63,7 @@ export default lessPlugin;
 
 - `params`
  - `config` - `webpack-chain` 的 `Config 对象`。
+ - `webpack` - Webpack 实例，用于获取 Webpack 内置插件。
  - `addCSSRule` - 新增一条 CSS 处理规则。
 
 ### configBabel

diff --git a/docs/guide/config/remax.md b/docs/guide/config/remax.md
@@ -49,9 +49,14 @@ _默认值：_ `true`
 // remax.config.js
 
 module.exports = {
- configWebpack({ config }) {
+ configWebpack({ config, webpack }) {
  // config 是的 [webpack-chain](https://github.com/neutrinojs/webpack-chain) Config 对象。
  config.plugins.delete('webpackbar'); // 去掉进度条
+ config.plugin('custom-define').use(webpack.DefinePlugin, [
+ {
+ __MOCK__: JSON.stringify(process.env.MOCK),
+ },
+ ]); // 新增一个 define 插件
  },
 };
 ```

diff --git a/packages/remax-cli/src/API.ts b/packages/remax-cli/src/API.ts
@@ -92,7 +92,7 @@ export default class API {
  }, true);
  }
 
- configWebpack(params: { config: Config; addCSSRule: (ruleConfig: RuleConfig) => void }) {
+ configWebpack(params: { config: Config; webpack: any; addCSSRule: (ruleConfig: RuleConfig) => void }) {
  this.plugins.forEach(plugin => {
  if (typeof plugin.configWebpack === 'function') {
  plugin.configWebpack(params);

diff --git a/packages/remax-cli/src/build/webpack/config.mini.ts b/packages/remax-cli/src/build/webpack/config.mini.ts
@@ -1,5 +1,5 @@
 import * as path from 'path';
-import { Configuration } from 'webpack';
+import * as webpack from 'webpack';
 import Config from 'webpack-chain';
 import MiniCssExtractPlugin from 'mini-css-extract-plugin';
 import WebpackBar from 'webpackbar';
@@ -68,7 +68,7 @@ function resolveBabelConfig(options: Options) {
  return false;
 }
 
-export default function webpackConfig(api: API, options: Options, target: Platform): Configuration {
+export default function webpackConfig(api: API, options: Options, target: Platform): webpack.Configuration {
  baseConfig(config, options, target);
 
  const { meta, turboPagesEnabled, entries, entryMap, pageEntries, stubModules, publicPath } = prepare(
@@ -201,11 +201,12 @@ export default function webpackConfig(api: API, options: Options, target: Platfo
  config.plugin('remax-coverage-ignore-plugin').use(RemaxPlugins.CoverageIgnore);
 
  if (typeof options.configWebpack === 'function') {
- options.configWebpack({ config });
+ options.configWebpack({ config, webpack });
  }
 
  api.configWebpack({
  config,
+ webpack,
  addCSSRule: (ruleConfig: RuleConfig) => {
  addCSSRule(config, options, false, ruleConfig);
  },

diff --git a/packages/remax-cli/src/build/webpack/config.web.ts b/packages/remax-cli/src/build/webpack/config.web.ts
@@ -1,6 +1,6 @@
 import * as path from 'path';
 import * as fs from 'fs';
-import { Configuration } from 'webpack';
+import * as webpack from 'webpack';
 import Config from 'webpack-chain';
 import MiniCssExtractPlugin from 'mini-css-extract-plugin';
 import HtmlWebpackPlugin from 'html-webpack-plugin';
@@ -40,7 +40,7 @@ function prepare(options: Options) {
  };
 }
 
-export default function webpackConfig(api: API, options: Options): Configuration {
+export default function webpackConfig(api: API, options: Options): webpack.Configuration {
  baseConfig(config, options, Platform.web);
 
  const { entries, appConfig, publicPath } = prepare(options);
@@ -130,11 +130,12 @@ export default function webpackConfig(api: API, options: Options): Configuration
  config.plugin('remax-define-plugin').use(RemaxPlugins.Define, [options, entries]);
 
  if (typeof options.configWebpack === 'function') {
- options.configWebpack({ config });
+ options.configWebpack({ config, webpack });
  }
 
  api.configWebpack({
  config,
+ webpack,
  addCSSRule: (ruleConfig: RuleConfig) => {
  addCSSRule(config, options, false, ruleConfig);
  },

diff --git a/packages/remax-types/src/index.ts b/packages/remax-types/src/index.ts
@@ -18,7 +18,7 @@ export interface Options {
  rootDir: string;
  compressTemplate?: boolean;
  UNSAFE_wechatTemplateDepth: number | { [key: string]: number };
- configWebpack?: (params: { config: WebpackConfig }) => void;
+ configWebpack?: (params: { config: WebpackConfig; webpack: any }) => void;
  plugins: Plugin[];
  one?: boolean;
  notify?: boolean;