vite-laravel-plugin.ts
21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
import fs from 'fs'
import {AddressInfo} from 'net'
import os from 'os'
import {fileURLToPath} from 'url'
import path from 'path'
import colors from 'picocolors'
import {ConfigEnv, loadEnv, Plugin, PluginOption, ResolvedConfig, SSROptions, UserConfig} from 'vite'
import fullReload, {Config as FullReloadConfig} from 'vite-plugin-full-reload'
interface PluginConfig {
/**
* The path or paths of the entry points to compile.
*/
input: string | string[]
/**
* Laravel's public directory.
*
* @default 'public'
*/
publicDirectory?: string
/**
* The public subdirectory where compiled assets should be written.
*
* @default 'build'
*/
buildDirectory?: string
/**
* The path to the "hot" file.
*
* @default `${publicDirectory}/hot`
*/
hotFile?: string
/**
* The path of the SSR entry point.
*/
ssr?: string | string[]
/**
* The directory where the SSR bundle should be written.
*
* @default 'bootstrap/ssr'
*/
ssrOutputDirectory?: string
/**
* Configuration for performing full page refresh on blade (or other) file changes.
*
* {@link https://github.com/ElMassimo/vite-plugin-full-reload}
* @default false
*/
refresh?: boolean | string | string[] | RefreshConfig | RefreshConfig[]
/**
* Utilise the Herd or Valet TLS certificates.
*
* @default null
*/
detectTls?: string | boolean | null,
/**
* Utilise the Herd or Valet TLS certificates.
*
* @default null
* @deprecated use "detectTls" instead
*/
valetTls?: string | boolean | null,
/**
* Transform the code while serving.
*/
transformOnServe?: (code: string, url: DevServerUrl) => string,
}
interface RefreshConfig {
paths: string[],
config?: FullReloadConfig,
}
interface LaravelPlugin extends Plugin {
config: (config: UserConfig & { assetUrl?: string }, env: ConfigEnv) => UserConfig
}
type DevServerUrl = `${'http' | 'https'}://${string}:${number}`
let exitHandlersBound = false
export const refreshPaths = [
'app/Livewire/**',
'app/View/Components/**',
'lang/**',
'resources/lang/**',
'resources/views/**',
'routes/**',
]
/**
* Laravel plugin for Vite.
*
* @param config - A config object or relative path(s) of the scripts to be compiled.
*/
export default function laravel(config: string | string[] | PluginConfig): [LaravelPlugin, ...Plugin[]] {
const pluginConfig = resolvePluginConfig(config)
return [
resolveLaravelPlugin(pluginConfig),
...resolveFullReloadConfig(pluginConfig) as Plugin[],
];
}
/**
* Resolve the Laravel Plugin configuration.
*/
function resolveLaravelPlugin(pluginConfig: Required<PluginConfig>): LaravelPlugin {
let viteDevServerUrl: DevServerUrl
let resolvedConfig: ResolvedConfig
let userConfig: UserConfig
const defaultAliases: Record<string, string> = {
'@': '/resources/js',
};
return {
name: 'laravel',
enforce: 'post',
config: (config: any, {command, mode}) => {
userConfig = config
const ssr = !!userConfig.build?.ssr
const env = loadEnv(mode, userConfig.envDir || process.cwd(), '')
const assetUrl = env.VITE_ASSET_URL ?? config.assetUrl ?? ''
const serverConfig = command === 'serve'
? (resolveDevelopmentEnvironmentServerConfig(pluginConfig.detectTls) ?? resolveEnvironmentServerConfig(env))
: undefined
ensureCommandShouldRunInEnvironment(command, env)
return {
base: userConfig.base ?? (command === 'build' ? resolveBase(pluginConfig, assetUrl) : ''),
publicDir: userConfig.publicDir ?? false,
build: {
manifest: userConfig.build?.manifest ?? (ssr ? false : 'manifest.json'),
ssrManifest: userConfig.build?.ssrManifest ?? (ssr ? 'ssr-manifest.json' : false),
outDir: userConfig.build?.outDir ?? resolveOutDir(pluginConfig, ssr),
rollupOptions: {
input: userConfig.build?.rollupOptions?.input ?? resolveInput(pluginConfig, ssr)
},
assetsInlineLimit: userConfig.build?.assetsInlineLimit ?? 0,
},
server: {
origin: userConfig.server?.origin ?? '__laravel_vite_placeholder__',
...(process.env.LARAVEL_SAIL ? {
host: userConfig.server?.host ?? '0.0.0.0',
port: userConfig.server?.port ?? (env.VITE_PORT ? parseInt(env.VITE_PORT) : 5173),
strictPort: userConfig.server?.strictPort ?? true,
} : undefined),
...(serverConfig ? {
host: userConfig.server?.host ?? serverConfig.host,
hmr: userConfig.server?.hmr === false ? false : {
...serverConfig.hmr,
...(userConfig.server?.hmr === true ? {} : userConfig.server?.hmr),
},
https: userConfig.server?.https ?? serverConfig.https,
} : undefined),
},
resolve: {
alias: Array.isArray(userConfig.resolve?.alias)
? [
...userConfig.resolve?.alias ?? [],
...Object.keys(defaultAliases).map(alias => ({
find: alias,
replacement: defaultAliases[alias]
}))
]
: {
...defaultAliases,
...userConfig.resolve?.alias,
}
},
ssr: {
noExternal: noExternalInertiaHelpers(userConfig),
},
}
},
configResolved(config) {
resolvedConfig = config
},
transform(code) {
if (resolvedConfig.command === 'serve') {
code = code.replace(/__laravel_vite_placeholder__/g, viteDevServerUrl)
return pluginConfig.transformOnServe(code, viteDevServerUrl)
}
},
configureServer(server) {
const envDir = resolvedConfig.envDir || process.cwd()
const appUrl = loadEnv(resolvedConfig.mode, envDir, 'APP_URL').APP_URL ?? 'undefined'
server.httpServer?.once('listening', () => {
const address = server.httpServer?.address()
const isAddressInfo = (x: string | AddressInfo | null | undefined): x is AddressInfo => typeof x === 'object'
if (isAddressInfo(address)) {
viteDevServerUrl = userConfig.server?.origin ? userConfig.server.origin as DevServerUrl : resolveDevServerUrl(address, server.config, userConfig)
fs.writeFileSync(pluginConfig.hotFile, viteDevServerUrl)
setTimeout(() => {
server.config.logger.info(`\n ${colors.red(`${colors.bold('LARAVEL')} ${laravelVersion()}`)} ${colors.dim('plugin')} ${colors.bold(`v${pluginVersion()}`)}`)
server.config.logger.info('')
server.config.logger.info(` ${colors.green('➜')} ${colors.bold('APP_URL')}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
if (typeof resolvedConfig.server.https === 'object' && typeof resolvedConfig.server.https.key === 'string') {
if (resolvedConfig.server.https.key.startsWith(herdConfigPath())) {
server.config.logger.info(` ${colors.green('➜')} Using Herd certificate to secure Vite.`)
}
if (resolvedConfig.server.https.key.startsWith(valetConfigPath())) {
server.config.logger.info(` ${colors.green('➜')} Using Valet certificate to secure Vite.`)
}
}
}, 100)
}
})
if (!exitHandlersBound) {
const clean = () => {
if (fs.existsSync(pluginConfig.hotFile)) {
fs.rmSync(pluginConfig.hotFile)
}
}
process.on('exit', clean)
process.on('SIGINT', () => process.exit())
process.on('SIGTERM', () => process.exit())
process.on('SIGHUP', () => process.exit())
exitHandlersBound = true
}
return () => server.middlewares.use((req, res, next) => {
if (req.url === '/index.html') {
res.statusCode = 404
res.end(
fs.readFileSync(path.join(dirname(), 'dev-server-index.html')).toString().replace(/{{ APP_URL }}/g, appUrl)
)
}
next()
})
}
}
}
/**
* Validate the command can run in the given environment.
*/
function ensureCommandShouldRunInEnvironment(command: 'build' | 'serve', env: Record<string, string>): void {
if (command === 'build' || env.LARAVEL_BYPASS_ENV_CHECK === '1') {
return;
}
if (typeof env.LARAVEL_VAPOR !== 'undefined') {
throw Error('You should not run the Vite HMR server on Vapor. You should build your assets for production instead. To disable this ENV check you may set LARAVEL_BYPASS_ENV_CHECK=1');
}
if (typeof env.LARAVEL_FORGE !== 'undefined') {
throw Error('You should not run the Vite HMR server in your Forge deployment script. You should build your assets for production instead. To disable this ENV check you may set LARAVEL_BYPASS_ENV_CHECK=1');
}
if (typeof env.LARAVEL_ENVOYER !== 'undefined') {
throw Error('You should not run the Vite HMR server in your Envoyer hook. You should build your assets for production instead. To disable this ENV check you may set LARAVEL_BYPASS_ENV_CHECK=1')
}
if (typeof env.CI !== 'undefined') {
throw Error('You should not run the Vite HMR server in CI environments. You should build your assets for production instead. To disable this ENV check you may set LARAVEL_BYPASS_ENV_CHECK=1')
}
}
/**
* The version of Laravel being run.
*/
function laravelVersion(): string {
try {
const composer = JSON.parse(fs.readFileSync('composer.lock').toString())
return composer.packages?.find((composerPackage: {
name: string
}) => composerPackage.name === 'laravel/framework')?.version ?? ''
} catch {
return ''
}
}
/**
* The version of the Laravel Vite plugin being run.
*/
function pluginVersion(): string {
try {
return JSON.parse(fs.readFileSync(path.join(dirname(), '../package.json')).toString())?.version
} catch {
return ''
}
}
/**
* Convert the users configuration into a standard structure with defaults.
*/
function resolvePluginConfig(config: string | string[] | PluginConfig): Required<PluginConfig> {
if (typeof config === 'undefined') {
throw new Error('laravel-vite-plugin: missing configuration.')
}
if (typeof config === 'string' || Array.isArray(config)) {
config = {input: config, ssr: config}
}
if (typeof config.input === 'undefined') {
throw new Error('laravel-vite-plugin: missing configuration for "input".')
}
if (typeof config.publicDirectory === 'string') {
config.publicDirectory = config.publicDirectory.trim().replace(/^\/+/, '')
if (config.publicDirectory === '') {
throw new Error('laravel-vite-plugin: publicDirectory must be a subdirectory. E.g. \'public\'.')
}
}
if (typeof config.buildDirectory === 'string') {
config.buildDirectory = config.buildDirectory.trim().replace(/^\/+/, '').replace(/\/+$/, '')
if (config.buildDirectory === '') {
throw new Error('laravel-vite-plugin: buildDirectory must be a subdirectory. E.g. \'build\'.')
}
}
if (typeof config.ssrOutputDirectory === 'string') {
config.ssrOutputDirectory = config.ssrOutputDirectory.trim().replace(/^\/+/, '').replace(/\/+$/, '')
}
if (config.refresh === true) {
config.refresh = [{paths: refreshPaths}]
}
return {
input: config.input,
publicDirectory: config.publicDirectory ?? 'public',
buildDirectory: config.buildDirectory ?? 'build',
ssr: config.ssr ?? config.input,
ssrOutputDirectory: config.ssrOutputDirectory ?? 'bootstrap/ssr',
refresh: config.refresh ?? false,
hotFile: config.hotFile ?? path.join((config.publicDirectory ?? 'public'), 'hot'),
valetTls: config.valetTls ?? null,
detectTls: config.detectTls ?? config.valetTls ?? null,
transformOnServe: config.transformOnServe ?? ((code) => code),
}
}
/**
* Resolve the Vite base option from the configuration.
*/
function resolveBase(config: Required<PluginConfig>, assetUrl: string): string {
return assetUrl + (!assetUrl.endsWith('/') ? '/' : '') + config.buildDirectory + '/'
}
/**
* Resolve the Vite input path from the configuration.
*/
function resolveInput(config: Required<PluginConfig>, ssr: boolean): string | string[] | undefined {
if (ssr) {
return config.ssr
}
return config.input
}
/**
* Resolve the Vite outDir path from the configuration.
*/
function resolveOutDir(config: Required<PluginConfig>, ssr: boolean): string | undefined {
if (ssr) {
return config.ssrOutputDirectory
}
return path.join(config.publicDirectory, config.buildDirectory)
}
function resolveFullReloadConfig({refresh: config}: Required<PluginConfig>): PluginOption[] {
if (typeof config === 'boolean') {
return [];
}
if (typeof config === 'string') {
config = [{paths: [config]}]
}
if (!Array.isArray(config)) {
config = [config]
}
if (config.some(c => typeof c === 'string')) {
config = [{paths: config}] as RefreshConfig[]
}
return (config as RefreshConfig[]).flatMap(c => {
const plugin = fullReload(c.paths, c.config)
/* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
/** @ts-ignore */
plugin.__laravel_plugin_config = c
return plugin
})
}
/**
* Resolve the dev server URL from the server address and configuration.
*/
function resolveDevServerUrl(address: AddressInfo, config: ResolvedConfig, userConfig: UserConfig): DevServerUrl {
const configHmrProtocol = typeof config.server.hmr === 'object' ? config.server.hmr.protocol : null
const clientProtocol = configHmrProtocol ? (configHmrProtocol === 'wss' ? 'https' : 'http') : null
const serverProtocol = config.server.https ? 'https' : 'http'
const protocol = clientProtocol ?? serverProtocol
const configHmrHost = typeof config.server.hmr === 'object' ? config.server.hmr.host : null
const configHost = typeof config.server.host === 'string' ? config.server.host : null
const sailHost = process.env.LARAVEL_SAIL && !userConfig.server?.host ? 'localhost' : null
const serverAddress = isIpv6(address) ? `[${address.address}]` : address.address
const host = configHmrHost ?? sailHost ?? configHost ?? serverAddress
const configHmrClientPort = typeof config.server.hmr === 'object' ? config.server.hmr.clientPort : null
const port = configHmrClientPort ?? address.port
return `${protocol}://${host}:${port}`
}
function isIpv6(address: AddressInfo): boolean {
return address.family === 'IPv6'
// In node >=18.0 <18.4 this was an integer value. This was changed in a minor version.
// See: https://github.com/laravel/vite-plugin/issues/103
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore-next-line
|| address.family === 6;
}
/**
* Add the Inertia helpers to the list of SSR dependencies that aren't externalized.
*
* @see https://vitejs.dev/guide/ssr.html#ssr-externals
*/
function noExternalInertiaHelpers(config: UserConfig): true | Array<string | RegExp> {
/* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
/* @ts-ignore */
const userNoExternal = (config.ssr as SSROptions | undefined)?.noExternal
const pluginNoExternal = ['laravel-vite-plugin']
if (userNoExternal === true) {
return true
}
if (typeof userNoExternal === 'undefined') {
return pluginNoExternal
}
return [
...(Array.isArray(userNoExternal) ? userNoExternal : [userNoExternal]),
...pluginNoExternal,
]
}
/**
* Resolve the server config from the environment.
*/
function resolveEnvironmentServerConfig(env: Record<string, string>): {
hmr?: { host: string }
host?: string,
https?: { cert: Buffer, key: Buffer }
} | undefined {
if (!env.VITE_DEV_SERVER_KEY && !env.VITE_DEV_SERVER_CERT) {
return
}
if (!fs.existsSync(env.VITE_DEV_SERVER_KEY) || !fs.existsSync(env.VITE_DEV_SERVER_CERT)) {
throw Error(`Unable to find the certificate files specified in your environment. Ensure you have correctly configured VITE_DEV_SERVER_KEY: [${env.VITE_DEV_SERVER_KEY}] and VITE_DEV_SERVER_CERT: [${env.VITE_DEV_SERVER_CERT}].`)
}
const host = resolveHostFromEnv(env)
if (!host) {
throw Error(`Unable to determine the host from the environment's APP_URL: [${env.APP_URL}].`)
}
return {
hmr: {host},
host,
https: {
key: fs.readFileSync(env.VITE_DEV_SERVER_KEY),
cert: fs.readFileSync(env.VITE_DEV_SERVER_CERT),
},
}
}
/**
* Resolve the host name from the environment.
*/
function resolveHostFromEnv(env: Record<string, string>): string | undefined {
try {
return new URL(env.APP_URL).host
} catch {
return
}
}
/**
* Resolve the Herd or Valet server config for the given host.
*/
function resolveDevelopmentEnvironmentServerConfig(host: string | boolean | null): {
hmr?: { host: string }
host?: string,
https?: { cert: string, key: string }
} | undefined {
if (host === false) {
return
}
const configPath = determineDevelopmentEnvironmentConfigPath();
if (typeof configPath === 'undefined' && host === null) {
return
}
if (typeof configPath === 'undefined') {
throw Error(`Unable to find the Herd or Valet configuration directory. Please check they are correctly installed.`)
}
const resolvedHost = host === true || host === null
? path.basename(process.cwd()) + '.' + resolveDevelopmentEnvironmentTld(configPath)
: host
const keyPath = path.resolve(configPath, 'Certificates', `${resolvedHost}.key`)
const certPath = path.resolve(configPath, 'Certificates', `${resolvedHost}.crt`)
if (!fs.existsSync(keyPath) || !fs.existsSync(certPath)) {
if (host === null) {
return
}
if (configPath === herdConfigPath()) {
throw Error(`Unable to find certificate files for your host [${resolvedHost}] in the [${configPath}/Certificates] directory. Ensure you have secured the site via the Herd UI.`)
} else if (typeof host === 'string') {
throw Error(`Unable to find certificate files for your host [${resolvedHost}] in the [${configPath}/Certificates] directory. Ensure you have secured the site by running \`valet secure ${host}\`.`)
} else {
throw Error(`Unable to find certificate files for your host [${resolvedHost}] in the [${configPath}/Certificates] directory. Ensure you have secured the site by running \`valet secure\`.`)
}
}
return {
hmr: {host: resolvedHost},
host: resolvedHost,
https: {
key: keyPath,
cert: certPath,
},
}
}
/**
* Resolve the path to the Herd or Valet configuration directory.
*/
function determineDevelopmentEnvironmentConfigPath(): string | undefined {
if (fs.existsSync(herdConfigPath())) {
return herdConfigPath()
}
if (fs.existsSync(valetConfigPath())) {
return valetConfigPath()
}
}
/**
* Resolve the TLD via the config path.
*/
function resolveDevelopmentEnvironmentTld(configPath: string): string {
const configFile = path.resolve(configPath, 'config.json')
if (!fs.existsSync(configFile)) {
throw Error(`Unable to find the configuration file [${configFile}].`)
}
const config: { tld: string } = JSON.parse(fs.readFileSync(configFile, 'utf-8'))
return config.tld
}
/**
* The directory of the current file.
*/
function dirname(): string {
return fileURLToPath(new URL('.', import.meta.url))
}
/**
* Herd's configuration directory.
*/
function herdConfigPath(): string {
return path.resolve(os.homedir(), 'Library', 'Application Support', 'Herd', 'config', 'valet')
}
/**
* Valet's configuration directory.
*/
function valetConfigPath(): string {
return path.resolve(os.homedir(), '.config', 'valet')
}