Merge pull request #5 from laravel/default-aliases

Include default aliases

Author: timacdonald

src/index.ts

@@ -55,6 +55,12 @@ export default function laravel(config: string|string[]|Partial<PluginConfig>):
     let viteDevServerUrl: string
     let resolvedConfig: ResolvedConfig
 
+    const ziggy = 'vendor/tightenco/ziggy/dist/index.es.js';
+    const defaultAliases: Record<string, string> = {
+        ...(fs.existsSync(ziggy) ? { ziggy } : undefined),
+        '@': '/resources/js',
+    };
+
     return {
         name: 'laravel',
         enforce: 'post',
@@ -76,6 +82,20 @@ export default function laravel(config: string|string[]|Partial<PluginConfig>):
                 server: {
                     origin: '__laravel_vite_placeholder__',
                 },
+                resolve: {
+                    alias: Array.isArray(userConfig.resolve?.alias)
+                        ? [
+                            ...userConfig.resolve?.alias ?? [],
+                            ...Object.keys(defaultAliases).map(alias => ({
+                                find: alias,
+                                replacement: defaultAliases[alias]
+                            }))
+                        ]
+                        : {
+                            ...defaultAliases,
+                            ...userConfig.resolve?.alias,
+                        }
+                }
             }
         },
         configResolved(config) {

tests/index.test.ts

@@ -1,7 +1,12 @@
-import { describe, expect, it } from 'vitest'
+import { afterEach, beforeEach, describe, expect, it, MockedFunction, vi } from 'vitest'
 import laravel from '../src'
+import fs from 'fs'
 
 describe('laravel-vite-plugin', () => {
+    afterEach(() => {
+        vi.clearAllMocks()
+    })
+
     it('accepts a single input', () => {
         const plugin = laravel('resources/js/app.js')
 
@@ -128,6 +133,69 @@ describe('laravel-vite-plugin', () => {
         expect(ssrConfig.build.outDir).toBe('ssr-output/test')
     })
 
+    it('provides an @ alias by default', () => {
+        const plugin = laravel('resources/js/app.js')
+
+        const config = plugin.config({}, { command: 'build', mode: 'development' })
+
+        expect(config.resolve.alias['@']).toBe('/resources/js')
+    })
+
+    it('respects a users existing @ alias', () => {
+        const plugin = laravel('resources/js/app.js')
+
+        const config = plugin.config({
+            resolve: {
+                alias: {
+                    '@': '/somewhere/else'
+                }
+            }
+        }, { command: 'build', mode: 'development' })
+
+        expect(config.resolve.alias['@']).toBe('/somewhere/else')
+    })
+
+    it('appends an Alias object when using an alias array', () => {
+        const plugin = laravel('resources/js/app.js')
+
+        const config = plugin.config({
+            resolve: {
+                alias: [
+                    { find: '@', replacement: '/something/else' }
+                ],
+            }
+        }, { command: 'build', mode: 'development' })
+
+        expect(config.resolve.alias).toEqual([
+            { find: '@', replacement: '/something/else' },
+            { find: '@', replacement: '/resources/js' },
+        ])
+    })
+
+    it('provides an ziggy alias when installed', () => {
+        vi.spyOn(fs, 'existsSync').mockReturnValueOnce(true)
+
+        const plugin = laravel('resources/js/app.js')
+
+        const config = plugin.config({}, { command: 'build', mode: 'development' })
+
+        expect(config.resolve.alias['ziggy']).toBe('vendor/tightenco/ziggy/dist/index.es.js')
+    })
+
+    it('provides an ziggy alias when installed and using an alias array', () => {
+        vi.spyOn(fs, 'existsSync').mockReturnValueOnce(true)
+
+        const plugin = laravel('resources/js/app.js')
+
+        const config = plugin.config({
+            resolve: {
+                alias: [],
+            }
+        }, { command: 'build', mode: 'development' })
+
+        expect(config.resolve.alias).toContainEqual({ find: 'ziggy', replacement: 'vendor/tightenco/ziggy/dist/index.es.js' })
+    })
+
     it('prevents empty input', () => {
         /* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
         /* @ts-ignore */