1k-coding-patterns について
OneKey の貢献者やコーディングエージェント向けに、Promise、React コンポーネント、制限対象 API、日付形式、エラー処理の規約をまとめたスキルです。実装やレビュー時に参照できます。
主な機能
- 01Promise の処理規則
- 02React コンポーネントの規約
- 03制限対象 API とインポートパターン
- 04OneKey の日付形式ガイド
- 05RPC・ランタイム境界でのエラー処理
活用シーン
- 01実装時の Promise 処理の確認
- 02React コンポーネント規約への準拠
- 03指定された日付形式の選択
- 04インポートとエラー伝播のレビュー
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ onekeyhq/ app-monorepo --skill 1k-coding-patternsインストール後、Claude Code で/1k-coding-patternsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/date-formatting.mderror-handling.mdreferences/rules/date-formatting.mderror-handling.mdpromise-handling.mdreact-components.mdrestricted-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- リントとコード品質/1k-performance- パフォーマンスの最適化/1k-state-management- Jotaiアトムのパターン/1k-architecture- プロジェクト構成とインポートのルール
コメント
Markdown 対応