feat: 初始化 SvelteKit 项目基础结构和示例组件

- 添加项目配置文件(.npmrc, pnpm-workspace.yaml, prettier 配置等)
- 设置基础路由和布局组件
- 实现示例组件展示 Svelte 5 新特性($state, $derived 等)
- 配置测试环境(单元测试和 E2E 测试)
- 添加静态资源和 favicon
This commit is contained in:
lirui
2026-01-14 17:39:00 +08:00
commit 39d8630e87
26 changed files with 2955 additions and 0 deletions

24
.gitignore vendored Normal file
View File

@@ -0,0 +1,24 @@
test-results
node_modules
# Output
.output
.vercel
.netlify
.wrangler
/.svelte-kit
/build
# OS
.DS_Store
Thumbs.db
# Env
.env
.env.*
!.env.example
!.env.test
# Vite
vite.config.js.timestamp-*
vite.config.ts.timestamp-*

1
.npmrc Normal file
View File

@@ -0,0 +1 @@
engine-strict=true

9
.prettierignore Normal file
View File

@@ -0,0 +1,9 @@
# Package Managers
package-lock.json
pnpm-lock.yaml
yarn.lock
bun.lock
bun.lockb
# Miscellaneous
/static/

15
.prettierrc Normal file
View File

@@ -0,0 +1,15 @@
{
"useTabs": true,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"plugins": ["prettier-plugin-svelte"],
"overrides": [
{
"files": "*.svelte",
"options": {
"parser": "svelte"
}
}
]
}

38
README.md Normal file
View File

@@ -0,0 +1,38 @@
# sv
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
## Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```sh
# create a new project in the current directory
npx sv create
# create a new project in my-app
npx sv create my-app
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```sh
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
To create a production version of your app:
```sh
npm run build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

6
e2e/demo.test.ts Normal file
View File

@@ -0,0 +1,6 @@
import { expect, test } from '@playwright/test';
test('home page has expected h1', async ({ page }) => {
await page.goto('/');
await expect(page.locator('h1')).toBeVisible();
});

41
eslint.config.js Normal file
View File

@@ -0,0 +1,41 @@
import prettier from 'eslint-config-prettier';
import { fileURLToPath } from 'node:url';
import { includeIgnoreFile } from '@eslint/compat';
import js from '@eslint/js';
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));
export default defineConfig(
includeIgnoreFile(gitignorePath),
js.configs.recommended,
...ts.configs.recommended,
...svelte.configs.recommended,
prettier,
...svelte.configs.prettier,
{
languageOptions: { globals: { ...globals.browser, ...globals.node } },
rules: {
// typescript-eslint strongly recommend that you do not use the no-undef lint rule on TypeScript projects.
// see: https://typescript-eslint.io/troubleshooting/faqs/eslint/#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
'no-undef': 'off'
}
},
{
files: ['**/*.svelte', '**/*.svelte.ts', '**/*.svelte.js'],
languageOptions: {
parserOptions: {
projectService: true,
extraFileExtensions: ['.svelte'],
parser: ts.parser,
svelteConfig
}
}
}
);

44
package.json Normal file
View File

@@ -0,0 +1,44 @@
{
"name": "svelete-learn",
"private": true,
"version": "0.0.1",
"type": "module",
"scripts": {
"dev": "vite dev",
"build": "vite build",
"preview": "vite preview",
"prepare": "svelte-kit sync || echo ''",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"format": "prettier --write .",
"lint": "prettier --check . && eslint .",
"test:unit": "vitest",
"test": "npm run test:unit -- --run && npm run test:e2e",
"test:e2e": "playwright test"
},
"devDependencies": {
"@eslint/compat": "^1.4.0",
"@eslint/js": "^9.39.1",
"@playwright/test": "^1.57.0",
"@sveltejs/adapter-auto": "^7.0.0",
"@sveltejs/kit": "^2.49.1",
"@sveltejs/vite-plugin-svelte": "^6.2.1",
"@types/node": "^24",
"@vitest/browser-playwright": "^4.0.15",
"eslint": "^9.39.1",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-svelte": "^3.13.1",
"globals": "^16.5.0",
"playwright": "^1.57.0",
"prettier": "^3.7.4",
"prettier-plugin-svelte": "^3.4.0",
"svelte": "^5.45.6",
"svelte-check": "^4.3.4",
"typescript": "^5.9.3",
"typescript-eslint": "^8.48.1",
"vite": "^7.2.6",
"vite-plugin-devtools-json": "^1.0.0",
"vitest": "^4.0.15",
"vitest-browser-svelte": "^2.0.1"
}
}

