1k-coding-patterns

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

OneKey Coding Patterns and Best Practices

OneKey 编码模式与最佳实践

Quick Reference

快速参考

Topic	Guide	Key Points
Promise handling	promise-handling.md	Always await or use `void` , never floating promises
React components	react-components.md	Named imports, functional components, no FC type
Restricted patterns	restricted-patterns.md	Forbidden: `toLocaleLowerCase` , direct hd-core import

主题	指南	核心要点
Promise处理	promise-handling.md	始终使用await或 `void` ，禁止出现游离Promise
React组件	react-components.md	具名导入、函数式组件，禁止使用FC类型
受限模式	restricted-patterns.md	禁止： `toLocaleLowerCase` 、直接导入hd-core

Critical Rules Summary

核心规则摘要

Promise Handling

Promise处理

typescript

// ❌ FORBIDDEN - floating promise
apiCall();

// ✅ CORRECT
await apiCall();
// or
void apiCall(); // intentionally not awaited

typescript

// ❌ 禁止 - 游离Promise
apiCall();

// ✅ 正确
await apiCall();
// 或
void apiCall(); // 有意不使用await

React Components

React组件

typescript

// ❌ FORBIDDEN
import React, { FC } from 'react';
const MyComponent: FC<Props> = () => {};

// ✅ CORRECT
import { useState, useCallback } from 'react';
function MyComponent({ prop }: { prop: string }) {}

typescript

// ❌ 禁止
import React, { FC } from 'react';
const MyComponent: FC<Props> = () => {};

// ✅ 正确
import { useState, useCallback } from 'react';
function MyComponent({ prop }: { prop: string }) {}

Restricted Patterns

受限模式

typescript

// ❌ FORBIDDEN
string.toLocaleLowerCase()
import { x } from '@onekeyfe/hd-core';
import { localDbInstance } from '...';

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

typescript

// ❌ 禁止
string.toLocaleLowerCase()
import { x } from '@onekeyfe/hd-core';
import { localDbInstance } from '...';

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

1k-coding-patterns

Original

Translation

OneKey Coding Patterns and Best Practices

OneKey 编码模式与最佳实践

Quick Reference

快速参考

Critical Rules Summary

核心规则摘要

Promise Handling

Promise处理

React Components

React组件

Restricted Patterns

受限模式

Related Skills

相关技能