CLI · 第1層
ライフサイクル
各ワークスペースで使用される5つの標準コマンド — create / dev / build / preview / typecheck。形はViteやAstroと同じで、openpress: プレフィックスはありません。
OpenPressのコア設計理念の1つは、ドキュメントのライフサイクルを現代のソフトウェア開発のライフサイクルと一致させることです。これは、ドキュメントの作成、プレビュー、検証、デプロイメントが、一般的なフロントエンドフレームワーク(ViteやAstroなど)と同じリズムに従うことを意味します。
なぜライフサイクルコマンドが必要なのか?
従来のドキュメントエディターでは、ドキュメントの状態は通常「編集中」と「エクスポート済み」の2つしかありません。しかし、OpenPressでは、ドキュメントはコードとして扱われます(Docs as Code)。これにより、いくつかの重要な概念的転換がもたらされます:
- 開発とプレビューの分離: コンテンツを作成する際、即時のフィードバック(ホットリロード)を提供し、コメントを表示し、Agentが介入できる環境が必要です。これが
devフェーズの意義です。 - ビルドと検証: ドキュメントは公開前に厳格な検証を経る必要があります。すべてのコンポーネントが正しくレンダリングされ、すべてのリンクが有効であり、TypeScriptの型エラーがないことを確認する必要があります。これが
buildとtypecheckの役割です。 - 静的配信: 最終的に出力されるドキュメントは、特定のサーバー環境に依存するべきではありません。それらは純粋な静的ファイルにコンパイルされ、任意の静的ウェブサイトホスティングサービスにデプロイできます。
コアサイクル概念
5つの標準コマンドを通じて、OpenPressは明確なサイクルを定義しています:
- 起点 (Create): 新しいワークスペースを作成します。このフェーズは単にフォルダーを作成するだけでなく、ドキュメントの種類(プレゼンテーションやレポートなど)を確定し、後続のすべてのフェーズに必要なインフラストラクチャを設定します。
- 反復 (Dev): これは作者とAgentが最も頻繁に留まるフェーズです。このフェーズでは、システムは開発者体験に焦点を当てています。開発サーバーを提供し、リアルタイムのスタイルとコンテンツの更新をサポートし、さまざまなデバッグ支援インターフェースを開きます。
- 検証 (Typecheck): TypeScriptを使用する高度な作者向けに、このフェーズはカスタムコンポーネントや高度な設定の型安全性を確保し、実行時エラーを防ぎます。
- パッケージ化 (Build): 動的な開発環境を静的な本番環境の成果物に変換します。このフェーズでは、開発専用のツール(ワークベンチインターフェースなど)がすべて削除され、出力が最適化されます。
- 確認 (Preview): 最終的なデプロイの前に、本番環境を正確にシミュレートするローカルプレビューを提供し、読者が最終的に見る正確な外観を作者が確認できるようにします。
このようなフロントエンド開発と一致したライフサイクルは、開発者の学習のハードルを下げるだけでなく、さらに重要なことに、予測可能で自動化可能、かつ高度に安定したドキュメントの生産プロセスを確立します。