工程接入

了解 Oiyo 命令、Vite 插件和 TypeScript 类型入口

工程接入负责让 Oiyo 参与项目的开发、构建和类型生成流程。接入完成后,Oiyo 才能启用页面、扫描和类型生成等框架能力,并在 Vite 构建中处理相关逻辑。

接入内容

工程接入包含三部分:

  • 命令接入:通过 oiyo devoiyo buildoiyo prepare 运行 Oiyo。
  • 构建接入:通过 OiyoPlugin() 接入 Vite 构建系统。
  • 类型接入:通过 .oiyo/tsconfig.json 启动类型系统。

配置命令

package.json 中配置脚本:

package.json
{
  "scripts": {
    "dev": "oiyo dev",
    "build": "oiyo build",
    "postinstall": "oiyo prepare"
  }
}

命令说明:

  • oiyo dev 用于开发环境。
  • oiyo build 用于生产构建。
  • oiyo prepare 用于生成 Oiyo 构建依赖。
建议保留 postinstall,这样编辑器能更早识别自动导入、组件和页面路径声明。

配置 Vite 插件

vite.config.ts 中注册 OiyoPlugin()

vite.config.ts
import { defineConfig } from 'vite'
import OiyoPlugin from '@skiyee/oiyo/plugin'

export default defineConfig({
  plugins: [
    OiyoPlugin(),
  ],
})

配置 TypeScript

让项目根 tsconfig.json 继承 .oiyo/tsconfig.json

tsconfig.json
{
  "extends": "./.oiyo/tsconfig.json",
  "compilerOptions": {
    "types": [
      "vite/client"
    ]
  }
}
不要手动编辑 .oiyo 目录中的文件。应用级的 TypeScript 选项应该写在根 tsconfig.json

验证接入

完成工程接入后,按这个顺序检查:

  1. 运行 oiyo dev
  2. 检查 .oiyo/tsconfig.json 是否存在。
  3. 检查 tsconfig.json 是否继承 ./.oiyo/tsconfig.json
  4. 检查 vite.config.ts 是否注册 OiyoPlugin()