プラグイン（Plugin）
Riebeckiteのプラグインは、定められた契約を通じて、コンテンツの解釈、変換、描画、診断、ビルド時の処理、エンドポイント、ブラウザでの動作を拡張します。
拡張ポイント
プラグインは provides、requires、optional でケイパビリティを宣言し、依存関係を解決したパイプラインに加わります。
definePlugin({
name: "example",
provides: ["content.graph"],
requires: ["cache"],
optional: ["example.optional"],
});Coreの拡張ポイントには、remark/rehypeパイプライン、コンテンツフック、レンダラー、ページ種別、アセット、クライアントエントリ、エンドポイント、診断があります。
ライフサイクル
フックは解決済みのプラグイン順に実行されます。setup、buildStart、コンテンツ処理、buildEnd、dispose（逆順）です。
名前付きフック（onConfigResolved、onContentLoaded、onPostParsed、onPostProcessed、onManifestCreated）はコンテンツの各段階に参加します。
ケイパビリティシステム（provides/requires/optional）
プラグインは provides、requires、optional でケイパビリティを宣言し、依存関係を解決したパイプラインに加わります。resolvePlugins 関数はプラグインを order フィールドの順に処理し、続いて依存関係を解決して、ケイパビリティを提供するプラグインを、それを必要とするプラグインより前に並べます。必須のケイパビリティに提供者が存在しない場合、解決は診断を出して失敗します。
definePlugin({
name: "example",
provides: ["content.graph"],
requires: ["cache"],
optional: ["example.optional"],
})provides：このプラグインがパイプラインに提供するケイパビリティ。ケイパビリティには有効な提供者がちょうど1つ必要で、重複する提供者は解決失敗になります。requires：このプラグインが依存するケイパビリティ。解決は各提供者をこのプラグインより前に並べ、提供者がいない場合は診断を出して失敗します。optional：利用可能なら使うケイパビリティ。提供者がいなくても無視され、存在する提供者はこのプラグインより前に並べられます。
getResolvedPluginMetadata ユーティリティは、各プラグインの解決済みのprovides/requires/optionalを ResolvedPluginMetadata として公開し、パイプラインが順序決定と診断に使います。
アセットとクライアントエントリ
CSSは assets、ブラウザ向けJavaScriptは clientEntries で宣言します。宣言するのは本当に必要な場合だけにしてください。
assets: [createStyleAsset("example", "@example/plugin/style.css")],
clientEntries: [
createClientEntry("example", "@example/plugin/client", "init", { selector: ".example" }),
],関連用語
- Plugin cache
- Plugin dependency
- Lifecycle hook
- Content hook
- Renderer
- Endpoint
- Client entry
- Island
- Asset
- Diagnostics
- Diagnostic code