Skip to content

Commit

Permalink
svelte
Browse files Browse the repository at this point in the history
  • Loading branch information
sidmohanty11 committed May 20, 2024
1 parent 114e190 commit b93baca
Show file tree
Hide file tree
Showing 19 changed files with 318 additions and 19 deletions.
1 change: 0 additions & 1 deletion packages/sdks/snippets/angular-ssr/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"@angular/router": "^16.2.0",
"@builder.io/sdk-angular": "workspace:*",
"@nguniversal/express-engine": "^16.2.0",
"@sdk/tests": "workspace:*",
"domhandler": "^5.0.3",
"express": "^4.15.2",
"rxjs": "~7.8.0",
Expand Down
1 change: 0 additions & 1 deletion packages/sdks/snippets/angular/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"@angular/platform-browser-dynamic": "^16.2.0",
"@angular/router": "^16.2.0",
"@builder.io/sdk-angular": "workspace:*",
"@sdk/tests": "workspace:*",
"rxjs": "~7.8.0",
"tslib": "^2.3.0",
"zone.js": "~0.13.0"
Expand Down
1 change: 0 additions & 1 deletion packages/sdks/snippets/nextjs-app-dir-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
},
"dependencies": {
"@builder.io/sdk-react": "workspace:*",
"@sdk/tests": "workspace:*",
"next": "14.2.3",
"react": "^18",
"react-dom": "^18"
Expand Down
1 change: 0 additions & 1 deletion packages/sdks/snippets/nextjs-app-dir/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
},
"dependencies": {
"@builder.io/sdk-react-nextjs": "workspace:*",
"@sdk/tests": "workspace:*",
"next": "14.2.3",
"react": "^18",
"react-dom": "^18"
Expand Down
1 change: 0 additions & 1 deletion packages/sdks/snippets/nextjs-pages-dir/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
},
"dependencies": {
"@builder.io/sdk-react": "workspace:*",
"@sdk/tests": "workspace:*",
"next": "14.2.3",
"react": "^18",
"react-dom": "^18"
Expand Down
3 changes: 1 addition & 2 deletions packages/sdks/snippets/qwik-city/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@
"test": "SERVER_NAME=qwik-city yarn nx test:snippet @sdk/tests"
},
"dependencies": {
"@builder.io/sdk-qwik": "workspace:*",
"@sdk/tests": "workspace:*"
"@builder.io/sdk-qwik": "workspace:*"
},
"devDependencies": {
"@builder.io/qwik": "^1.5.4",
Expand Down
1 change: 0 additions & 1 deletion packages/sdks/snippets/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
},
"dependencies": {
"@builder.io/sdk-react": "workspace:*",
"@sdk/tests": "workspace:*",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
24 changes: 24 additions & 0 deletions packages/sdks/snippets/svelte/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
47 changes: 47 additions & 0 deletions packages/sdks/snippets/svelte/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Svelte + TS + Vite

This template should help get you started developing with Svelte and TypeScript in Vite.

## Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).

## Need an official Svelte framework?

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.

## Technical considerations

**Why use this over SvelteKit?**

- It brings its own routing solution which might not be preferable for some users.
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.

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.

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.

**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**

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.

**Why include `.vscode/extensions.json`?**

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.

**Why enable `allowJs` in the TS template?**

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.

**Why is HMR not preserving my local component state?**

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).

If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.

```ts
// store.ts
// An extremely simple external store
import { writable } from 'svelte/store'
export default writable(0)
```
13 changes: 13 additions & 0 deletions packages/sdks/snippets/svelte/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + Svelte + TS</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.ts"></script>
</body>
</html>
26 changes: 26 additions & 0 deletions packages/sdks/snippets/svelte/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"name": "@snippet/svelte",
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"serve": "vite preview",
"test": "SERVER_NAME=svelte yarn nx test:snippet @sdk/tests",
"check": "SDK_ENV=browser svelte-check --tsconfig ./tsconfig.json"
},
"dependencies": {
"@builder.io/sdk-svelte": "workspace:*"
},
"devDependencies": {
"@sveltejs/vite-plugin-svelte": "^3.0.2",
"@tsconfig/svelte": "^5.0.2",
"svelte": "^4.2.12",
"svelte-check": "^3.6.7",
"tslib": "^2.6.2",
"typescript": "^5.2.2",
"vite": "^5.2.0"
}
}
36 changes: 36 additions & 0 deletions packages/sdks/snippets/svelte/src/App.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<script lang="ts">
import { Content, _processContentResult, fetchOneEntry } from '@builder.io/sdk-svelte';
let props = null;
let apiKey = 'f1a790f8c3204b3b8c5c1795aeac4660';
let model = 'page';
const fetch = async () => {
const content = await fetchOneEntry({
apiKey,
model,
userAttributes: {
url: location.pathname
}
});
props = {
content,
model,
apiKey
}
};
fetch();
</script>

<svelte:head>
<title>Home</title>
</svelte:head>

<main>
{#if props}
<Content {...props} />
{:else}
Content Not Found
{/if}
</main>
8 changes: 8 additions & 0 deletions packages/sdks/snippets/svelte/src/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import './app.css'
import App from './App.svelte'

const app = new App({
target: document.getElementById('app')!,
})

export default app
2 changes: 2 additions & 0 deletions packages/sdks/snippets/svelte/src/vite-env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/// <reference types="svelte" />
/// <reference types="vite/client" />
7 changes: 7 additions & 0 deletions packages/sdks/snippets/svelte/svelte.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'

export default {
// Consult https://svelte.dev/docs#compile-time-svelte-preprocess
// for more information about preprocessors
preprocess: vitePreprocess(),
}
20 changes: 20 additions & 0 deletions packages/sdks/snippets/svelte/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"extends": "@tsconfig/svelte/tsconfig.json",
"compilerOptions": {
"target": "ESNext",
"useDefineForClassFields": true,
"module": "ESNext",
"resolveJsonModule": true,
/**
* Typecheck JS in `.svelte` and `.js` files by default.
* Disable checkJs if you'd like to use dynamic types in JS.
* Note that setting allowJs false does not prevent the use
* of JS in `.svelte` files.
*/
"allowJs": true,
"checkJs": true,
"isolatedModules": true
},
"include": ["src/**/*.ts", "src/**/*.js", "src/**/*.svelte"],
"references": [{ "path": "./tsconfig.node.json" }]
}
10 changes: 10 additions & 0 deletions packages/sdks/snippets/svelte/tsconfig.node.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"composite": true,
"skipLibCheck": true,
"module": "ESNext",
"moduleResolution": "bundler",
"strict": true
},
"include": ["vite.config.ts"]
}
7 changes: 7 additions & 0 deletions packages/sdks/snippets/svelte/vite.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { defineConfig } from 'vite'
import { svelte } from '@sveltejs/vite-plugin-svelte'

// https://vitejs.dev/config/
export default defineConfig({
plugins: [svelte()],
})

0 comments on commit b93baca

Please sign in to comment.