Rslib ベストプラクティス

Rslib ライブラリプロジェクトを書く、またはレビューする際にこれらのルールを適用してください。

Configuration

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

CLI

• rslib を使用してビルドする
• ローカル開発のため rslib --watch を使用してウォッチモードでビルドする
• rslib inspect を使用して最終的な Rslib/Rsbuild/Rspack 設定を確認する

Output

• package.json に "type": "module" を設定した純粋な ESM パッケージのビルドを優先する
• コンポーネントライブラリをビルドする際、output.target を 'web' に設定してバンドルレスモードを使用することを優先する
• Node.js ユーティリティライブラリをビルドする際、バンドルモードを使用することを優先する
• package.json の exports フィールドが正しく設定されており、異なるフォーマット (ESM、CJS など) の実際の JavaScript 出力と型定義ファイル出力と一致していることを確認する

Declaration files

• lib.dts: true または詳細な設定で型定義ファイルの生成を有効にすることを優先する
• より高速な型生成のため、@typescript/native-preview がインストールされている場合に lib.dts.tsgo 実験的機能を有効にする

Dependencies

• バンドルモードでは、バンドルする依存関係を devDependencies に配置し、dependencies と peerDependencies の依存関係はデフォルトで自動的に外部化 (バンドルされない) することを優先する
• ビルド出力と package.json の依存関係指定子を慎重に検証して、ユーザーがこのパッケージをインストールして使用する際に依存関係エラーが発生しないようにする

Build optimization

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

Toolchain integration

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

Debugging

• 設定解決またはプラグインの動作を診断する際、DEBUG=rsbuild で実行する
• 想定設定ではなく、最終的な Rsbuild/Rspack 設定を確認するため dist/.rsbuild に生成されたファイルを読む

Documentation

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