配置 .kktprc

kktp内置配置处理包，配置约定在根目录，命名为 .kktprc.[ts|js]。

参数

1import webpack from 'webpack';
2import { LoaderConfOptions, WebpackConfiguration } from 'kkt';
3import { RouterPluginProps } from '@kkt/plugin-pro-router';
4import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer';
5
6export type DefaultDefineType = {};
7
8export type OverrideWebpackType = (
9  conf: WebpackConfiguration,
10  env: 'development' | 'production',
11  options?: LoaderConfOptions | undefined,
12) => WebpackConfiguration;
13
14export type PluginsType = (
15  | ((this: webpack.Compiler, compiler: webpack.Compiler) => void)
16  | webpack.WebpackPluginInstance
17  | [string, Record<string, any>]
18  | string
19)[];
20
21export type KKTPlugins = (
22  | OverrideWebpackType
23  | {
24      loader?: OverrideWebpackType;
25      options?: LoaderConfOptions | undefined | Record<string, any>;
26    }
27  | string
28  | [string, Record<string, any>]
29)[];
30
31export type KKTPAnalyze = BundleAnalyzerPlugin['opts'];
32
33export interface OverrideKKTPConfigProps extends Omit<WebpackConfiguration, 'plugins'> {
34  /**
35   * 别名
36   * 默认系统内置两个别名
37   * 1. `@` 指向 src 目录
38   * 2. `@@` 指向 src/.kktp 目录
39   */
40  alias?: Record<string, string | false | string[]>;
41  /** 插件 */
42  plugins?: PluginsType;
43  /** 默认全局变量 define ， 注意：对象的属性值会经过一次 JSON.stringify 转换   */
44  define?: Record<string, any> & DefaultDefineType;
45  /** kkt plugin  */
46  kktPlugins?: KKTPlugins;
47  /** 项目前缀 */
48  publicPath?: string;
49  /** 提供回调函数，更改 webpack 的最终配置。 */
50  overrideWebpack?: OverrideWebpackType;
51  /** 输出 */
52  output?: Omit<WebpackConfiguration['output'], 'publicPath'>;
53  /**自动生成文件目录名称**/
54  cacheDirName?: string;
55  /**自动生成入口文件*/
56  initEntery?: boolean;
57  /**路由配置*/
58  initRoutes?: RouterPluginProps | boolean;
59  /**
60   * 1. 自动生成models集合配置文件
61   * 2. 当传递的是字符串的时候，用于自己定义状态管理的引用地址
62   */
63  initModel?: boolean | string;
64  /** 是否开启权限 */
65  access?: boolean;
66  /** 分析产物构成 */
67  analyze?: KKTPAnalyze;
68}
69
70

配置文件

1// .kktprc.ts
2export default {
3  // ...
4  alias:{
5    "react-native":"react-native-web",
6  },
7  define:{
8    "BAST":"111",
9    "TEST":"222"
10  }
11  initEntery:true,
12  initRoutes:true,
13}

plugins使用

1// .kktprc.ts
2export default {
3  // ...
4  plugins:["@kkt/plugin-pro-router"]
5  // plugins:[["@kkt/plugin-pro-router",{ autoRoutes:true, }]]  
6}

analyze 使用

用于分析 bundle 构成。通过配置--analyzer=1生效。可以通过analyze选项自定义配置。analyze 插件的具体配置项，见 webpack-bundle-analyzer

1// package.json
2"scripts": {
3  "start": "kktp start --analyzer=1",
4  "build": "kktp build --analyzer=1"
5},
6
7// .kktprc.ts
8export default {
9  // ...
10  analyzer: {
11    analyzerPort: 9999 // 自定义端口
12  }
13}

overrideWebpack 使用

1// .kktprc.ts
2export default {
3  // ...
4  overrideWebpack:(conf, env, options)=>{
5    // 处理 conf
6    return conf;
7  }
8}

Contributors

License

Licensed under the MIT License.