配置系统

了解 Oiyo 的框架配置和页面全局配置

配置系统是 Oiyo 的能力开关。框架配置决定项目启用哪些能力,页面配置决定全局页面信息如何进入 pages.json,应用配置决定应用信息如何进入 manifest.json。

Oiyo 常用配置分三层:

  • 框架配置:oiyo.config.ts,用于整个框架的功能配置。
  • 页面配置:src/pages.config.ts,用于声明页面的全局配置。
  • 应用配置:src/manifest.config.ts,用于声明应用的 manifest.json 配置。

框架配置

默认情况下,Oiyo 内置配置已覆盖大多数常见场景。需要调整时,可以通过 oiyo.config.ts 扩展配置。

defineOiyoConfig() 用于定义框架配置:

oiyo.config.ts
import { defineOiyoConfig } from "@skiyee/oiyo/config";

export default defineOiyoConfig({
  scan: {
    apis: [
      // 配置 API 扫描源
    ],
    components: [
      // 配置组件扫描源
    ],
  },
  ide: {
    // 配置自动打开小程序 IDE
  },
  exclude: [
    // 配置排除文件
  ],
});
了解 defineOiyoConfig 有哪些配置

页面配置

definePagesConfig() 用于定义页面全局配置。页面文件中的 definePageMeta() 负责单个页面配置。

src/pages.config.ts
import { definePagesConfig } from "@skiyee/oiyo/config";

export default definePagesConfig({
  globalStyle: {
    // 配置全局性页面样式
  },
  tabBar: {
    // 配置 TabBar 样式
  },
});
pages.config.ts 必须位于 <srcDir> 目录中。
了解 definePagesConfig 有哪些配置

应用配置

defineManifestConfig() 用于定义应用配置。Oiyo 会将该配置与内置默认预设(与 uni-app 官方预设一致)合并,生成 src/manifest.json。

src/manifest.config.ts
import { defineManifestConfig } from "@skiyee/oiyo/config";

export default defineManifestConfig({
  name: "我的应用",
  appid: "__UNI__XXXXXX",
});
manifest.config.ts 必须位于 <srcDir> 目录中。
了解 defineManifestConfig 有哪些配置