oscillatory.net
Markdown -> Semble importer
Scaffold Svelte TypeScript app with Vite
+24
.gitignore
+24
.gitignore
···
1
+
# Logs
2
+
logs
3
+
*.log
4
+
npm-debug.log*
5
+
yarn-debug.log*
6
+
yarn-error.log*
7
+
pnpm-debug.log*
8
+
lerna-debug.log*
9
+
10
+
node_modules
11
+
dist
12
+
dist-ssr
13
+
*.local
14
+
15
+
# Editor directories and files
16
+
.vscode/*
17
+
!.vscode/extensions.json
18
+
.idea
19
+
.DS_Store
20
+
*.suo
21
+
*.ntvs*
22
+
*.njsproj
23
+
*.sln
24
+
*.sw?
+47
README.md
+47
README.md
···
1
+
# Svelte + TS + Vite
2
+
3
+
This template should help get you started developing with Svelte and TypeScript in Vite.
4
+
5
+
## Recommended IDE Setup
6
+
7
+
[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
8
+
9
+
## Need an official Svelte framework?
10
+
11
+
Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
12
+
13
+
## Technical considerations
14
+
15
+
**Why use this over SvelteKit?**
16
+
17
+
- It brings its own routing solution which might not be preferable for some users.
18
+
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
19
+
20
+
This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
21
+
22
+
Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
23
+
24
+
**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
25
+
26
+
Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
27
+
28
+
**Why include `.vscode/extensions.json`?**
29
+
30
+
Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
31
+
32
+
**Why enable `allowJs` in the TS template?**
33
+
34
+
While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
35
+
36
+
**Why is HMR not preserving my local component state?**
37
+
38
+
HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
39
+
40
+
If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
41
+
42
+
```ts
43
+
// store.ts
44
+
// An extremely simple external store
45
+
import { writable } from 'svelte/store'
46
+
export default writable(0)
47
+
```
+13
index.html
+13
index.html
···
1
+
<!doctype html>
2
+
<html lang="en">
3
+
<head>
4
+
<meta charset="UTF-8" />
5
+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7
+
<title>md-semble-sync</title>
8
+
</head>
9
+
<body>
10
+
<div id="app"></div>
11
+
<script type="module" src="/src/main.ts"></script>
12
+
</body>
13
+
</html>
+21
package.json
+21
package.json
···
1
+
{
2
+
"name": "md-semble-sync",
3
+
"private": true,
4
+
"version": "0.0.0",
5
+
"type": "module",
6
+
"scripts": {
7
+
"dev": "vite",
8
+
"build": "vite build",
9
+
"preview": "vite preview",
10
+
"check": "svelte-check --tsconfig ./tsconfig.app.json && tsc -p tsconfig.node.json"
11
+
},
12
+
"devDependencies": {
13
+
"@sveltejs/vite-plugin-svelte": "^6.2.1",
14
+
"@tsconfig/svelte": "^5.0.6",
15
+
"@types/node": "^24.10.1",
16
+
"svelte": "^5.43.8",
17
+
"svelte-check": "^4.3.4",
18
+
"typescript": "~5.9.3",
19
+
"vite": "^7.2.4"
20
+
}
21
+
}
+1
public/vite.svg
+1
public/vite.svg
···
1
+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
+47
src/App.svelte
+47
src/App.svelte
···
1
+
<script lang="ts">
2
+
import svelteLogo from './assets/svelte.svg'
3
+
import viteLogo from '/vite.svg'
4
+
import Counter from './lib/Counter.svelte'
5
+
</script>
6
+
7
+
<main>
8
+
<div>
9
+
<a href="https://vite.dev" target="_blank" rel="noreferrer">
10
+
<img src={viteLogo} class="logo" alt="Vite Logo" />
11
+
</a>
12
+
<a href="https://svelte.dev" target="_blank" rel="noreferrer">
13
+
<img src={svelteLogo} class="logo svelte" alt="Svelte Logo" />
14
+
</a>
15
+
</div>
16
+
<h1>Vite + Svelte</h1>
17
+
18
+
<div class="card">
19
+
<Counter />
20
+
</div>
21
+
22
+
<p>
23
+
Check out <a href="https://github.com/sveltejs/kit#readme" target="_blank" rel="noreferrer">SvelteKit</a>, the official Svelte app framework powered by Vite!
24
+
</p>
25
+
26
+
<p class="read-the-docs">
27
+
Click on the Vite and Svelte logos to learn more
28
+
</p>
29
+
</main>
30
+
31
+
<style>
32
+
.logo {
33
+
height: 6em;
34
+
padding: 1.5em;
35
+
will-change: filter;
36
+
transition: filter 300ms;
37
+
}
38
+
.logo:hover {
39
+
filter: drop-shadow(0 0 2em #646cffaa);
40
+
}
41
+
.logo.svelte:hover {
42
+
filter: drop-shadow(0 0 2em #ff3e00aa);
43
+
}
44
+
.read-the-docs {
45
+
color: #888;
46
+
}
47
+
</style>
+79
src/app.css
+79
src/app.css
···
1
+
:root {
2
+
font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
3
+
line-height: 1.5;
4
+
font-weight: 400;
5
+
6
+
color-scheme: light dark;
7
+
color: rgba(255, 255, 255, 0.87);
8
+
background-color: #242424;
9
+
10
+
font-synthesis: none;
11
+
text-rendering: optimizeLegibility;
12
+
-webkit-font-smoothing: antialiased;
13
+
-moz-osx-font-smoothing: grayscale;
14
+
}
15
+
16
+
a {
17
+
font-weight: 500;
18
+
color: #646cff;
19
+
text-decoration: inherit;
20
+
}
21
+
a:hover {
22
+
color: #535bf2;
23
+
}
24
+
25
+
body {
26
+
margin: 0;
27
+
display: flex;
28
+
place-items: center;
29
+
min-width: 320px;
30
+
min-height: 100vh;
31
+
}
32
+
33
+
h1 {
34
+
font-size: 3.2em;
35
+
line-height: 1.1;
36
+
}
37
+
38
+
.card {
39
+
padding: 2em;
40
+
}
41
+
42
+
#app {
43
+
max-width: 1280px;
44
+
margin: 0 auto;
45
+
padding: 2rem;
46
+
text-align: center;
47
+
}
48
+
49
+
button {
50
+
border-radius: 8px;
51
+
border: 1px solid transparent;
52
+
padding: 0.6em 1.2em;
53
+
font-size: 1em;
54
+
font-weight: 500;
55
+
font-family: inherit;
56
+
background-color: #1a1a1a;
57
+
cursor: pointer;
58
+
transition: border-color 0.25s;
59
+
}
60
+
button:hover {
61
+
border-color: #646cff;
62
+
}
63
+
button:focus,
64
+
button:focus-visible {
65
+
outline: 4px auto -webkit-focus-ring-color;
66
+
}
67
+
68
+
@media (prefers-color-scheme: light) {
69
+
:root {
70
+
color: #213547;
71
+
background-color: #ffffff;
72
+
}
73
+
a:hover {
74
+
color: #747bff;
75
+
}
76
+
button {
77
+
background-color: #f9f9f9;
78
+
}
79
+
}
+1
src/assets/svelte.svg
+1
src/assets/svelte.svg
···
1
+
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="26.6" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 308"><path fill="#FF3E00" d="M239.682 40.707C211.113-.182 154.69-12.301 113.895 13.69L42.247 59.356a82.198 82.198 0 0 0-37.135 55.056a86.566 86.566 0 0 0 8.536 55.576a82.425 82.425 0 0 0-12.296 30.719a87.596 87.596 0 0 0 14.964 66.244c28.574 40.893 84.997 53.007 125.787 27.016l71.648-45.664a82.182 82.182 0 0 0 37.135-55.057a86.601 86.601 0 0 0-8.53-55.577a82.409 82.409 0 0 0 12.29-30.718a87.573 87.573 0 0 0-14.963-66.244"></path><path fill="#FFF" d="M106.889 270.841c-23.102 6.007-47.497-3.036-61.103-22.648a52.685 52.685 0 0 1-9.003-39.85a49.978 49.978 0 0 1 1.713-6.693l1.35-4.115l3.671 2.697a92.447 92.447 0 0 0 28.036 14.007l2.663.808l-.245 2.659a16.067 16.067 0 0 0 2.89 10.656a17.143 17.143 0 0 0 18.397 6.828a15.786 15.786 0 0 0 4.403-1.935l71.67-45.672a14.922 14.922 0 0 0 6.734-9.977a15.923 15.923 0 0 0-2.713-12.011a17.156 17.156 0 0 0-18.404-6.832a15.78 15.78 0 0 0-4.396 1.933l-27.35 17.434a52.298 52.298 0 0 1-14.553 6.391c-23.101 6.007-47.497-3.036-61.101-22.649a52.681 52.681 0 0 1-9.004-39.849a49.428 49.428 0 0 1 22.34-33.114l71.664-45.677a52.218 52.218 0 0 1 14.563-6.398c23.101-6.007 47.497 3.036 61.101 22.648a52.685 52.685 0 0 1 9.004 39.85a50.559 50.559 0 0 1-1.713 6.692l-1.35 4.116l-3.67-2.693a92.373 92.373 0 0 0-28.037-14.013l-2.664-.809l.246-2.658a16.099 16.099 0 0 0-2.89-10.656a17.143 17.143 0 0 0-18.398-6.828a15.786 15.786 0 0 0-4.402 1.935l-71.67 45.674a14.898 14.898 0 0 0-6.73 9.975a15.9 15.9 0 0 0 2.709 12.012a17.156 17.156 0 0 0 18.404 6.832a15.841 15.841 0 0 0 4.402-1.935l27.345-17.427a52.147 52.147 0 0 1 14.552-6.397c23.101-6.006 47.497 3.037 61.102 22.65a52.681 52.681 0 0 1 9.003 39.848a49.453 49.453 0 0 1-22.34 33.12l-71.664 45.673a52.218 52.218 0 0 1-14.563 6.398"></path></svg>
+10
src/lib/Counter.svelte
+10
src/lib/Counter.svelte
+9
src/main.ts
+9
src/main.ts
+8
svelte.config.js
+8
svelte.config.js
···
1
+
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'
2
+
3
+
/** @type {import("@sveltejs/vite-plugin-svelte").SvelteConfig} */
4
+
export default {
5
+
// Consult https://svelte.dev/docs#compile-time-svelte-preprocess
6
+
// for more information about preprocessors
7
+
preprocess: vitePreprocess(),
8
+
}
+21
tsconfig.app.json
+21
tsconfig.app.json
···
1
+
{
2
+
"extends": "@tsconfig/svelte/tsconfig.json",
3
+
"compilerOptions": {
4
+
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
5
+
"target": "ES2022",
6
+
"useDefineForClassFields": true,
7
+
"module": "ESNext",
8
+
"types": ["svelte", "vite/client"],
9
+
"noEmit": true,
10
+
/**
11
+
* Typecheck JS in `.svelte` and `.js` files by default.
12
+
* Disable checkJs if you'd like to use dynamic types in JS.
13
+
* Note that setting allowJs false does not prevent the use
14
+
* of JS in `.svelte` files.
15
+
*/
16
+
"allowJs": true,
17
+
"checkJs": true,
18
+
"moduleDetection": "force"
19
+
},
20
+
"include": ["src/**/*.ts", "src/**/*.js", "src/**/*.svelte"]
21
+
}
+7
tsconfig.json
+7
tsconfig.json
+26
tsconfig.node.json
+26
tsconfig.node.json
···
1
+
{
2
+
"compilerOptions": {
3
+
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
4
+
"target": "ES2023",
5
+
"lib": ["ES2023"],
6
+
"module": "ESNext",
7
+
"types": ["node"],
8
+
"skipLibCheck": true,
9
+
10
+
/* Bundler mode */
11
+
"moduleResolution": "bundler",
12
+
"allowImportingTsExtensions": true,
13
+
"verbatimModuleSyntax": true,
14
+
"moduleDetection": "force",
15
+
"noEmit": true,
16
+
17
+
/* Linting */
18
+
"strict": true,
19
+
"noUnusedLocals": true,
20
+
"noUnusedParameters": true,
21
+
"erasableSyntaxOnly": true,
22
+
"noFallthroughCasesInSwitch": true,
23
+
"noUncheckedSideEffectImports": true
24
+
},
25
+
"include": ["vite.config.ts"]
26
+
}