faasjs-project-workflow

FaasJS プロジェクトのワークフロー

デフォルトのワークフロー

1. ファイルを追加または移動する前に、プロジェクトの設定とファイル構成を確認します。
2. UI、API、データベースの変更、テストを近くにまとめ、機能を垂直スライスとして構成します。
3. 既存の tsconfig.json のエイリアスと Vite/Vitest の設定に従います。実行時の設定と対応しない新しいエイリアスを追加しないでください。
4. テストは、対象の機能またはパッケージ領域内の __tests__/ に配置します。
5. 公開 JSDoc は、パッケージのエントリーポイント、または呼び出し側との契約が明白でない共有エクスポートにのみ使用します。

これらのリファレンスを読み込む

• 新規プロジェクトのセットアップまたはオンボーディング：references/guidelines/getting-started.md。
• サポート対象のスタックとフレームワークの境界：references/guidelines/curated-stack.md。
• 完全な垂直機能の構成：references/guidelines/application-slices.md。
• ファイルの配置と抽出に関するルール：references/guidelines/file-conventions.md。
• TypeScript、Vite、共有ツールの設定：references/guidelines/project-config.md。
• CLI コマンド、型生成、マイグレーション、テストコマンド、環境変数：references/guidelines/cli-and-tooling.md。
• 識別子、ファイル、ディレクトリの名前：references/guidelines/naming-convention.md。
• JSDoc とインラインコメントの方針：references/guidelines/code-comments.md。
• テストレベルとモックの境界に関する共通ルール：references/guidelines/testing.md。

注意点

• テスト、フィクスチャ、モックは、隣接する場所ではなく、該当する __tests__/ ディレクトリ内に配置します。
• コンポーネント、フック、ヘルパー、抽象化を抽出するのは、再利用、実際の境界、または大きなコード本体がある場合に限ります。
• 変更していないコードにコメントを追加しないでください。不要になったことが確認できたコードは、マーカーを残すのではなく削除します。
• 生成済みドキュメントを直接編集するのではなく、ソースから再生成します。

検証

• 可能であれば、コードまたはドキュメントのソースを編集した後に vp check --fix を実行します。
• 動作を変更した場合は、vp test または対象を絞った vp test <pattern> を実行します。
• ガイド、ソースドキュメント、API JSDoc、またはドキュメントのナビゲーションに影響する場合は、npm run doc を実行します。