mcpField
1
1k-dev-commands

1k-dev-commands

github.com/onekeyhq开发2.5k71 次安装今天更新
代码仓库

关于 1k-dev-commands

面向 OneKey 贡献者的开发技能，整理桌面、Web、扩展、移动端和可嵌入应用的运行与构建命令，以及验证和测试流程。

主要功能

  1. 01各平台应用开发命令
  2. 02生产构建命令
  3. 03提交前与 CI 验证
  4. 04Jest 测试指南
  5. 05清理依赖与重新安装命令

适用场景

  1. 01启动特定平台的 OneKey 应用
  2. 02构建应用以进行发布验证
  3. 03在提交或 PR 前运行检查

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/onekeyhq/app-monorepo --skill 1k-dev-commands

安装后在 Claude Code 中输入/1k-dev-commands确认已加载。

附带文件references/git-workflow.mdreferences/mobile-dev-shell.md

详细介绍

OneKey 开发命令

有关分支命名、提交格式、变基和 PR 规范，请阅读 git-workflow.md。

应用开发命令

特定平台开发：

  • yarn app:desktop - 使用 Rspack 启动桌面 Electron 应用开发

    • 运行时间：启动需要 30-60 秒
    • 常见问题：Node 版本冲突、缺少原生依赖
    • 故障排除：如果启动失败，请运行 yarn clean && yarn reinstall

  • yarn app:web:rspack - 启动 Web 开发服务器（端口 3000）

    • 运行时间：启动需要 15-30 秒
    • 常见问题：端口 3000 已被占用、Rspack 编译错误
    • 故障排除：结束占用端口 3000 的现有进程，并在控制台中查看具体错误

  • yarn app:ext - 使用 Rspack 启动浏览器扩展开发

    • 运行时间：启动需要 20-40 秒
    • 常见问题：Manifest v3 验证错误、权限问题
    • 故障排除：检查扩展清单是否有效，并确认内容安全策略

  • Mobile DevSession launcher - 常规 iOS/Android React Native 开发的默认路径。启动应用、恢复 shell/vendor 资源或连接 UI 工具前，请先阅读本指南。

  • yarn app:ios - 通过 Mobile DevSession launcher 启动 iOS 开发

    • 运行时间：1-2 分钟（包括 Metro bundler）
    • 常见问题：Xcode 配置、模拟器问题、pod install 失败
    • 前置条件：已安装 Xcode，并且有可用的 iOS 模拟器

  • yarn app:android - 通过 Mobile DevSession launcher 启动 Android 开发

    • 运行时间：1-2 分钟（包括 Metro bundler）
    • 常见问题：Android SDK 路径、模拟器配置、Gradle 构建失败
    • 前置条件：已安装 Android Studio 和 SDK 工具，并已配置模拟器

  • 直接进行本地原生构建：yarn workspace @onekeyhq/mobile ios 和 yarn workspace @onekeyhq/mobile android。仅在明确要求或诊断 launcher 时使用。

  • yarn app:web-embed - 启动可嵌入组件开发

    • 运行时间：15-30 秒
    • 用途：开发独立的钱包组件

构建命令

生产构建（用于最终验证）：

  • yarn app:desktop:build - 为所有平台构建桌面应用

    • 运行时间：5-10 分钟（多平台构建）
    • 输出：平台专用安装包位于 apps/desktop/dist/
    • 常见问题：代码签名、平台专用依赖
    • 验证：在目标平台上测试安装包

  • yarn app:ext:build - 构建浏览器扩展

    • 运行时间：2-3 分钟
    • 输出：未打包的扩展位于 apps/ext/build/chrome_v3/
    • 常见问题：清单验证、内容安全策略违规
    • 验证：在浏览器中加载扩展进行测试

  • yarn app:web:build - 构建 Web 应用

    • 运行时间：3-5 分钟
    • 输出：静态文件位于 apps/web/dist/
    • 常见问题：包体积限制、缺少环境变量
    • 验证：提供构建后的文件并测试功能

  • yarn app:native-bundle - 打包 React Native 应用

    • 运行时间：3-5 分钟
    • 输出：平台专用包
    • 常见问题：原生模块链接、Metro bundler 错误
    • 前置条件：已正确配置平台开发环境

开发工具与质量保证

提交前命令（本地开发）

快速进行 Agent 提交前验证时使用：

  • yarn agent:check --profile commit - 运行已暂存文件的 lint 和类型检查，并以紧凑格式输出

提交前工作流：

yarn agent:check --profile commit && git commit -m "your message"
CI 命令（完整项目检查）

这些命令用于 CI 流水线或全面验证：

  • yarn lint - 全面检查代码规范（TypeScript、oxlint、文件夹结构、i18n）
    • 预期运行时间：约 1 分钟
    • 零容忍：必须修复所有警告和错误
    • 使用场景：CI 流水线和全面的 PR 前检查
  • 不要运行 yarn eslint、npx eslint 或 node_modules/.bin/eslint。 ESLint 条目是为兼容旧版本而保留的；当前的代码规范检查通过 agent:check 或 yarn lint 使用 oxlint。
  • yarn test - 执行 Jest 测试
    • 使用场景：CI 流水线和测试验证
其他工具
  • yarn clean - 清除所有构建产物和 node_modules
  • yarn reinstall - 全新安装（依赖项出现问题时使用）

测试

  • Jest 配置位于 jest.config.js
  • 测试设置位于 jest-setup.js
  • 测试位于各软件包中的 @tests/ 目录
  • 移动端测试使用 jest-expo 预设

评论

支持 Markdown