Skip to content

Commit 6e51f74

Browse files
committed
docs: remove horizontal scrollbars in code blocks
1 parent 8a80b10 commit 6e51f74

File tree

6 files changed

+57
-31
lines changed

6 files changed

+57
-31
lines changed

config/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,9 @@ Vite はデフォルトでは `.env` ファイルをロードしないことに
104104
import { defineConfig, loadEnv } from 'vite'
105105

106106
export default defineConfig(({ command, mode }) => {
107-
// `mode` に基づいて現在の作業ディレクトリーにある env ファイルをロードする
108-
// `VITE_` プレフィックスに関係なく全ての環境変数をロードするには、第 3 引数に '' を設定します
107+
// `mode` に基づいて現在の作業ディレクトリーにある env ファイルをロードする。
108+
// `VITE_` プレフィックスに関係なく全ての環境変数をロードするには、
109+
// 第 3 引数に '' を設定します
109110
const env = loadEnv(mode, process.cwd(), '')
110111
return {
111112
// vite の設定

config/server-options.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,21 @@ export default defineConfig({
101101
export default defineConfig({
102102
server: {
103103
proxy: {
104-
// 文字列のショートハンド: http://localhost:5173/foo -> http://localhost:4567/foo
104+
// 文字列のショートハンド:
105+
// http://localhost:5173/foo
106+
// -> http://localhost:4567/foo
105107
'/foo': 'http://localhost:4567',
106-
// オプションを使用: http://localhost:5173/api/bar-> http://jsonplaceholder.typicode.com/bar
108+
// オプションを使用:
109+
// http://localhost:5173/api/bar
110+
// -> http://jsonplaceholder.typicode.com/bar
107111
'/api': {
108112
target: 'http://jsonplaceholder.typicode.com',
109113
changeOrigin: true,
110114
rewrite: (path) => path.replace(/^\/api/, ''),
111115
},
112-
// 正規表現を使用: http://localhost:5173/fallback/ -> http://jsonplaceholder.typicode.com/
116+
// 正規表現を使用:
117+
// http://localhost:5173/fallback/
118+
// -> http://jsonplaceholder.typicode.com/
113119
'^/fallback/.*': {
114120
target: 'http://jsonplaceholder.typicode.com',
115121
changeOrigin: true,
@@ -123,8 +129,11 @@ export default defineConfig({
123129
// プロキシは 'http-proxy' のインスタンスになります
124130
},
125131
},
126-
// Web ソケット か socket.io をプロキシ化: ws://localhost:5173/socket.io -> ws://localhost:5174/socket.io
127-
// `rewriteWsOrigin` を使用すると、プロキシが CSRF 攻撃に無防備なままになる可能性があるため、使用には注意してください。
132+
// Web ソケット か socket.io をプロキシ化:
133+
// ws://localhost:5173/socket.io
134+
// -> ws://localhost:5174/socket.io
135+
// `rewriteWsOrigin` を使用すると、プロキシが CSRF 攻撃に無防備になる
136+
// 可能性があるため、使用には注意してください。
128137
'/socket.io': {
129138
target: 'ws://localhost:5174',
130139
ws: true,
@@ -251,16 +260,17 @@ async function createServer() {
251260
// ミドルウェアモードで Vite サーバーを作成
252261
const vite = await createViteServer({
253262
server: { middlewareMode: true },
254-
appType: 'custom', // ViteのデフォルトのHTMLを処理するミドルウェアを含めない
263+
// Viteのデフォルトの HTML を処理するミドルウェアを含めない
264+
appType: 'custom',
255265
})
256266
// vite の接続インスタンスをミドルウェアとして使用
257267
app.use(vite.middlewares)
258268

259269
app.use('*', async (req, res) => {
260270
// `appType` が `'custom'` なので、ここでレスポンスを返すべきです。
261-
// 注: `appType` が `'spa'` または `'mpa'` の際は、Vite に HTML リクエスト と 404 になる
262-
// リクエストを処理するミドルウェアが含まれます。したがって、ユーザーのミドルウェアが
263-
// 動作するためにはViteのミドルウェアよりも前に追加されるべきです
271+
// 注: `appType` が `'spa'` または `'mpa'` の際は、Vite に HTML リクエスト と
272+
// 404 を処理するミドルウェアが含まれるため、ユーザーのミドルウェアが
273+
// 動作するためには Vite のミドルウェアよりも前に追加されるべきです
264274
})
265275
}
266276

guide/api-environment-frameworks.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ export class RunnableDevEnvironment extends DevEnvironment {
2222

2323
class ModuleRunner {
2424
/**
25-
* 実行するURL。ルートからの相対的なファイルパス、サーバーパス、ID を受け付けます。
25+
* 実行するURL。
26+
* ルートからの相対的なファイルパス、サーバーパス、ID を受け付けます。
2627
* インスタンス化されたモジュールを返します (ssrLoadModule と同じ)
2728
*/
2829
public async import(url: string): Promise<Record<string, any>>
@@ -52,20 +53,21 @@ const server = await createServer({
5253
appType: 'custom',
5354
environments: {
5455
server: {
55-
// デフォルトでは、開発中はモジュールは vite 開発サーバーと同じプロセスで実行されます
56+
// デフォルトでは、モジュールは vite サーバーと同じプロセスで実行されます
5657
},
5758
},
5859
})
5960

60-
// TypeScript では、これを RunnableDevEnvironment にキャストするか、ランナーへのアクセスを
61-
// 保護するために "isRunnableDevEnvironment" 関数を使用する必要があるかもしれません
61+
// TypeScript でこれを RunnableDevEnvironment にキャストするか、ランナーへのアクセスを
62+
// 保護するために isRunnableDevEnvironment を使用する必要があるかもしれません
6263
const environment = server.environments.node
6364

6465
app.use('*', async (req, res, next) => {
6566
const url = req.originalUrl
6667

6768
// 1. index.html を読み込む
68-
let template = fs.readFileSync(path.resolve(__dirname, 'index.html'), 'utf-8')
69+
const indexHtmlPath = path.resolve(__dirname, 'index.html')
70+
let template = fs.readFileSync(indexHtmlPath, 'utf-8')
6971

7072
// 2. Vite HTML 変換を適用します。これにより、Vite HMR クライアントが挿入され、
7173
// Vite プラグインからの HTML 変換も適用されます。
@@ -112,7 +114,7 @@ const server = createServer()
112114
const ssrEnvironment = server.environment.ssr
113115
const input = {}
114116

115-
const { createHandler } = await ssrEnvironment.runner.import('./entrypoint.js')
117+
const { createHandler } = await ssrEnvironment.runner.import('./entry.js')
116118
const handler = createHandler(input)
117119
const response = handler(new Request('/'))
118120

@@ -186,10 +188,10 @@ function vitePluginVirtualIndexHtml(): Plugin {
186188
let html: string
187189
if (server) {
188190
this.addWatchFile('index.html')
189-
html = await fs.promises.readFile('index.html', 'utf-8')
191+
html = fs.readFileSync('index.html', 'utf-8')
190192
html = await server.transformIndexHtml('/', html)
191193
} else {
192-
html = await fs.promises.readFile('dist/client/index.html', 'utf-8')
194+
html = fs.readFileSync('dist/client/index.html', 'utf-8')
193195
}
194196
return `export default ${JSON.stringify(html)}`
195197
}

guide/api-environment-plugins.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,15 @@ const UnoCssPlugin = () => {
135135
// 共有グローバル状態
136136
return {
137137
buildStart() {
138-
// WeakMap<Environment,Data>, this.environment を使って環境ごとの状態を初期化
138+
// WeakMap<Environment,Data>, this.environment を使って
139+
// 環境ごとの状態を初期化
139140
},
140141
configureServer() {
141142
// グローバルフックを通常どおり使用
142143
},
143144
applyToEnvironment(environment) {
144145
// このプラグインがこの環境でアクティブになる必要がある場合は true を返します
145-
// この関数が提供されていない場合、プラグインはすべての環境でアクティブになります
146+
// フックが使用されていない場合、プラグインはすべての環境でアクティブになります
146147
},
147148
resolveId(id, importer) {
148149
// このプラグインが適用される環境に対してのみ呼び出されます

guide/api-environment-runtimes.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,11 @@ Vite モジュールランナーは、最初に Vite プラグインで処理す
8484
```ts
8585
import { DevEnvironment, RemoteEnvironmentTransport } from 'vite'
8686

87-
function createWorkerdDevEnvironment(name: string, config: ResolvedConfig, context: DevEnvironmentContext) {
87+
function createWorkerdDevEnvironment(
88+
name: string,
89+
config: ResolvedConfig,
90+
context: DevEnvironmentContext
91+
) {
8892
const hot = /* ... */
8993
const connection = /* ... */
9094
const transport = new RemoteEnvironmentTransport({
@@ -120,20 +124,21 @@ export class ModuleRunner {
120124
private debug?: ModuleRunnerDebugger,
121125
) {}
122126
/**
123-
* 実行するURL。ルートからの相対的なファイルパス、サーバーパス、ID を受け付けます。
127+
* 実行するURL。
128+
* ルートからの相対的なファイルパス、サーバーパス、ID を受け付けます。
124129
*/
125130
public async import<T = any>(url: string): Promise<T>
126131
/**
127132
* HMR リスナーを含むすべてのキャッシュをクリアします。
128133
*/
129134
public clearCache(): void
130135
/**
131-
* すべてのキャッシュをクリアし、すべての HMR リスナーを削除し、ソースマップのサポートをリセットします
136+
* 全キャッシュをクリア、全 HMR リスナーを削除、ソースマップサポートをリセットします
132137
* このメソッドは HMR 接続を停止しません。
133138
*/
134139
public async close(): Promise<void>
135140
/**
136-
* `close()` メソッドを呼び出してランナーを終了した場合は `true` を返します。
141+
* `close()` を呼び出してランナーを終了した場合は `true` を返します。
137142
*/
138143
public isClosed(): boolean
139144
}
@@ -174,9 +179,12 @@ export interface ModuleRunnerOptions {
174179
*/
175180
transport: RunnerTransport
176181
/**
177-
* ソースマップの解決方法を設定します。`process.setSourceMapsEnabled` が使用可能な場合は `node` を優先します。
178-
* それ以外の場合は、デフォルトで `prepareStackTrace` を使用し、`Error.prepareStackTrace` メソッドをオーバーライドします。
179-
* Vite によって処理されなかったファイルのファイル内容とソースマップの解決方法を設定するオブジェクトを提供できます。
182+
* ソースマップの解決方法を設定します。
183+
* `process.setSourceMapsEnabled` が使用可能な場合は `node` を優先します。
184+
* それ以外の場合は、デフォルトで `prepareStackTrace` を使用し、
185+
* `Error.prepareStackTrace` メソッドをオーバーライドします。
186+
* Vite によって処理されなかったファイルのファイル内容とソースマップの解決方法を設定する
187+
* オブジェクトを提供できます。
180188
*/
181189
sourcemapInterceptor?:
182190
| false
@@ -199,7 +207,8 @@ export interface ModuleRunnerOptions {
199207
logger?: false | HMRLogger
200208
}
201209
/**
202-
* カスタムモジュールキャッシュ。指定されていない場合は、モジュールランナーインスタンスごとに個別のモジュールキャッシュが作成されます。
210+
* カスタムモジュールキャッシュ。指定されていない場合は、モジュールランナーの
211+
* インスタンスごとに個別のモジュールキャッシュが作成されます。
203212
*/
204213
evaluatedModules?: EvaluatedModules
205214
}
@@ -344,7 +353,8 @@ export interface ModuleRunnerHMRConnection {
344353
send(payload: HotPayload): void
345354
/**
346355
* この接続が更新をトリガーしたときに HMR がどのように処理されるかを設定します。
347-
* このメソッドは、接続が HMR 更新のリッスンを開始し、受信時にこのコールバックを呼び出すことを想定しています。
356+
* このメソッドは、接続が HMR 更新のリッスンを開始し、受信時にこのコールバックを
357+
* 呼び出すことを想定しています。
348358
*/
349359
onUpdate(callback: (payload: HotPayload) => void): void
350360
}

guide/build.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,9 @@ experimental: {
337337
if (type === 'public') {
338338
return 'https://www.domain.com/' + filename
339339
} else if (path.extname(hostId) === '.js') {
340-
return { runtime: `window.__assetsPath(${JSON.stringify(filename)})` }
340+
return {
341+
runtime: `window.__assetsPath(${JSON.stringify(filename)})`
342+
}
341343
} else {
342344
return 'https://cdn.domain.com/assets/' + filename
343345
}

0 commit comments

Comments
 (0)