Skip to content

Commit e85a7dd

Browse files
authored
docs: plugin authors guide for rolldown-vite (#1907)
1 parent e0b3c3a commit e85a7dd

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

guide/rolldown.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,104 @@ Rolldown は Rollup の代替として機能することを目指しています
9191
`rolldown-vite` パッケージは、フィードバックを収集し Rolldown 統合を安定させるための一時的な解決策です。将来的には、この機能はメインの Vite リポジトリーにマージされる予定です。
9292

9393
`rolldown-vite` を試して、フィードバックや問題報告を通じてその開発に貢献することをお勧めします。
94+
95+
## プラグイン / フレームワーク作者向けガイド
96+
97+
### 主な変更点
98+
99+
- ビルドに Rolldown が使用されます(以前は Rollup が使用されていました)
100+
- オプティマイザーに Rolldown が使用されます(以前は esbuild が使用されていました)
101+
- CommonJS のサポートは Rolldown によって処理されます(以前は @rollup/plugin-commonjs が使用されていました)
102+
- 構文の低レベル変換に Oxc が使用されます(以前は esbuild が使用されていました)
103+
- CSS の圧縮にはデフォルトで Lightning CSS が使用されます(以前は esbuild が使用されていました)
104+
- JS の圧縮にはデフォルトで Oxc minifier が使用されます(以前は esbuild が使用されていました)
105+
- 設定のバンドルに Rolldown が使用されます(以前は esbuild が使用されていました)
106+
107+
### rolldown-vite の検出方法
108+
109+
以下のいずれかの方法で検出できます:
110+
111+
- `this.meta.rolldownVersion` の存在を確認する
112+
113+
```js
114+
const plugin = {
115+
resolveId() {
116+
if (this.meta.rolldownVersion) {
117+
// rolldown-vite 向けのロジック
118+
} else {
119+
// rollup-vite 向けのロジック
120+
}
121+
},
122+
}
123+
```
124+
125+
- `rolldownversion` エクスポートの存在を確認します
126+
127+
```js
128+
import * as vite from 'vite'
129+
130+
if (vite.rolldownVersion) {
131+
// rolldown-vite 向けのロジック
132+
} else {
133+
// rollup-vite 向けのロジック
134+
}
135+
```
136+
137+
依存関係(peer dependency ではない)として `vite` がある場合、`rolldownVersion` エクスポートは、コードのどこからでも使用できるため有用です。
138+
139+
### Rolldown のオプション検証を無視するには
140+
141+
Rolldown は、不明または無効なオプションが渡されるとエラーをスローします。Rollup で利用可能ないくつかのオプションは Rolldown でサポートされていないため、エラーに遭遇する可能性があります。以下に、このようなエラーメッセージの例を見つけることができます:
142+
143+
> Error: Failed validate input options.
144+
>
145+
> - For the "preserveEntrySignatures". Invalid key: Expected never but received "preserveEntrySignatures".
146+
147+
これは、上記のように `rolldown-vite` で実行されているかどうかを確認することでオプションを条件的に渡すことで修正できます。
148+
149+
今のところこのエラーを抑制したい場合は、 `rolldown_options_validation = loose` 環境変数を設定できます。ただし、最終的には Rolldown でサポートされていないオプションを渡すのをやめる必要があることに留意してください。
150+
151+
### `transformwithesbuild``esbuild` を個別にインストールする必要があります
152+
153+
`esbuild` の代わりに Oxc を使用する `transformWithOxc` と呼ばれる同様の関数は、`rolldown-vite` からエクスポートされます。
154+
155+
### `esbuild` オプションの互換性レイヤー
156+
157+
Rolldown-Vite には、`esbuild` のオプションをそれぞれの Oxc または `rolldown` のオプションに変換する互換性レイヤーがあります。[Ecosystem-Ci](https://github.com/vitejs/vite-ecosystem-ci/blob/rolldown-vite/README-temp.md)でテストされているように、これは多くの場合、単純な `esbuild` プラグインを含めて動作します。
158+
とはいえ、**将来的には `esbuild` オプションのサポートを削除する予定**なので、対応する Oxc または `rolldown` オプションを試すことをお勧めします。
159+
`configResolved` フックから互換性レイヤーによって設定されたオプションを取得できます。
160+
161+
```js
162+
const plugin = {
163+
name: 'log-config',
164+
configResolved(config) {
165+
console.log('options', config.optimizeDeps, config.oxc)
166+
},
167+
},
168+
```
169+
170+
### フックフィルター機能
171+
172+
Rolldown は[フックフィルター機能](https://rolldown.rs/guide/plugin-development#plugin-hook-filters)を導入して、Rust と JavaScript のランタイムの間の通信を縮小しました。この機能を使用することで、プラグインのパフォーマンスを向上させることができます。
173+
これは、Rollup 4.38.0+ および Vite 6.3.0+ によってサポートされています。プラグインを古いバージョンとの後方互換性を持たせるには、フックハンドラー内でフィルターを実行してください。
174+
175+
### `load` または `transform` フックでコンテンツを JavaScript に変換する
176+
177+
`load` または `Transform` フックでコンテンツを他のタイプから JavaScript に変換する場合、`moduleType: 'js'` を返された値に追加する必要がある場合があります。
178+
179+
```js
180+
const plugin = {
181+
name: 'txt-loader',
182+
load(id) {
183+
if (id.endsWith('.txt')) {
184+
const content = fs.readFile(id, 'utf-8')
185+
return {
186+
code: `export default ${JSON.stringify(content)}`,
187+
moduleType: 'js', // [!code ++]
188+
}
189+
}
190+
},
191+
}
192+
```
193+
194+
これは、[Rolldown は JavaScript 以外のモジュールもサポート](https://rolldown.rs/guide/in-depth/module-types)しており、指定がない限り拡張子からモジュールタイプを拡張するためです。`rolldown-vite` は開発時にはモジュールタイプをサポートしていないことに注意してください。

0 commit comments

Comments
 (0)