6
playwright.config.ts Normal file
View File

@@ -0,0 +1,6 @@
import { defineConfig } from '@playwright/test';
export default defineConfig({
webServer: { command: 'npm run build && npm run preview', port: 4173 },
testDir: 'e2e'
});

2445
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

2
pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1,2 @@
onlyBuiltDependencies:
- esbuild

13
src/app.d.ts vendored Normal file
View File

@@ -0,0 +1,13 @@
// See https://svelte.dev/docs/kit/types#app.d.ts
// for information about these interfaces
declare global {
namespace App {
// interface Error {}
// interface Locals {}
// interface PageData {}
// interface PageState {}
// interface Platform {}
}
}
export {};

11
src/app.html Normal file
View File

@@ -0,0 +1,11 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
%sveltekit.head%
</head>
<body data-sveltekit-preload-data="hover">
<div style="display: contents">%sveltekit.body%</div>
</body>
</html>

7
src/demo.spec.ts Normal file
View File

@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';
describe('sum test', () => {
it('adds 1 + 2 to equal 3', () => {
expect(1 + 2).toBe(3);
});
});

View File

@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="107" height="128" viewBox="0 0 107 128"><title>svelte-logo</title><path d="M94.157 22.819c-10.4-14.885-30.94-19.297-45.792-9.835L22.282 29.608A29.92 29.92 0 0 0 8.764 49.65a31.5 31.5 0 0 0 3.108 20.231 30 30 0 0 0-4.477 11.183 31.9 31.9 0 0 0 5.448 24.116c10.402 14.887 30.942 19.297 45.791 9.835l26.083-16.624A29.92 29.92 0 0 0 98.235 78.35a31.53 31.53 0 0 0-3.105-20.232 30 30 0 0 0 4.474-11.182 31.88 31.88 0 0 0-5.447-24.116" style="fill:#ff3e00"/><path d="M45.817 106.582a20.72 20.72 0 0 1-22.237-8.243 19.17 19.17 0 0 1-3.277-14.503 18 18 0 0 1 .624-2.435l.49-1.498 1.337.981a33.6 33.6 0 0 0 10.203 5.098l.97.294-.09.968a5.85 5.85 0 0 0 1.052 3.878 6.24 6.24 0 0 0 6.695 2.485 5.8 5.8 0 0 0 1.603-.704L69.27 76.28a5.43 5.43 0 0 0 2.45-3.631 5.8 5.8 0 0 0-.987-4.371 6.24 6.24 0 0 0-6.698-2.487 5.7 5.7 0 0 0-1.6.704l-9.953 6.345a19 19 0 0 1-5.296 2.326 20.72 20.72 0 0 1-22.237-8.243 19.17 19.17 0 0 1-3.277-14.502 17.99 17.99 0 0 1 8.13-12.052l26.081-16.623a19 19 0 0 1 5.3-2.329 20.72 20.72 0 0 1 22.237 8.243 19.17 19.17 0 0 1 3.277 14.503 18 18 0 0 1-.624 2.435l-.49 1.498-1.337-.98a33.6 33.6 0 0 0-10.203-5.1l-.97-.294.09-.968a5.86 5.86 0 0 0-1.052-3.878 6.24 6.24 0 0 0-6.696-2.485 5.8 5.8 0 0 0-1.602.704L37.73 51.72a5.42 5.42 0 0 0-2.449 3.63 5.79 5.79 0 0 0 .986 4.372 6.24 6.24 0 0 0 6.698 2.486 5.8 5.8 0 0 0 1.602-.704l9.952-6.342a19 19 0 0 1 5.295-2.328 20.72 20.72 0 0 1 22.237 8.242 19.17 19.17 0 0 1 3.277 14.503 18 18 0 0 1-8.13 12.053l-26.081 16.622a19 19 0 0 1-5.3 2.328" style="fill:#fff"/></svg>

