Skip to content

Commit

Permalink
Add Svelte support to Inertia Breeze
Browse files Browse the repository at this point in the history 
Previously, the Inertia Breeze starter kit only supported React and Vue. This commit introduces support for Svelte, thus expanding the options available for users of the starter kit. Extensive testing has been conducted to ensure that Svelte integrates seamlessly with the existing codebase and works properly.
  • Loading branch information
@HichemTab-tech
HichemTab-tech committed Jul 20, 2024
1 parent 1446994 commit 07ff1a0
Show file tree
Hide file tree
Showing 40 changed files with 2,088 additions and 19 deletions.
2 changes: 1 addition & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "laravel/breeze",
"name": "my-laravel/breeze",
"description": "Minimal Laravel authentication scaffolding with Blade and Tailwind.",
"keywords": ["laravel", "auth"],
"license": "MIT",
Expand Down
9 changes: 6 additions & 3 deletions src/Console/InstallCommand.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class InstallCommand extends Command implements PromptsForMissingInput
*
* @var string
*/
protected $signature = 'breeze:install {stack : The development stack that should be installed (blade,livewire,livewire-functional,react,vue,api)}
protected $signature = 'breeze:install {stack : The development stack that should be installed (blade,livewire,livewire-functional,react,vue,svelte,api)}
{--dark : Indicate that dark mode support should be installed}
{--pest : Indicate that Pest should be installed}
{--ssr : Indicates if Inertia SSR support should be installed}
Expand All @@ -54,6 +54,8 @@ public function handle()
return $this->installInertiaVueStack();
} elseif ($this->argument('stack') === 'react') {
return $this->installInertiaReactStack();
} elseif ($this->argument('stack') === 'svelte') {
return $this->installInertiaSvelteStack();
} elseif ($this->argument('stack') === 'api') {
return $this->installApiStack();
} elseif ($this->argument('stack') === 'blade') {
Expand All @@ -64,7 +66,7 @@ public function handle()
return $this->installLivewireStack(true);
}

$this->components->error('Invalid stack. Supported stacks are [blade], [livewire], [livewire-functional], [react], [vue], and [api].');
$this->components->error('Invalid stack. Supported stacks are [blade], [livewire], [livewire-functional], [react], [vue], [svelte], and [api].');

