他の導入ガイド(全7件)
build-tool / 導入ガイド
rolldown-plugin-remove-export
rolldown (または rollup) のビルド成果物から名前付きエクスポートを置換削除
npm install -D rolldown-plugin-remove-exportこのページの内容
rolldown-plugin-remove-export は、Rolldown(または互換性のあるバンドラ)のビルド出力チャンクから末尾の export 文を自動削除するプラグインです。バンドル後のコードに export { ... }; が残ることで構文エラーが発生する Google Apps Script (GAS) などの実行環境向けに、クリーンなスクリプト出力を提供します。
概要と特徴
Google Apps Script の V8 ランタイムなど、ES Modules の export 構文を直接解釈できない環境にバンドル済みコードをデプロイする場合、バンドラが出力する末尾の export { ... }; 宣言を除去する必要があります。本プラグインはビルドの最終段階で該当構文のみをピンポイントに削除し、グローバルスコープの関数宣言を維持します。
generateBundleフックによる自動除去: Rolldown のバンドル生成時に指定された出力チャンクのみを対象としてコードを変換します。//#endregion直後のエクスポート文をピンポイント削除: Rolldown が出力する//#endregionコメント自体は残したまま、直後の末尾export { ... };行のみを正確に削除します。- デュアルパッケージ・型定義同梱: ES Modules(
.mjs)および CommonJS(.cjs)の双方に対応し、TypeScript の型定義ファイル(.d.ts)を標準で同梱しています。
動作要件
- Node.js: ESM / CommonJS 対応の Node.js 実行環境
- バンドラ:
rolldown(またはgenerateBundleフックと Rolldown 形式のリージョンコメント出力を持つビルド環境)
インストール
パッケージマネージャーを使用して開発依存関係(devDependencies)にインストールします。
# pnpm
pnpm add -D rolldown-plugin-remove-export
# npm
npm install -D rolldown-plugin-remove-export
# yarn
yarn add -D rolldown-plugin-remove-export
クイックスタート
1. エントリーポイントの作成
GAS などの環境でグローバルに公開したい関数を名前付きエクスポート(export function)として記述します。
export function myFunction() {
console.log('Hello, world!');
}
2. Rolldown の設定
rolldown.config.ts(または rolldown.config.js)の plugins 配列に removeExportPlugin を追加し、出力チャンクのファイル名(例:out.js)を指定します。
import { defineConfig } from 'rolldown';
import { removeExportPlugin } from 'rolldown-plugin-remove-export';
export default defineConfig({
input: 'src/index.ts',
output: {
file: 'dist/out.js',
},
plugins: [removeExportPlugin('out.js')],
});
3. ビルドの実行
Rolldown でビルドを実行すると、dist/out.js から末尾の export { myFunction }; が除去された状態で出力されます。
pnpm exec rolldown -c
API リファレンス
removeExportPlugin(outputFileName)
指定されたバンドルチャンクから末尾のエクスポート宣言を削除する Rolldown プラグインインスタンスを生成します。
function removeExportPlugin(outputFileName: string): RolldownPlugin;
| プロパティ / 引数 | 型 | デフォルト | 説明 |
|---|---|---|---|
outputFileName |
string |
- | outputBundle 内で処理対象とする出力チャンクのファイル名(キー名)。output.file に 'dist/out.js' を指定している場合は 'out.js' を渡します。 |
- 戻り値:
RolldownPlugin(プラグイン名name:'remove-export'、実装フック:generateBundle)
アーキテクチャと動作仕様
置換パターンと出力の変化
本プラグインは generateBundle フックにおいて、対象チャンクの code プロパティに対して以下の正規表現による置換を実行します。
chunk.code = `${chunk.code.replace(/\n\/\/#endregion\nexport \{ .+ \};$/m, '\n//#endregion')}`;
- 直前に
\n//#endregion\nが存在し、行末がexport { .+ };で終わるパターンにマッチします。 //#endregionコメント自体は削除されず保持されます。
プラグイン適用前(Rolldown の標準出力):
//#region src/index.ts
function myFunction() {
console.log('Hello, world!');
}
//#endregion
export { myFunction };
プラグイン適用後:
//#region src/index.ts
function myFunction() {
console.log('Hello, world!');
}
//#endregion
制限事項と注意点
- チャンク名の指定方法(対象チャンクが存在しない場合): 引数
outputFileNameで指定されたキーがoutputBundle内に存在しない場合、コードの変換処理はスキップされ、標準エラー出力にchunk not found: <outputFileName>が出力されます。出力先のディレクトリを含むパス('dist/out.js'など)ではなく、バンドルチャンクとしてのファイル名('out.js'など)を指定してください。 - 名前付きエクスポートの使用: GAS 環境等でグローバル関数名を残すため、エントリーポイントでは
export defaultではなく名前付きエクスポート(export function ...またはexport { ... })を使用してください。
ライセンス
MIT License