After

Width:  |  Height:  |  Size: 1.5 KiB

View File

@@ -0,0 +1,67 @@
<script>
import { untrack } from 'svelte';
let { posts = [] } = $props();
let index = $state(0);
let selected = $derived(posts[Number(index)]);
let count = $state(0);
let double = $derived(count * 2);
let array = $state([1, 2, 3, 4, 5, 6, 7]);
let total = $derived.by(() => {
let total = 0;
for (let i = 0; i < array.length; i++) {
total += array[i];
}
return total;
});
let totalWithoutComputed = $derived.by(() => {
return untrack(() => {
let total = 0;
for (let i = 0; i < array.length; i++) {
total += array[i];
}
return total;
});
});
</script>
<button
onclick={() => {
count++;
}}>click to double</button
>
<button
onclick={() => {
array.push(5);
}}>Click to add 5 into array list</button
>
<h2>count: {count}</h2>
<h2>double: {double}</h2>
<h2>total: {total}</h2>
<h2>totalWithoutComputed: {totalWithoutComputed}</h2>
<!-- // for -->
<h2>posts:</h2>
<ul>
{#each posts as post}
<li>{post.content} - {post.likes} <button onclick={() => {
post.likes++;
}}>👍like</button></li>
{/each}
</ul>
<h2>选择帖子</h2>
{#if posts.length}
<select bind:value={index}>
{#each posts as p, i}
<option value={i}>{p.content} - {p.likes}</option>
{/each}
</select>
<div>
<h3>当前选择: {selected.content} - {selected.likes}</h3>
<input bind:value={selected.content} placeholder="编辑内容" />
<button onclick={() => { selected.likes++; }}>👍like 当前选择</button>
</div>
{/if}

View File

@@ -0,0 +1,56 @@
<script>
// $state 使用 默认是深度响应式
let count = $state(0);
let todos = $state([
{ id: 1, text: 'Learn Svelte', done: true },
{ id: 2, text: 'Build a Svelte app', done: false },
{ id: 3, text: 'Ship the app', done: false }
]);
function addTodo() {
todos = [...todos, { id: todos.length + 1, text: `New Todo ${todos.length + 1}`, done: false }];
}
// $state.raw 使用浅层响应式
let person = $state.raw({
name: 'Heraclitus',
age: 49
});
// $state.snapshop 使用场景:
// 很多第三方库不接受 Proxy 对象,比如 structuredClone、postMessage、localStorage、fetch body 等。
let counter2 = $state({ count: 0 }); // PROXY OBJECT
let counter3 = $state.snapshot(counter2); // { count: 0 }
console.log('counter2', counter2); //
console.log('counter3', counter3); //
</script>
<h1>My Component</h1>
<div>
<h3>计数器示例:</h3>
<button onclick={() => count++}>count: {count}</button>
</div>
<div>
<h3>待办事项列表:</h3>
<ul>
{#each todos as todo}
<li>
{todo.text}
{#if todo.done}
{/if}
</li>
{/each}
</ul>
<button onclick={addTodo}>添加新待办</button>
</div>
<!--
浅层响应式 只能给对象重新赋值才能修改里面的值,不能直接修改对象里面的值
-->
<div>
<h3>person: {person.name}, {person.age}</h3>
<button onclick={() => person.age++}>age++</button>
<button onclick={() => (person = { name: 'Heraclitus', age: person.age + 1 })}>age++</button>
</div>

View File

@@ -0,0 +1,34 @@
<script>
const countObj = {
count: 0
};
const proxy = new Proxy(countObj, {
get(target, prop) {
console.log('GET:', target, prop);
return target[prop];
},
set(target, prop, value) {
console.log('SET:', target, prop, value);
target[prop] = value;
return true;
}
});
console.log('初始值:', proxy.count);
</script>
<div>
<h2>Proxy 原理学习</h2>
<p>打开浏览器控制台查看 Proxy 的 get 和 set 拦截</p>
<button onclick={() => proxy.count++}>count: {proxy.count}</button>
<p>注意:虽然 Proxy 能拦截操作,但在 Svelte 中不会自动触发 UI 更新</p>
</div>
<style>
div {
padding: 1rem;
border: 2px solid #ff3e00;
border-radius: 8px;
margin: 1rem 0;
}
</style>

1
src/lib/index.ts Normal file
View File

@@ -0,0 +1 @@
// place files you want to import through the `$lib` alias in this folder.

11
src/routes/+layout.svelte Normal file
View File

@@ -0,0 +1,11 @@
<script lang="ts">
import favicon from '$lib/assets/favicon.svg';
let { children } = $props();
</script>
<svelte:head>
<link rel="icon" href={favicon} />
</svelte:head>
{@render children()}

27
src/routes/+page.svelte Normal file
View File

@@ -0,0 +1,27 @@
<script>
import DerivedComponent from '$lib/components/DerivedComponent.svelte';
import MyComponent from '$lib/components/MyComponent.svelte';
import TestComponent from '$lib/components/TestComponent.svelte';
let posts = $state([
{
content: 'hello',
likes: 1
},
{
content: 'world',
likes: 3
},
{
content: 'leran svelte',
likes: 5
}
]);
</script>
<h1>Welcome to SvelteKit</h1>
<p>Visit <a href="https://svelte.dev/docs/kit">svelte.dev/docs/kit</a> to read the documentation</p>
<div>
<h2>我的自定义组件:</h2>
<DerivedComponent posts={posts} />
</div>

View File

@@ -0,0 +1,13 @@
import { page } from 'vitest/browser';
import { describe, expect, it } from 'vitest';
import { render } from 'vitest-browser-svelte';
import Page from './+page.svelte';
describe('/+page.svelte', () => {
it('should render h1', async () => {
render(Page);
const heading = page.getByRole('heading', { level: 1 });
await expect.element(heading).toBeInTheDocument();
});
});

3
static/robots.txt Normal file
View File

@@ -0,0 +1,3 @@
# allow crawling everything by default
User-agent: *
Disallow:

18
svelte.config.js Normal file
View File

@@ -0,0 +1,18 @@
import adapter from '@sveltejs/adapter-auto';
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
/** @type {import('@sveltejs/kit').Config} */
const config = {
// Consult https://svelte.dev/docs/kit/integrations
// for more information about preprocessors
preprocess: vitePreprocess(),
kit: {
// adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
// If your environment is not supported, or you settled on a specific environment, switch out the adapter.
// See https://svelte.dev/docs/kit/adapters for more information about adapters.
adapter: adapter()
}
};
export default config;

20
tsconfig.json Normal file
View File

@@ -0,0 +1,20 @@
{
"extends": "./.svelte-kit/tsconfig.json",
"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
}

42
vite.config.ts Normal file
View File

@@ -0,0 +1,42 @@
import devtoolsJson from 'vite-plugin-devtools-json';
import { defineConfig } from 'vitest/config';
import { playwright } from '@vitest/browser-playwright';
import { sveltekit } from '@sveltejs/kit/vite';
export default defineConfig({
plugins: [sveltekit(), devtoolsJson()],
test: {
expect: { requireAssertions: true },
projects: [
{
extends: './vite.config.ts',
test: {
name: 'client',
browser: {
enabled: true,
provider: playwright(),
instances: [{ browser: 'chromium', headless: true }]
},
include: ['src/**/*.svelte.{test,spec}.{js,ts}'],
exclude: ['src/lib/server/**']
}
},
{
extends: './vite.config.ts',
test: {
name: 'server',
environment: 'node',
include: ['src/**/*.{test,spec}.{js,ts}'],
exclude: ['src/**/*.svelte.{test,spec}.{js,ts}']
}
}
]
}
});