クイックスタート
数分でFSDアーキテクチャのプロジェクトを立ち上げる
FSD CLIは、React、Next.js、Vue、Nuxt、SvelteKitのプロジェクトを完全なFeature-Sliced Design構造で作成し、プロジェクトの成長に合わせてスライス(features、entities、widgets、pages)を生成するコマンドラインツールです。ドキュメントの残りの部分は今のところ英語のみです。
要件
CLIにはNode.js 22.12.0 以降が必要です。NuxtとSvelteKitのプロジェクトにはNode.js 22.22.2以降が必要です。インストールされているバージョンを確認してください:
bash
node --versionプロジェクトを作成する
プロジェクトを作成したいディレクトリでコマンドを実行し、インタラクティブなウィザードでフレームワーク、状態管理、テンプレートを選択します:
bash
npx create-fsd-architecture@latest my-appまたは、フレームワークを指定してデフォルト設定をそのまま受け入れます:
bash
npx create-fsd-architecture@latest my-app --framework react-vite --yesスライスを生成する
プロジェクトのルートで、ジェネレーターはfsd.config.jsonファイルを読み取り、フレームワーク用のファイルを生成します。--dry-runを使うと、まず生成されるファイルのプレビューを確認できます:
bash
npx create-fsd-architecture@latest -g entity product --dry-run
npx create-fsd-architecture@latest -g feature cart
npx create-fsd-architecture@latest -g widget navbar
npx create-fsd-architecture@latest -g page catalog各スライスにはindex.tsファイルが生成されます。これはパブリックAPIであり、他のレイヤーがそのスライスからインポートできる唯一の方法です。
安全なアップグレード
新しいバージョンのツールをインストールしても、プロジェクトが自動的に変更されることはありません。まずアップグレード計画を確認し、競合がないことを確認してから適用してください:
bash
npx create-fsd-architecture@latest upgrade --dry-run
npx create-fsd-architecture@latest upgrade --yes次のステップ
- 設定ファイル fsd.config.json (英語)
- スライスジェネレーターガイド (英語)
- 安全なアップグレードについて詳しく見る (英語)