rslib-best-practices

Rslib のベストプラクティス

Rslib のライブラリプロジェクトを作成またはレビューする際は、以下のルールに従ってください。

設定

• rslib.config.ts と defineConfig を使用します
• まず Rslib 固有の設定（例：lib.*）を確認し、必要に応じて Rsbuild の設定（例：source.*、output.*、tools.*）も活用します
• より詳細な設定や高度な設定が必要な場合は、tools.rspack または tools.bundlerChain を使用して、Rspack のネイティブ設定にアクセスします
• TypeScript プロジェクトでは、tsconfig.json のパスエイリアスを優先します

CLI

• ビルドには rslib を使用します
• ローカル開発でウォッチモードでビルドするには、rslib --watch を使用します
• 最終的な Rslib／Rsbuild／Rspack 設定を確認するには、rslib inspect を使用します

出力

• package.json で "type": "module" を指定し、純粋な ESM パッケージをビルドすることを優先します
• コンポーネントライブラリをビルドする場合は、output.target を 'web' に設定したバンドルレスモードを優先します
• Node.js ユーティリティライブラリをビルドする場合は、バンドルモードを優先します
• package.json の exports フィールドが正しく設定され、各フォーマット（ESM、CJS など）の実際の JavaScript 出力および宣言ファイルの出力と一致していることを確認します

宣言ファイル

• lib.dts: true または詳細な設定を使用して、宣言ファイルの生成を有効にすることを優先します
• 型生成を高速化するには、@typescript/native-preview をインストールしたうえで、実験的機能 lib.dts.tsgo を有効にします

依存関係

• バンドルモードでは、バンドル対象の依存関係は devDependencies に配置することを優先します。dependencies と peerDependencies の依存関係は、デフォルトで自動的に外部化（バンドルされない）されます
• ビルド出力と package.json の依存関係指定を慎重に確認し、利用者がこのパッケージをインストールして使用する際に、依存関係の不足によるエラーが発生しないようにします

ビルドの最適化

• より優れた最適化を可能にするため、lib.syntax の構文ターゲットを実際の互換性要件に合わせます
• 異なる出力フォーマットとの互換性を高めるため、ソースコードでフォーマット固有の API を使用しないようにします
• バンドルサイズを削減するため、軽量な依存関係を優先します

ツールチェーンとの統合

• テストを作成する際は、@rstest/adapter-rslib とともに Rstest を使用することを優先します
• ライブラリのドキュメントを作成する際は Rspress を使用し、コンポーネントのプレビューと API ドキュメントには @rspress/plugin-preview と @rspress/plugin-api-docgen を使用することを優先します

デバッグ

• 設定解決やプラグインの動作を調査する際は、DEBUG=rsbuild を設定して実行します
• 想定上の設定ではなく、最終的な Rsbuild／Rspack 設定を確認するため、生成された dist/.rsbuild 内のファイルを読みます

ドキュメント

• 最新の Rslib ドキュメントについては、https://rslib.rs/llms.txt を参照してください