Remove default entry point

The optimal entry points are different between Blade apps and SPAs so
this removes the default entry point in favour of specifying them
explicitly for each use case.

Author: jessarcher

src/index.ts

@@ -7,38 +7,36 @@ import { Plugin, loadEnv, UserConfig, ConfigEnv, Manifest, ResolvedConfig } from
 interface PluginConfig {
     /**
      * The path or paths of the entry points to compile.
-     *
-     * @default ['resources/css/app.css', 'resources/js/app.js']
      */
-    input: string|string[]|undefined
+    input: string|string[]
 
     /**
      * Laravel's public directory.
      *
      * @default 'public'
      */
-    publicDirectory: string
+    publicDirectory?: string
 
     /**
      * The public subdirectory where compiled assets should be written.
      *
      * @default 'build'
      */
-    buildDirectory: string
+    buildDirectory?: string
 
     /**
      * The path of the SSR entry point.
      *
      * @default 'resources/js/ssr.js'
      */
-    ssr: string|string[]|undefined
+    ssr?: string|string[]|undefined
 
     /**
      * The directory where the SSR bundle should be written.
      *
      * @default 'storage/ssr'
      */
-    ssrOutputDirectory: string
+    ssrOutputDirectory?: string
 }
 
 interface LaravelPlugin extends Plugin {
@@ -50,7 +48,7 @@ interface LaravelPlugin extends Plugin {
  *
  * @param config - A config object or relative path(s) of the scripts to be compiled.
  */
-export default function laravel(config?: string|string[]|Partial<PluginConfig>): LaravelPlugin {
+export default function laravel(config: string|string[]|PluginConfig): LaravelPlugin {
     const pluginConfig = resolvePluginConfig(config)
     let viteDevServerUrl: string
     let resolvedConfig: ResolvedConfig
@@ -197,11 +195,19 @@ function laravelVersion(): string {
 /**
  * Convert the users configuration into a standard structure with defaults.
  */
-function resolvePluginConfig(config?: string|string[]|Partial<PluginConfig>): PluginConfig {
-    if (typeof config === 'undefined' || typeof config === 'string' || Array.isArray(config)) {
+function resolvePluginConfig(config: string|string[]|PluginConfig): Required<PluginConfig> {
+    if (typeof config === 'undefined') {
+        throw new Error('Missing configuration')
+    }
+
+    if (typeof config === 'string' || Array.isArray(config)) {
         config = { input: config, ssr: config }
     }
 
+    if (typeof config.input === 'undefined') {
+        throw new Error('Missing configuration for key: input')
+    }
+
     if (typeof config.publicDirectory === 'string') {
         config.publicDirectory = config.publicDirectory.trim().replace(/^\/+/, '')
 
@@ -223,7 +229,7 @@ function resolvePluginConfig(config?: string|string[]|Partial<PluginConfig>): Pl
     }
 
     return {
-        input: config.input ?? ['resources/css/app.css', 'resources/js/app.js'],
+        input: config.input,
         publicDirectory: config.publicDirectory ?? 'public',
         buildDirectory: config.buildDirectory ?? 'build',
         ssr: config.ssr ?? 'resources/js/ssr.js',
@@ -234,14 +240,14 @@ function resolvePluginConfig(config?: string|string[]|Partial<PluginConfig>): Pl
 /**
  * Resolve the Vite base option from the configuration.
  */
-function resolveBase(config: PluginConfig, assetUrl: string): string {
+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: PluginConfig, ssr: boolean): string|string[]|undefined {
+function resolveInput(config: Required<PluginConfig>, ssr: boolean): string|string[]|undefined {
     if (ssr) {
         return config.ssr ?? config.input
     }
@@ -252,7 +258,7 @@ function resolveInput(config: PluginConfig, ssr: boolean): string|string[]|undef
 /**
  * Resolve the Vite outDir path from the configuration.
  */
-function resolveOutDir(config: PluginConfig, ssr: boolean): string|undefined {
+function resolveOutDir(config: Required<PluginConfig>, ssr: boolean): string|undefined {
     if (ssr) {
         return config.ssrOutputDirectory
     }

tests/index.test.ts

@@ -7,27 +7,16 @@ describe('laravel-vite-plugin', () => {
         vi.clearAllMocks()
     })
 
-    it('provides sensible default values', () => {
-        const plugin = laravel()
-        expect(plugin.name).toBe('laravel')
-
-        const buildConfig = plugin.config({}, { command: 'build', mode: 'production' })
-        expect(buildConfig.base).toBe('/build/')
-        expect(buildConfig.build.manifest).toBe(true)
-        expect(buildConfig.build.outDir).toBe('public/build')
-        expect(buildConfig.build.rollupOptions.input).toEqual(['resources/css/app.css', 'resources/js/app.js'])
-
-        const serveConfig = plugin.config({}, { command: 'serve', mode: 'development' })
-        expect(serveConfig.base).toBe('')
-        expect(buildConfig.server.host).toBeUndefined()
-        expect(buildConfig.server.port).toBeUndefined()
-        expect(buildConfig.server.strictPort).toBeUndefined()
+    it('handles missing configuration', () => {
+        /* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
+        /* @ts-ignore */
+        expect(() => laravel())
+            .toThrowError('Missing configuration');
 
-        const ssrConfig = plugin.config({ build: { ssr: true } }, { command: 'build', mode: 'production' })
-        expect(ssrConfig.base).toBe('/build/')
-        expect(ssrConfig.build.manifest).toBe(false)
-        expect(ssrConfig.build.outDir).toBe('storage/ssr')
-        expect(ssrConfig.build.rollupOptions.input).toBe('resources/js/ssr.js')
+        /* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
+        /* @ts-ignore */
+        expect(() => laravel({}))
+            .toThrowError('Missing configuration for key: input');
     })
 
     it('accepts a single input', () => {
@@ -108,17 +97,18 @@ describe('laravel-vite-plugin', () => {
     })
 
     it('prevents setting an empty publicDirectory', () => {
-        expect(() => laravel({ publicDirectory: '' }))
+        expect(() => laravel({ input: 'resources/js/app.js', publicDirectory: '' }))
             .toThrowError('publicDirectory must be a subdirectory');
     })
 
     it('prevents setting an empty buildDirectory', () => {
-        expect(() => laravel({ buildDirectory: '' }))
+        expect(() => laravel({ input: 'resources/js/app.js', buildDirectory: '' }))
             .toThrowError('buildDirectory must be a subdirectory');
     })
 
     it('handles surrounding slashes on directories', () => {
         const plugin = laravel({
+            input: 'resources/js/app.js',
             publicDirectory: '/public/test/',
             buildDirectory: '/build/test/',
             ssrOutputDirectory: '/ssr-output/test/',
@@ -197,7 +187,7 @@ describe('laravel-vite-plugin', () => {
 
     it('configures the Vite server when inside a Sail container', () => {
         process.env.LARAVEL_SAIL = '1'
-        const plugin = laravel()
+        const plugin = laravel('resources/js/app.js')
 
         const config = plugin.config({}, { command: 'serve', mode: 'development' })
         expect(config.server.host).toBe('0.0.0.0')
@@ -210,7 +200,7 @@ describe('laravel-vite-plugin', () => {
     it('allows the Vite port to be configured when inside a Sail container', () => {
         process.env.LARAVEL_SAIL = '1'
         process.env.VITE_PORT = '1234'
-        const plugin = laravel()
+        const plugin = laravel('resources/js/app.js')
 
         const config = plugin.config({}, { command: 'serve', mode: 'development' })
         expect(config.server.host).toBe('0.0.0.0')