3 Commits
17 changed files with 130 additions and 111 deletions

No files matched your search

+1 -1
View File
@@ -1,6 +1,6 @@
# frontend-svelte
Copier template for a SvelteKit frontend on Bun with Tailwind v4, biome or ESLint + Prettier and optional shadcn-svelte: SSR on Bun, a static SPA behind `serve.ts`, or a static SPA served by the backend api. A `frontend/` part or the whole project (`layout`), on top of `infra`.
Copier template for a SvelteKit frontend on Bun with Tailwind v4, biome or ESLint + Prettier and optional shadcn-svelte, plain or with the [claddcn](https://git.kotikot.com/lib/claddcn-svelte) skin: SSR on Bun, a static SPA behind `serve.ts`, or a static SPA served by the backend api. A `frontend/` part or the whole project (`layout`), on top of `infra`.
```sh
copier copy --trust -d project_name="My Thing" -d serve=bun <this-repo> <dest>
+5 -3
View File
@@ -35,6 +35,7 @@ ui_library:
choices:
none (Tailwind v4): none
shadcn-svelte: shadcn
shadcn-svelte with the claddcn skin: claddcn
default: none
linter:
@@ -66,6 +67,7 @@ prefix:
default: "{{ 'frontend/' if layout == 'part' else '' }}"
_tasks:
# prettier-plugin-tailwindcss and biome sort classes differently, the
# sources follow biome: an eslint project is formatted once, right away.
- "{% if _copier_operation == 'copy' and install_deps %}sh -c 'cd {{ part_dir }} && bun install{% if linter == 'eslint' %} && bun run fix{% endif %}'{% else %}true{% endif %}"
- "{% if _copier_operation == 'copy' and ui_library == 'claddcn' %}npx -y git+https://git.kotikot.com/lib/claddcn-svelte.git init --cwd {{ part_dir }} --no-install{% else %}true{% endif %}"
# Generated values (project name) can push lines past the formatter width,
# so every fresh copy is formatted once by its own linter.
- "{% if _copier_operation == 'copy' and install_deps %}sh -c 'cd {{ part_dir }} && bun install && bun --bun run fix'{% else %}true{% endif %}"
+16 -8
View File
@@ -3,6 +3,10 @@
"version": "0.0.1",
"private": true,
"type": "module",
"imports": {
"#lib": "./src/lib/index.js",
"#lib/*": "./src/lib/*"
},
"scripts": {
"build": "vite build",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
@@ -20,19 +24,19 @@
},
"devDependencies": {
{%- set deps = {
"@sveltejs/kit": "^2.63.0",
"@sveltejs/kit": "^3.0.1",
"@sveltejs/vite-plugin-svelte": "^7.1.2",
"@tailwindcss/vite": "^4.3.0",
"@types/bun": "^1.3.0",
"svelte": "^5.56.1",
"svelte-check": "^4.6.0",
"svelte": "^5.57.1",
"svelte-check": "^4.7.6",
"tailwindcss": "^4.3.0",
"typescript": "^6.0.3",
"vite": "^8.0.16",
} -%}
{%- if linter == 'biome' %}{% set _ = deps.update({
"@biomejs/biome": "2.5.13",
"ultracite": "7.12.0",
"@biomejs/biome": "^2.5.15",
"ultracite": "^7.12.4",
}) %}{% else %}{% set _ = deps.update({
"@eslint/compat": "^2.1.1",
"@eslint/js": "^10.0.1",
@@ -45,18 +49,22 @@
"prettier-plugin-tailwindcss": "^0.8.1",
"typescript-eslint": "^8.71.1",
}) %}{% endif -%}
{%- if frontend_adapter == 'bun' %}{% set _ = deps.update({"svelte-adapter-bun": "^1.0.1"}) %}{% else %}{% set _ = deps.update({"@sveltejs/adapter-static": "^3.0.10"}) %}{% endif -%}
{%- if ui_library == 'shadcn' %}{% set _ = deps.update({
{%- if frontend_adapter == 'bun' %}{% set _ = deps.update({"@sveltejs/adapter-bun": "^1.0.0"}) %}{% else %}{% set _ = deps.update({"@sveltejs/adapter-static": "^4.0.0"}) %}{% endif -%}
{%- if ui_library != 'none' %}{% set _ = deps.update({
"@internationalized/date": "^3.12.0",
"@lucide/svelte": "^1.23.0",
"bits-ui": "^2.16.3",
"clsx": "^2.1.1",
"mode-watcher": "^1.1.0",
"shadcn-svelte": "^1.3.0",
"shadcn-svelte": "^1.7.0",
"svelte-sonner": "^1.1.0",
"tailwind-merge": "^3.5.0",
"tailwind-variants": "^3.2.2",
"tw-animate-css": "^1.4.0",
}) %}{% endif -%}
{%- if ui_library == 'claddcn' %}{% set _ = deps.update({
"@fontsource-variable/geist": "^5.3.0",
"@fontsource-variable/geist-mono": "^5.3.0",
}) %}{% endif %}
{%- for name, version in deps | dictsort %}
"{{ name }}": "{{ version }}"{{ "," if not loop.last }}
+5
View File
@@ -0,0 +1,5 @@
import { defineEnvVars } from "@sveltejs/kit/env";
export const variables = defineEnvVars({
PUBLIC_API_BASE_URL: { public: true, schema: (input) => input ?? "/api" },
});
@@ -1,6 +1,6 @@
import { env } from "$env/dynamic/public";
import { PUBLIC_API_BASE_URL } from "$app/env/public";
const BASE = env.PUBLIC_API_BASE_URL ?? "/api";
const BASE = PUBLIC_API_BASE_URL;
export class ApiError extends Error {
status: number;
@@ -1,3 +1,3 @@
// place files you want to import through the `$lib` alias in this folder.
// place files you want to import through the `#lib` alias in this folder.
{% if linter == 'biome' %}// biome-ignore-all lint/suspicious/noEmptySource: temporary
{% endif %}
@@ -1,12 +1,12 @@
<script lang="ts">
import "./layout.css";
{%- if ui_library == 'shadcn' %}
{%- if ui_library != 'none' %}
import { ModeWatcher } from "mode-watcher";
{%- endif %}
let { children } = $props();
</script>
{% if ui_library == 'shadcn' %}<ModeWatcher />
{% if ui_library != 'none' %}<ModeWatcher />
{% endif %}{@render children()}
@@ -3,10 +3,10 @@
</svelte:head>
<main
class="flex min-h-dvh flex-col items-center justify-center gap-4 px-6 text-center {% if ui_library == 'shadcn' %}bg-background text-foreground{% else %}bg-white text-neutral-900 dark:bg-neutral-950 dark:text-neutral-50{% endif %}"
class="flex min-h-dvh flex-col items-center justify-center gap-4 px-6 text-center {% if ui_library != 'none' %}bg-background text-foreground{% else %}bg-white text-neutral-900 dark:bg-neutral-950 dark:text-neutral-50{% endif %}"
>
<h1 class="font-bold text-4xl tracking-tight sm:text-5xl">{{ project_name }}</h1>
<p class="max-w-prose text-base {% if ui_library == 'shadcn' %}text-muted-foreground{% else %}text-neutral-500{% endif %}">
<p class="max-w-prose text-base {% if ui_library != 'none' %}text-muted-foreground{% else %}text-neutral-500{% endif %}">
Edit
<code class="font-mono">src/routes/+page.svelte</code>.
</p>
@@ -1,11 +1,14 @@
{% if ui_library == 'shadcn' -%}
{% if ui_library != 'none' -%}
@import "tailwindcss";
@import "tw-animate-css";
@import "shadcn-svelte/tailwind.css";
{%- if ui_library == 'claddcn' %}
@import "./claddcn.css";
{%- endif %}
@custom-variant dark (&:is(.dark *));
:root {
{% if ui_library == 'shadcn' %}:root {
--radius: 0.625rem;
--background: oklch(1 0 0);
--foreground: oklch(0.145 0 0);
@@ -100,7 +103,7 @@
--color-sidebar-ring: var(--sidebar-ring);
}
@layer base {
{% endif %}@layer base {
* {
@apply border-border outline-ring/50;
}
@@ -1,36 +0,0 @@
{% if frontend_adapter == 'bun' -%}
import adapter from "svelte-adapter-bun";
/** @type {import('@sveltejs/kit').Config} */
const config = {
compilerOptions: {
runes: ({ filename }) =>
{% if linter == 'biome' %} // biome-ignore lint/performance/useTopLevelRegex: svelte default behaviour
{% endif %} filename.split(/[/\\]/).includes("node_modules") ? undefined : true,
},
kit: {
adapter: adapter(),
},
};
export default config;
{%- else -%}
import adapter from "@sveltejs/adapter-static";
import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
/** @type {import('@sveltejs/kit').Config} */
const config = {
kit: {
adapter: adapter({
assets: "build",
fallback: "index.html",
pages: "build",
precompress: false,
strict: false,
}),
},
preprocess: vitePreprocess(),
};
export default config;
{%- endif %}
+4 -15
View File
@@ -1,20 +1,9 @@
{
"extends": "./.svelte-kit/tsconfig.json",
"extends": "$app/tsconfig",
"compilerOptions": {
"rewriteRelativeImportExtensions": true,
"allowJs": true,
"checkJs": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"resolveJsonModule": true,
"skipLibCheck": true,
"sourceMap": true,
"strict": true,
"moduleResolution": "bundler"
}
// Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias
// except $lib which is handled by https://svelte.dev/docs/kit/configuration#files
//
// To make changes to top-level options such as include and exclude, we recommend extending
// the generated config; see https://svelte.dev/docs/kit/configuration#typescript
"strict": true
},
"include": ["src", "vite.config.ts"]
}
-20
View File
@@ -1,20 +0,0 @@
import { sveltekit } from "@sveltejs/kit/vite";
import tailwindcss from "@tailwindcss/vite";
import { defineConfig } from "vite";
const allowedHosts = process.env.ALLOWED_HOSTS
? process.env.ALLOWED_HOSTS.split(",")
: undefined;
export default defineConfig({
plugins: [tailwindcss(), sveltekit()],
server: {
allowedHosts,
proxy: {
"/api": {
changeOrigin: true,
target: process.env.API_PROXY_TARGET ?? "http://localhost:8080",
},
},
},
});
@@ -0,0 +1,51 @@
{% if frontend_adapter == 'bun' -%}
import adapter from "@sveltejs/adapter-bun";
import { sveltekit } from "@sveltejs/kit/vite";
import tailwindcss from "@tailwindcss/vite";
import { defineConfig } from "vite";
const PATH_SEP = /[/\\]/;
{%- else -%}
import adapter from "@sveltejs/adapter-static";
import { sveltekit } from "@sveltejs/kit/vite";
import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
import tailwindcss from "@tailwindcss/vite";
import { defineConfig } from "vite";
{%- endif %}
const allowedHosts = process.env.ALLOWED_HOSTS
? process.env.ALLOWED_HOSTS.split(",")
: undefined;
export default defineConfig({
plugins: [
tailwindcss(),
sveltekit({
{%- if frontend_adapter == 'bun' %}
adapter: adapter(),
compilerOptions: {
runes: ({ filename }) =>
filename.split(PATH_SEP).includes("node_modules") ? undefined : true,
},
{%- else %}
adapter: adapter({
assets: "build",
fallback: "index.html",
pages: "build",
precompress: false,
strict: false,
}),
preprocess: [vitePreprocess()],
{%- endif %}
}),
],
server: {
allowedHosts,
proxy: {
"/api": {
changeOrigin: true,
target: process.env.API_PROXY_TARGET ?? "http://localhost:8080",
},
},
},
});
@@ -2,16 +2,22 @@
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"extends": ["ultracite/biome/core", "ultracite/biome/svelte"],
"files": {
{%- if ui_library == 'none' %}
"includes": ["!.claude", "!.svelte-kit", "!build", "!.mcp.json"]
{%- else %}
"includes": [
"!.claude",
"!.svelte-kit",
"!build",
"!.mcp.json",
"!src/lib/components/ui"{% if ui_library == 'claddcn' %},
"!src/routes/claddcn.css"{% endif %}
]
{%- endif %}
},
"javascript": { "globals": ["Bun"] },
"overrides": [
{%- if ui_library == 'shadcn' %}
{
"includes": ["src/lib/components/ui/**"],
"linter": { "enabled": false },
"assist": { "enabled": false }
},
{%- if ui_library != 'none' %}
{
"includes": ["src/lib/utils.ts"],
"linter": { "rules": { "suspicious": { "noExplicitAny": "off" } } }
@@ -21,6 +27,7 @@
"includes": ["**/*.svelte"],
"linter": {
"rules": {
"a11y": { "useAnchorContent": "off" },
"style": {
"useFilenamingConvention": {
"level": "error",
@@ -6,10 +6,20 @@ import svelte from "eslint-plugin-svelte";
import { defineConfig } from "eslint/config";
import globals from "globals";
import ts from "typescript-eslint";
import svelteConfig from "./svelte.config.js";
const gitignorePath = fileURLToPath(new URL("./.gitignore", import.meta.url));
{% if frontend_adapter == 'bun' -%}
const svelteConfig = {
compilerOptions: {
runes: ({ filename }) =>
filename.split(/[/\\]/).includes("node_modules") ? undefined : true,
},
};
{%- else -%}
const svelteConfig = {};
{%- endif %}
export default defineConfig(
includeIgnoreFile(gitignorePath),
js.configs.recommended,
@@ -25,10 +35,10 @@ export default defineConfig(
"no-undef": "off",
},
},
{%- if ui_library == 'shadcn' %}
{%- if ui_library != 'none' %}
{
// shadcn-svelte primitives are copied in and changed upstream only.
files: ["src/lib/components/ui/**"],
files: ["src/lib/components/ui/**"{% if ui_library == 'shadcn' %}, "src/lib/utils.ts"{% endif %}],
rules: {
"@typescript-eslint/no-explicit-any": "off",
"svelte/no-navigation-without-resolve": "off",
@@ -1,5 +1,5 @@
{% if frontend_adapter == 'bun' -%}
FROM oven/bun:alpine AS deps
FROM oven/bun:1-alpine AS deps
ENV TERM=xterm-256color
ENV COLORTERM=truecolor
@@ -22,7 +22,7 @@ RUN bun --bun svelte-kit sync
RUN bun --bun run build
FROM oven/bun:alpine AS runtime
FROM oven/bun:1-alpine AS runtime
ENV NODE_ENV=production
# The cache mount only holds files; without the variable bun caches into
@@ -42,7 +42,7 @@ EXPOSE 3000
ENTRYPOINT ["bun"]
CMD ["build/index.js"]
{%- else -%}
FROM oven/bun:alpine AS deps
FROM oven/bun:1-alpine AS deps
ENV TERM=xterm-256color
ENV COLORTERM=truecolor
@@ -63,7 +63,7 @@ RUN bun --bun svelte-kit sync
RUN bun run build
FROM oven/bun:alpine AS runtime
FROM oven/bun:1-alpine AS runtime
ENV NODE_ENV=production
@@ -5,11 +5,11 @@
"baseColor": "neutral"
},
"aliases": {
"components": "$lib/components",
"utils": "$lib/utils",
"ui": "$lib/components/ui",
"hooks": "$lib/hooks",
"lib": "$lib"
"components": "#lib/components",
"utils": "#lib/utils",
"ui": "#lib/components/ui",
"hooks": "#lib/hooks",
"lib": "#lib"
},
"typescript": true,
"registry": "https://shadcn-svelte.com/registry",