mcpField
1
1k-coding-patterns

1k-coding-patterns

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

关于 1k-coding-patterns

面向 OneKey 贡献者和编码 Agent 的代码模式规范,涵盖 Promise、React 组件、受限 API、日期格式化和错误处理,供实现与审查时参考。

主要功能

  1. 01Promise 处理规则
  2. 02React 组件规范
  3. 03受限 API 与导入模式
  4. 04OneKey 日期格式化指引
  5. 05RPC 和运行时边界的错误处理

适用场景

  1. 01实现时检查 Promise 处理方式
  2. 02遵循 React 组件仓库规范
  3. 03选择规定的日期格式化方式
  4. 04审查导入和错误传递

安装

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

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

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

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
date-formatting.md
error-handling.md
references/rules/
date-formatting.md
error-handling.md
promise-handling.md
react-components.md
restricted-patterns.md

详细介绍

OneKey 编码模式与最佳实践

快速参考

主题指南要点
Promise 处理promise-handling.md始终 await 或使用 void,绝不要出现浮动 Promise
React 组件react-components.md具名导入、函数组件、不使用 FC 类型
受限模式restricted-patterns.md禁止:toLocaleLowerCase、直接导入 hd-core
日期格式化date-formatting.md使用 OneKey 的 dateUtils,不要用原生日期格式化
错误处理error-handling.md在 RPC/运行时边界间保留错误

关键规则摘要

Promise 处理
// ❌ FORBIDDEN - floating promise
apiCall();

// ✅ CORRECT
await apiCall();
// or
void apiCall(); // intentionally not awaited
React 组件
// ❌ FORBIDDEN
import React, { FC } from 'react';
const MyComponent: FC<Props> = () => {};

// ✅ CORRECT
import { useState, useCallback } from 'react';
function MyComponent({ prop }: { prop: string }) {}
受限模式
// ❌ FORBIDDEN
string.toLocaleLowerCase()
import { x } from '@onekeyfe/hd-core';
import { localDbInstance } from '...';

// ✅ CORRECT
string.toLowerCase()
const { x } = await CoreSDKLoader();
import { localDb } from '...';

相关技能

  • /1k-i18n - 国际化与翻译
  • /1k-cross-platform - 平台特定代码
  • /1k-code-quality - Lint 与代码质量
  • /1k-performance - 性能优化
  • /1k-state-management - Jotai atom 模式
  • /1k-architecture - 项目结构与导入规则

评论

支持 Markdown