return 1;
}
Expand Down Expand Up @@ -354,6 +356,7 @@ protected function promptForMissingArgumentsUsing()
'livewire-functional' => 'Livewire (Volt Functional API) with Alpine',
'react' => 'React with Inertia',
'vue' => 'Vue with Inertia',
'svelte' => 'Svelte with Inertia',
'api' => 'API only',
],
scroll: 6,
Expand All @@ -372,7 +375,7 @@ protected function afterPromptingForMissingArguments(InputInterface $input, Outp
{
$stack = $input->getArgument('stack');

if (in_array($stack, ['react', 'vue'])) {
if (in_array($stack, ['react', 'vue', 'svelte'])) {
collect(multiselect(
label: 'Would you like any optional features?',
options: [
Expand Down
262 changes: 247 additions & 15 deletions src/Console/InstallsInertiaStacks.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,26 +190,26 @@ protected function installInertiaReactStack()
// NPM Packages...
$this->updateNodePackages(function ($packages) {
return [
'@headlessui/react' => '^2.0.0',
'@inertiajs/react' => '^1.0.0',
'@tailwindcss/forms' => '^0.5.3',
'@vitejs/plugin-react' => '^4.2.0',
'autoprefixer' => '^10.4.12',
'postcss' => '^8.4.31',
'tailwindcss' => '^3.2.1',
'react' => '^18.2.0',
'react-dom' => '^18.2.0',
] + $packages;
'@headlessui/react' => '^2.0.0',
'@inertiajs/react' => '^1.0.0',
'@tailwindcss/forms' => '^0.5.3',
'@vitejs/plugin-react' => '^4.2.0',
'autoprefixer' => '^10.4.12',
'postcss' => '^8.4.31',
'tailwindcss' => '^3.2.1',
'react' => '^18.2.0',
'react-dom' => '^18.2.0',
] + $packages;
});

if ($this->option('typescript')) {
$this->updateNodePackages(function ($packages) {
return [
'@types/node' => '^18.13.0',
'@types/react' => '^18.0.28',
'@types/react-dom' => '^18.0.10',
'typescript' => '^5.0.2',
] + $packages;
'@types/node' => '^18.13.0',
'@types/react' => '^18.0.28',
'@types/react-dom' => '^18.0.10',
'typescript' => '^5.0.2',
] + $packages;
});
}

Expand Down Expand Up @@ -323,6 +323,171 @@ protected function installInertiaReactStack()
$this->components->info('Breeze scaffolding installed successfully.');
}

/**
* Install the Inertia Svelte Breeze stack.
*
* @return int|null
*/
protected function installInertiaSvelteStack()
{
//TODO: fix typescript and remove this
if ($this->option('typescript')) {
$this->components->error('Typescript is not available for Svelte stack yet. It will be ignored until next updates.');
return 1;
}
// Install Inertia...
if (! $this->requireComposerPackages(['inertiajs/inertia-laravel:^1.0', 'laravel/sanctum:^4.0', 'tightenco/ziggy:^2.0'])) {
return 1;
}

// NPM Packages...
$this->updateNodePackages(function ($packages) {
return [
"@tailwindcss/forms" => "^0.5.3",
"autoprefixer" => "^10.4.12",
"laravel-vite-plugin" => "^1.0",
"postcss" => "^8.4.31",
"tailwindcss" => "^3.2.1",
"vite" => "^5.0"
] + $packages;
});
$this->updateNodePackages(function ($packages) {
return [
"axios" => "^1.6.4",
"@inertiajs/svelte" => "^1.2.0",
"@sveltejs/vite-plugin-svelte" => "^3.1.1",
"concurrently" => "^8.2.2",
"ziggy-js" => "^2.2.1",
"minimist" => "^1.2.8"
] + $packages;
}, false);

if ($this->option('typescript')) {
$this->updateNodePackages(function ($packages) {
return [
'@types/node' => '^18.13.0',
//'@types/react' => '^18.0.28',
//'@types/react-dom' => '^18.0.10',
'typescript' => '^5.0.2',
] + $packages;
});
}

// Controllers...
(new Filesystem)->ensureDirectoryExists(app_path('Http/Controllers'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-common/app/Http/Controllers', app_path('Http/Controllers'));

// Requests...
(new Filesystem)->ensureDirectoryExists(app_path('Http/Requests'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/default/app/Http/Requests', app_path('Http/Requests'));

// Middleware...
$this->installMiddleware([
'\App\Http\Middleware\HandleInertiaRequests::class',
'\Illuminate\Http\Middleware\AddLinkHeadersForPreloadedAssets::class',
]);

(new Filesystem)->ensureDirectoryExists(app_path('Http/Middleware'));
copy(__DIR__.'/../../stubs/inertia-common/app/Http/Middleware/HandleInertiaRequests.php', app_path('Http/Middleware/HandleInertiaRequests.php'));

// Views...
copy(__DIR__.'/../../stubs/inertia-svelte/resources/views/app.blade.php', resource_path('views/app.blade.php'));

@unlink(resource_path('views/welcome.blade.php'));

// Components + Pages...
(new Filesystem)->ensureDirectoryExists(resource_path('js/Components'));
(new Filesystem)->ensureDirectoryExists(resource_path('js/Layouts'));
(new Filesystem)->ensureDirectoryExists(resource_path('js/Pages'));

if ($this->option('typescript')) {
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/Components', resource_path('js/Components'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/Layouts', resource_path('js/Layouts'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/Pages', resource_path('js/Pages'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/types', resource_path('js/types'));
} else {
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte/resources/js/Components', resource_path('js/Components'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte/resources/js/Layouts', resource_path('js/Layouts'));
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-svelte/resources/js/Pages', resource_path('js/Pages'));
}

if (! $this->option('dark')) {
$this->removeDarkClasses((new Finder)
->in(resource_path('js'))
->name(['*.js', '*.ts'])
->notName(['Welcome.js', 'Welcome.ts'])
);
}

// Tests...
if (! $this->installTests()) {
return 1;
}

if ($this->option('pest')) {
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-common/pest-tests/Feature', base_path('tests/Feature'));
} else {
(new Filesystem)->copyDirectory(__DIR__.'/../../stubs/inertia-common/tests/Feature', base_path('tests/Feature'));
}

// Routes...
copy(__DIR__.'/../../stubs/inertia-common/routes/web.php', base_path('routes/web.php'));
copy(__DIR__.'/../../stubs/inertia-common/routes/auth.php', base_path('routes/auth.php'));

// Tailwind / Vite...
copy(__DIR__.'/../../stubs/default/resources/css/app.css', resource_path('css/app.css'));
copy(__DIR__.'/../../stubs/default/postcss.config.js', base_path('postcss.config.js'));
copy(__DIR__.'/../../stubs/inertia-common/tailwind.config.js', base_path('tailwind.config.js'));
if ($this->option('ssr')) {
copy(__DIR__.'/../../stubs/inertia-svelte/vite.config.ssr.js', base_path('vite.config.js'));
} else {
copy(__DIR__.'/../../stubs/inertia-svelte/vite.config.js', base_path('vite.config.js'));
}

if (file_exists(resource_path('js/app.js'))) {
unlink(resource_path('js/app.js'));
}

if ($this->option('typescript')) {
copy(__DIR__.'/../../stubs/inertia-svelte-ts/tsconfig.json', base_path('tsconfig.json'));
copy(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/app.ts', resource_path('js/app.ts'));
copy(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/route.ts', resource_path('js/route.ts'));

if (file_exists(resource_path('js/bootstrap.js'))) {
rename(resource_path('js/bootstrap.js'), resource_path('js/bootstrap.ts'));
}

$this->replaceInFile('"vite build', '"tsc && vite build', base_path('package.json'));
$this->replaceInFile('.js', '.ts', base_path('vite.config.js'));
$this->replaceInFile('.js', '.ts', resource_path('views/app.blade.php'));
$this->replaceInFile('.vue', '.svelte', base_path('tailwind.config.js'));
} else {
copy(__DIR__.'/../../stubs/inertia-common/jsconfig.json', base_path('jsconfig.json'));
copy(__DIR__.'/../../stubs/inertia-svelte/resources/js/app.js', resource_path('js/app.js'));
copy(__DIR__ . '/../../stubs/inertia-svelte/resources/js/route.js', resource_path('js/route.js'));

$this->replaceInFile('.vue', '.svelte', base_path('tailwind.config.js'));
}

$this->installInertiaSvelteSsrStack($this->option('ssr'));

$this->components->info('Installing and building Node dependencies.');

if (file_exists(base_path('pnpm-lock.yaml'))) {
$this->runCommands(['pnpm install', 'pnpm run build']);
} elseif (file_exists(base_path('yarn.lock'))) {
$this->runCommands(['yarn install', 'yarn run build']);
} elseif (file_exists(base_path('bun.lockb'))) {
$this->runCommands(['bun install', 'bun run build']);
} else {
$this->runCommands(['npm install', 'npm run build']);
}

$this->line('');
$this->components->info('Breeze scaffolding installed successfully.');
return 1;
}

/**
* Install the Inertia React SSR stack into the application.
*
Expand All @@ -346,6 +511,53 @@ protected function installInertiaReactSsrStack()
$this->replaceInFile('/node_modules', '/bootstrap/ssr'.PHP_EOL.'/node_modules', base_path('.gitignore'));
}

/**
* Install the Inertia Svelte SSR stack into the application.
*
* @return void
*/
protected function installInertiaSvelteSsrStack($ssr)
{
$ext = "js";
if ($this->option('typescript')) {
$ext = "ts";
}

if ($ssr) {
copy(__DIR__.'/../../stubs/inertia-svelte/resources/js/ssr/route-factory.dev.'.$ext, resource_path('js/route-factory.dev.'.$ext));
copy(__DIR__.'/../../stubs/inertia-svelte/resources/js/ssr/route-factory.prod.'.$ext, resource_path('js/route-factory.prod.'.$ext));
$this->replaceInFile('"vite build"', '"vite build && vite build --ssr"', base_path('package.json'));
}
else{
copy(__DIR__.'/../../stubs/inertia-svelte/resources/js/no-ssr/route-factory.'.$ext, resource_path('js/route-factory.'.$ext));
}
$scripts = [
'start' => 'concurrently --kill-others "npm run dev" "php artisan serve"',
'start-w-ssr' => 'php artisan ziggy:generate && npm run build && concurrently --kill-others "php artisan serve" "php artisan inertia:start-ssr"',
];
if (!$ssr) {
unset($scripts['start-w-ssr']);
}

$packagePath = base_path('package.json');
$packageJson = json_decode(file_get_contents($packagePath), true);

foreach ($scripts as $scriptName => $scriptValue) {
$packageJson['scripts'][$scriptName] = $scriptValue;
}
file_put_contents($packagePath, json_encode($packageJson, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));

if (!$ssr) return;
copy(__DIR__.'/../../stubs/inertia-svelte-ts/resources/js/ssr.'.$ext, resource_path('js/ssr.'.$ext));
$this->replaceInFile("input: 'resources/js/app.'.$ext,", "input: 'resources/js/app.'.$ext,".PHP_EOL." ssr: 'resources/js/ssr.$ext',", base_path('vite.config.js'));
$this->configureSvelteHydrateRootForSsr(resource_path('js/app.'.$ext));


$this->configureZiggyForSsr();

$this->replaceInFile('/node_modules', '/bootstrap/ssr'.PHP_EOL.'/node_modules', base_path('.gitignore'));
}

/**
* Configure the application JavaScript file to utilize hydrateRoot for SSR.
*
Expand Down Expand Up @@ -382,6 +594,26 @@ protected function configureReactHydrateRootForSsr($path)
);
}

/**
* Configure the application JavaScript file to utilize hydrateRoot for SSR.
*
* @param string $path
* @return void
*/
protected function configureSvelteHydrateRootForSsr($path)
{

$this->replaceInFile(
<<<'EOT'
new App({ target: el, props });
EOT,
<<<'EOT'
new App({ target: el, props, hydrate: true });
EOT,
$path
);
}

/**
* Configure Ziggy for SSR.
*
Expand Down
9 changes: 9 additions & 0 deletions stubs/inertia-svelte/resources/js/Components/ApplicationLogo.svelte
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script>
export let classes = "";
</script>

<svg class={classes} viewBox="0 0 316 316" xmlns="http://www.w3.org/2000/svg">
<path
d="M305.8 81.125C305.77 80.995 305.69 80.885 305.65 80.755C305.56 80.525 305.49 80.285 305.37 80.075C305.29 79.935 305.17 79.815 305.07 79.685C304.94 79.515 304.83 79.325 304.68 79.175C304.55 79.045 304.39 78.955 304.25 78.845C304.09 78.715 303.95 78.575 303.77 78.475L251.32 48.275C249.97 47.495 248.31 47.495 246.96 48.275L194.51 78.475C194.33 78.575 194.19 78.725 194.03 78.845C193.89 78.955 193.73 79.045 193.6 79.175C193.45 79.325 193.34 79.515 193.21 79.685C193.11 79.815 192.99 79.935 192.91 80.075C192.79 80.285 192.71 80.525 192.63 80.755C192.58 80.875 192.51 80.995 192.48 81.125C192.38 81.495 192.33 81.875 192.33 82.265V139.625L148.62 164.795V52.575C148.62 52.185 148.57 51.805 148.47 51.435C148.44 51.305 148.36 51.195 148.32 51.065C148.23 50.835 148.16 50.595 148.04 50.385C147.96 50.245 147.84 50.125 147.74 49.995C147.61 49.825 147.5 49.635 147.35 49.485C147.22 49.355 147.06 49.265 146.92 49.155C146.76 49.025 146.62 48.885 146.44 48.785L93.99 18.585C92.64 17.805 90.98 17.805 89.63 18.585L37.18 48.785C37 48.885 36.86 49.035 36.7 49.155C36.56 49.265 36.4 49.355 36.27 49.485C36.12 49.635 36.01 49.825 35.88 49.995C35.78 50.125 35.66 50.245 35.58 50.385C35.46 50.595 35.38 50.835 35.3 51.065C35.25 51.185 35.18 51.305 35.15 51.435C35.05 51.805 35 52.185 35 52.575V232.235C35 233.795 35.84 235.245 37.19 236.025L142.1 296.425C142.33 296.555 142.58 296.635 142.82 296.725C142.93 296.765 143.04 296.835 143.16 296.865C143.53 296.965 143.9 297.015 144.28 297.015C144.66 297.015 145.03 296.965 145.4 296.865C145.5 296.835 145.59 296.775 145.69 296.745C145.95 296.655 146.21 296.565 146.45 296.435L251.36 236.035C252.72 235.255 253.55 233.815 253.55 232.245V174.885L303.81 145.945C305.17 145.165 306 143.725 306 142.155V82.265C305.95 81.875 305.89 81.495 305.8 81.125ZM144.2 227.205L100.57 202.515L146.39 176.135L196.66 147.195L240.33 172.335L208.29 190.625L144.2 227.205ZM244.75 114.995V164.795L226.39 154.225L201.03 139.625V89.825L219.39 100.395L244.75 114.995ZM249.12 57.105L292.81 82.265L249.12 107.425L205.43 82.265L249.12 57.105ZM114.49 184.425L96.13 194.995V85.305L121.49 70.705L139.85 60.135V169.815L114.49 184.425ZM91.76 27.425L135.45 52.585L91.76 77.745L48.07 52.585L91.76 27.425ZM43.67 60.135L62.03 70.705L87.39 85.305V202.545V202.555V202.565C87.39 202.735 87.44 202.895 87.46 203.055C87.49 203.265 87.49 203.485 87.55 203.695V203.705C87.6 203.875 87.69 204.035 87.76 204.195C87.84 204.375 87.89 204.575 87.99 204.745C87.99 204.745 87.99 204.755 88 204.755C88.09 204.905 88.22 205.035 88.33 205.175C88.45 205.335 88.55 205.495 88.69 205.635L88.7 205.645C88.82 205.765 88.98 205.855 89.12 205.965C89.28 206.085 89.42 206.225 89.59 206.325C89.6 206.325 89.6 206.325 89.61 206.335C89.62 206.335 89.62 206.345 89.63 206.345L139.87 234.775V285.065L43.67 229.705V60.135ZM244.75 229.705L148.58 285.075V234.775L219.8 194.115L244.75 179.875V229.705ZM297.2 139.625L253.49 164.795V114.995L278.85 100.395L297.21 89.825V139.625H297.2Z"
/>
</svg>
10 changes: 10 additions & 0 deletions stubs/inertia-svelte/resources/js/Components/Checkbox.svelte
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<script>
export let checked = false;
</script>

<input
type="checkbox"
bind:checked
{...$$props}
class="rounded dark:bg-gray-900 border-gray-300 dark:border-gray-700 text-indigo-600 shadow-sm focus:ring-indigo-500 dark:focus:ring-indigo-600 dark:focus:ring-offset-gray-800"
/>
13 changes: 13 additions & 0 deletions stubs/inertia-svelte/resources/js/Components/DangerButton.svelte
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<script>
export let type = "submit",
onClick = () => {},
classes = "";
</script>

<button
{type}
on:click={onClick}
class="inline-flex items-center px-4 py-2 bg-red-600 border border-transparent rounded-md font-semibold text-xs text-white uppercase tracking-widest hover:bg-red-500 active:bg-red-700 focus:outline-none focus:ring-2 focus:ring-red-500 focus:ring-offset-2 dark:focus:ring-offset-gray-800 transition ease-in-out duration-150 {classes}"
>
<slot />
</button>
Loading

0 comments on commit 07ff1a0

Please sign in to comment.