Skip to content

feat: use module runner to import the config #1819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 26, 2025
Merged

feat: use module runner to import the config #1819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions config/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ export default {
vite --config my-config.js
```

::: tip 設定のビルド
デフォルトでは、Vite は `esbuild` を使用して設定を一時ファイルにバンドルします。これはモノレポ内の TypeScript をインポートする際に問題を引き起こすことがあります。このアプローチで問題が起きた場合は、`--configLoader=runner` を指定すると、代わりにモジュールランナーを利用できます。これにより、一時的な設定が作成されなくなり、すべてのファイルがその場で変換されるようになります。モジュールランナーは設定ファイル内では CJS をサポートしていませんが、外部の CJS パッケージは通常通りに機能するはずです。
:::

## 設定の自動補完

Vite には TypeScript の型が同梱されているので、jsdoc のタイプヒントを使って IDE の自動補完を活用できます:
Expand Down
37 changes: 19 additions & 18 deletions guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,25 @@ vite [root]

#### オプション

| オプション | |
| ------------------------ | ----------------------------------------------------------------- |
| `--host [host]` | ホスト名を指定する（`string`） |
| `--port <port>` | ポートを指定する（`number`） |
| `--open [path]` | 起動時にブラウザーを起動する（`boolean \| string`） |
| `--cors` | CORS を有効化する（`boolean`） |
| `--strictPort` | 指定されたポートが既に使用されている場合は終了する（`boolean`） |
| `--force` | オプティマイザーにキャッシュを無視して再バンドルさせる（`boolean`）|
| `-c, --config <file>` | 指定された設定ファイルを使用する（`string`） |
| `--base <path>` | public のベースパス（デフォルト: `/`）（`string`） |
| `-l, --logLevel <level>` | info \| warn \| error \| silent （`string`） |
| `--clearScreen` | ログを表示する際に画面をクリアするかどうか（`boolean`） |
| `--profile` | 組み込みの Node.js インスペクターを起動する（[パフォーマンスのボトルネック](/guide/troubleshooting#performance-bottlenecks)を確認してください）|
| `-d, --debug [feat]` | デバッグログを表示する（`string \| boolean`） |
| `-f, --filter <filter>` | デバッグログをフィルタリングする（`string`） |
| `-m, --mode <mode>` | env モードを設定する（`string`） |
| `-h, --help` | 利用可能な CLI オプションを表示する |
| `-v, --version` | バージョン番号を表示する |
| オプション | |
|---------------------------|-------------------------------------------------------------------------------------------------------|
| `--host [host]` | ホスト名を指定する（`string`） |
| `--port <port>` | ポートを指定する（`number`） |
| `--open [path]` | 起動時にブラウザーを起動する（`boolean \| string`） |
| `--cors` | CORS を有効化する（`boolean`） |
| `--strictPort` | 指定されたポートが既に使用されている場合は終了する（`boolean`） |
| `--force` | オプティマイザーにキャッシュを無視して再バンドルさせる（`boolean`） |
| `-c, --config <file>` | 指定された設定ファイルを使用する（`string`） |
| `--base <path>` | public のベースパス（デフォルト: `/`）（`string`） |
| `-l, --logLevel <level>` | info \| warn \| error \| silent （`string`） |
| `--clearScreen` | ログを表示する際に画面をクリアするかどうか（`boolean`） |
| `--configLoader <loader>` | `bundle`: esbuild を使用して設定をバンドルする。`runner` (実験的機能): その場で処理する (デフォルト: `bundle`) |
Copy link
Contributor Author

@shuuji3 shuuji3 Jan 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

テーブルの変更は、この行を追加して自動フォーマットしただけです。他の行の内容自体には変更はないです。

| `--profile` | 組み込みの Node.js インスペクターを起動する（[パフォーマンスのボトルネック](/guide/troubleshooting#performance-bottlenecks)を確認してください） |
| `-d, --debug [feat]` | デバッグログを表示する（`string \| boolean`） |
| `-f, --filter <filter>` | デバッグログをフィルタリングする（`string`） |
| `-m, --mode <mode>` | env モードを設定する（`string`） |
| `-h, --help` | 利用可能な CLI オプションを表示する |
| `-v, --version` | バージョン番号を表示する |

## ビルド

Expand Down
Loading