SynthKernelについて
SynthKernelは、効率的でクリーンかつモジュール化されたコードを書くためのTypeScriptソフトウェアアーキテクチャです。
SynthKernelの標準的な実践は、モジュールローダークラスとモジュールクラスから構成されます。
- モジュールローダークラスはモジュールのライフサイクルを管理し、型を統括し、アプリケーションロジックの表面でファサードとして振る舞います。
- すべてのモジュールクラスは
BaseModuleクラスを拡張し、APIを定義し、実際のロジックを実行し、ローダークラスを拡張し、依存性注入を介して相互に配線します。 - 型はジェネリクスの統括によって解決されます。
- モジュールはローダーに組み合わされてAPPを形成します。モジュールローダー自体も親ローダーのモジュールになることができます。
- バックエンドサービス、複雑な自動化、CLIアプリケーション、キャンバスレンダリングエンジンなど、ほぼすべてのユースケースに適用可能です。
ファイルシステムの規約
SynthKernelはツリー構造で構成されるべきです。
ローダー、ベースモジュール、およびそのすべての直接モジュールは、1つのフォルダにフラットに配置する必要があります。
- ローダーを収容するファイルは
index.tsという名前にします - ベースモジュールは
BaseModule.tsという名前にします - 型は
types.tsという名前にします - すべてのモジュールは
(PascalCaseのモジュール名).tsという名前にします - その他のファイルの名前には制限はありません
肥大化したモジュールを新しいローダー・モジュール構造に変換し、そのモジュールを上記と同じ要件を持つフォルダに変更するのが標準的なプラクティスです。
使用すべき場合
- 開発の初期段階で、ロジックの手がかりはあるがまだコードを書いていない場合
- 明確なアーキテクチャの規約がない場合
- リファクタリング中で、大きなモジュールを分割したりプロジェクトをモジュール化したい場合
- 新しい機能を追加して新しいモジュールを作成しようとしており、SynthKernelを理解したい場合
使用すべきでない場合
- アーキテクチャを作成または変更することを想定していない場合
- 独自の規約を持つWeb UIを開発している場合
- 古典的なモノリスがより便利な小規模プロジェクト(200行未満)に対応している場合
アクション
- SynthKernelをゼロから実装するか、既存のコードをSynthKernelにリファクタリングする場合は、startに進んでください。
- 新しいモジュールを追加するか、モジュールを分割する場合は、maintenanceに進んでください。
- 標準的な実践の例は、./exampleにあります。