一些关键的路径：
build 产物的绝对路径src 目录的绝对路径pages目录的绝对路径.fes临时文件目录的绝对路径执行命令的绝对路径
package.json的内容
config实例
用户配置
插件配置可被修改，此为最终的配置
process.env
环境变量
注册阶段执行，用于描述插件或插件集的 id、key、配置信息、启用方式等。
用法：describe({ id?: string, key?: string, config?: { default, schema, onChange } }, enableBy?)
例如：
api.describe({\n key: 'esbuild',\n config: {\n schema(joi) {\n return joi.object();\n },\n default: {}\n },\n enableBy: api.EnableBy.config,\n});\n注：
',26),t=(0,p._)("li",null,[(0,p._)("code",null,"config.default"),(0,p.Uk)(" 为配置的默认值，用户没有配置时取这个")],-1),o=(0,p._)("code",null,"config.schema",-1),c=(0,p.Uk)(" 用于声明配置的类型，基于 "),l={href:"https://hapi.dev/module/joi",target:"_blank",rel:"noopener noreferrer"},i=(0,p.Uk)("joi"),r=(0,p.Uk)("，如果你希望用户进行配置，这个是必须的，否则用户的配置无效"),u=(0,p._)("li",null,[(0,p._)("code",null,"config.onChange"),(0,p.Uk)(" 是 "),(0,p._)("code",null,"dev"),(0,p.Uk)(" 阶段配置被修改后的处理机制，默认会重启 dev 进程，也可以修改为 api.ConfigChangeType.regenerateTmpFiles 只重新生成临时文件，还可以通过函数的格式自定义")],-1),d=(0,p._)("li",null,[(0,p._)("code",null,"enableBy"),(0,p.Uk)(" 为启用方式，默认是注册启用，可更改为 "),(0,p._)("code",null,"api.EnableBy.config"),(0,p.Uk)("，还可以用自定义函数的方式决定其启用时机（动态生效）")],-1),k=(0,p.uE)('为 api.applyPlugins 注册可供其使用的 hook。
用法：register({ key: string, fn: Function, pluginId?: string, before?: string, stage?: number })
参数：
api.applyPlugins时，此函数被执行。// 可同步\napi.register({\n key: 'foo',\n fn() {\n return 'a';\n },\n});\n\n// 可异步\napi.register({\n key: 'foo',\n async fn() {\n await delay(100);\n return 'b';\n },\n});\n注意：
api.appyPlugins 的 type 参数来看,如果是 api.ApplyPluginsType.add，需有返回值，这些返回值最终会被合成一个数组。如果是 api.ApplyPluginsType.modify，需对第一个参数做修改，并返回它，它会作为下个hook的参数。 如果是 api.ApplyPluginsType.event，无需返回值取得 register 注册的 hooks 执行后的数据。
用法：applyPlugins({ key: string, type: api.ApplyPluginsType, initialValue?: any, args?: any })
参数：
例如：
const foo = await api.applyPlugins({\n key: 'foo',\n type: api.ApplyPluginsType.add,\n initialValue: [],\n});\nconsole.log(foo); // ['a', 'b']\n编译时插件hook执行类型，enum 类型，包含三个属性：
往 api 上注册方法。如果有提供 fn，则执行 fn 定义的函数。
用法：registerMethod({ name: string, fn?: Function, exitsError?: boolean })
例如：
api.registerMethod({\n name: 'writeTmpFile',\n fn({\n path,\n content\n }) {\n assert(\n api.stage >= api.ServiceStage.pluginReady,\n 'api.writeTmpFile() should not execute in register stage.'\n );\n const absPath = join(api.paths.absTmpPath, path);\n api.utils.mkdirp.sync(dirname(absPath));\n if (!existsSync(absPath) || readFileSync(absPath, 'utf-8') !== content) {\n writeFileSync(absPath, content, 'utf-8');\n }\n }\n});\n然后在插件中可以使用：
api.writeTmpFile()\n例如：
api.registerCommand({\n command: 'webpack',\n description: 'inspect webpack configurations',\n options: [{\n name: '--rule <ruleName>',\n description: 'inspect a specific module rule'\n }, {\n name: '--plugin <pluginName>',\n description: 'inspect a specific plugin'\n }, {\n name: '--rules',\n description: 'list all module rule names'\n }, {\n name: '--plugins',\n description: 'list all plugin names'\n }, {\n name: '--verbose',\n description: 'show full function definitions in output'\n }],\n async fn({ rawArgv, args, options, program}) {\n }\n})\n当项目引入此插件后，使用：
fes webpack\n注册插件集，参数为路径数组。
用法：registerPresets(presets: string[])
例如：
api.registerPresets([\n { id: 'preset_2', key: 'preset2', apply: () => () => {} },\n require.resolve('./preset_3'),\n]);\n注册插件，参数为路径数组。
用法：registerPlugins(plugins: string[])
例如：
api.registerPlugins([\n { id: 'preset_2', key: 'preset2', apply: () => () => {} },\n require.resolve('./preset_3'),\n]);\n判断是否有注册某个插件，插件的 id 规则：
@@ 为前缀，比如 @@/registerMethod用法：hasPlugins(pluginIds: string[])
例如
// 判断是否有注册 @fesjs/plugin-locale\napi.hasPlugins(['@fesjs/plugin-locale']);\n提示
如果在注册阶段使用，只能判断在他之前是否有注册某个插件。
判断是否有注册某个插件集。
用法：hasPresets(presetIds: string[])
例如
// 判断是否有注册\napi.hasPlugins(['@fesjs/preset-xxx']);\n提示
如果在注册阶段使用，只能判断在他之前是否有注册某个插件集。
声明哪些插件需要被禁用，参数为插件 id 的数组。
用法：hasPresets(presetIds: string[])
例如：
// 禁用 plugin-model 插件\napi.skipPlugins(['@fesjs/plugin-model']);\n通过 api.registerMethod() 扩展的方法。
把插件需要导出的运行时 API 写入@fesjs/fes。
api.addPluginExports(() => [\n {\n specifiers: ['access', 'useAccess'],\n source: absoluteFilePath\n }\n]);\n这样用户使用时：
import { access, useAccess } from '@fesjs/fes';\n提供给其他插件运行时需要的 API。
api.addCoreExports(() => [\n {\n specifiers: ['getRoutes', 'getRouter', 'getHistory', 'destroyRouter'],\n source: absCoreFilePath\n }\n]);\n使用：
import { getHistory, destroyRouter } from '@@/core/coreExports';\n添加运行时插件，返回值格式为表示文件路径的字符串。
例如：
api.addRuntimePlugin(() => join(__dirname, './runtime'));\n添加插件提供的运行时配置的 key，返回值格式为字符串。
例如：
api.addRuntimePluginKey(() => 'some');\n则用户可以：
// app.js\nconst some = function(){\n return {\n\n }\n}\n\n在入口文件现有 import 的前面添加 import。
例如：
api.addEntryImportsAhead(() => [{ source: 'anypackage' }]);\n在入口文件现有 import 的后面添加 import。
例如：
api.addEntryImport(() => {\n return [\n {\n source: '/modulePath/xxx.js',\n specifier: 'moduleName',\n }\n ]\n});\n在入口文件最前面（import 之后）添加代码。
例如：
api.addEntryCodeAhead(\n () => `${globalCSSFile\n .map(file => `require('${winPath(relative(absTmpPath, file))}');`)\n .join('')}`\n\n在入口文件最后添加代码。
例如：
api.addEntryCode(() => {\n return `console.log('works!')`\n})\n在 HTML 头部添加脚本。
例如：
api.addHTMLHeadScripts(() => {\n return [\n {\n content: '',\n src: '',\n // ...attrs\n },\n ];\n});\n添加在 webpack compiler 中间件之前的中间件，返回值格式为 express 中间件。
例如：
api.addBeforeMiddlewares(() => {\n return (req, res, next) => {\n if (false) {\n res.end('end');\n } else {\n next();\n }\n };\n});\n添加在 webpack compiler 中间件之后的中间件，返回值格式为 express 中间件。
添加重新生成临时文件的监听路径。
例如：
api.addTmpGenerateWatcherPaths(() => [\n './app.js',\n]);\n通过 [webpack-chain] 的方式修改 webpack 配置。
例如：
api.chainWebpack((memo) => {\n memo.resolve.alias.set('vue-i18n', 'vue-i18n/dist/vue-i18n.esm-bundler.js');\n});\n批量写临时文件。
例如：
api.copyTmpFiles({\n namespace,\n path: join(__dirname, 'runtime'),\n ignore: ['.tpl']\n});\n参数：
提示
不能在注册阶段使用，通常放在 api.onGenerateFiles() 里，这样能在需要时重新生成临时文件 临时文件的写入做了缓存处理，如果内容一致，不会做写的操作，以减少触发 webpack 的重新编译
获取端口号，dev 时有效。
获取 hostname，dev 时有效。
获取 devServer，dev 时有效。
获取 api.modifyRoutes 修改过后的路由信息。
获取格式化后的路由信息
修改路由。
例如：
// 把BaseLayout插入到路由配置中，作为根路由\napi.modifyRoutes(routes => [\n {\n path: '/',\n component: winPath(\n join(api.paths.absTmpPath || '', absFilePath)\n ),\n children: routes\n }\n]);\n修改获取 bundleConfig 的函数参数。
例如：
api.modifyBundleConfigOpts(memo => {\n memo.miniCSSExtractPluginPath = require.resolve('mini-css-extract-plugin');\n memo.miniCSSExtractPluginLoaderPath = require.resolve(\n 'mini-css-extract-plugin/dist/loader',\n );\n return memo;\n});\n\n修改 bundle 配置。
api.modifyBundleConfig((bundleConfig) => {\n // do something\n return bundleConfig;\n});\n修改 babel 配置项。
例如：
api.modifyBabelOpts((babelOpts) => {\n if (api.config.babelPluginImport) {\n api.config.babelPluginImport.forEach((config) => {\n babelOpts.plugins.push(['import', config]);\n });\n }\n return babelOpts;\n});\n修改 babel 插件的配置。
例如：
api.modifyBabelPresetOpts(opts => {\n return {\n ...opts,\n import: (opts.import || []).concat([\n { libraryName: 'ant-design-vue', libraryDirectory: 'es', style: true },\n ]),\n };\n});\n修改 paths 对象。
修改默认配置。 例如：
api.modifyDefaultConfig((memo) => {\n return {\n ...memo,\n ...defaultOptions,\n };\n});\n修改最终配置。
例如：
api.modifyConfig((memo) => {\n return {\n ...memo,\n ...defaultOptions,\n };\n});\n\n修改 publicPath 字符串。
例如：
api.modifyPublicPathStr(() => {\n return api.config.publicPath || '/';\n});\n在插件初始化完成触发。在 onStart 之前，此时还没有 config 和 paths，他们尚未解析好。
在命令注册函数执行前触发。可以使用 config 和 paths。
dev 退出时触发。
生成临时文件，触发时机在 webpack 编译之前。
重启 devServer，dev 时有效。
写临时文件。
例如：
api.writeTmpFile({\n path: absoluteFilePath,\n content: Mustache.render(\n readFileSync(join(__dirname, 'runtime/core.tpl'), 'utf-8'),\n {\n REPLACE_ROLES: JSON.stringify(roles)\n }\n )\n});\n参数：
提示
不能在注册阶段使用，通常放在 api.onGenerateFiles() 里，这样能在需要时重新生成临时文件 临时文件的写入做了缓存处理，如果内容一致，不会做写的操作，以减少触发 webpack 的重新编译