Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add svelte starter #282

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add svelte starter #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
359b9a3
svelte starter
ZackAmes Oct 1, 2024
4b4550f
update manifest location and imports
ZackAmes Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/example-vite-svelte-recs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
47 changes: 47 additions & 0 deletions examples/example-vite-svelte-recs/README.md
View file
Open in desktop
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)
```
Binary file added examples/example-vite-svelte-recs/bun.lockb
View file
Open in desktop
Binary file not shown.
7 changes: 7 additions & 0 deletions examples/example-vite-svelte-recs/dojoConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import manifest from "../manifests/dev/deployment/manifest.json";
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

@dojoengine/core dependency is missing.

The package.json does not include "@dojoengine/core", and it is not found in node_modules. Ensure that "@dojoengine/core" is listed as a dependency and properly installed to resolve import issues in dojoConfig.ts.

🔗 Analysis chain

Verify the manifest file's existence and generation process.

The manifest is imported from a relative path. Ensure that this file exists in the specified location and is correctly generated or updated during the build/deployment process.

Run the following script to check the manifest file:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the manifest file and check its content.

# Test 1: Check if the manifest file exists
if [ -f "../manifests/dev/deployment/manifest.json" ]; then
    echo "Manifest file exists."
    # Test 2: Display the first few lines of the manifest file
    head -n 5 "../manifests/dev/deployment/manifest.json"
else
    echo "Manifest file does not exist at the specified path."
fi

# Test 3: Search for any scripts that might generate or update the manifest
fd -e sh -e js -e ts --exec grep -l "manifest.json" {}

Length of output: 288


import { createDojoConfig } from "@dojoengine/core";

export const dojoConfig = createDojoConfig({
manifest,
});
13 changes: 13 additions & 0 deletions examples/example-vite-svelte-recs/index.html
View file
Open in desktop
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>
33 changes: 33 additions & 0 deletions examples/example-vite-svelte-recs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"name": "svelte-starter",
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"check": "svelte-check --tsconfig ./tsconfig.json && tsc -p tsconfig.node.json"
},
"devDependencies": {
"@sveltejs/vite-plugin-svelte": "^3.1.1",
"@tsconfig/svelte": "^5.0.4",
"svelte": "^4.2.18",
"svelte-check": "^3.8.5",
"tslib": "^2.6.3",
"typescript": "^5.5.3",
"vite": "^5.4.1"
},
Comment on lines +12 to +20
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

🚨 TypeScript dependency is missing

TypeScript is not listed under either dependencies or devDependencies in package.json. Please ensure that TypeScript is added to devDependencies with a stable version (e.g., "typescript": "^5.3.x").

🔗 Analysis chain

LGTM: DevDependencies are well-chosen, but verify TypeScript version.

The devDependencies include all necessary packages for Svelte development with TypeScript and Vite. The use of caret (^) for versions is a good practice for allowing compatible updates.

The TypeScript version (5.5.3) appears to be a pre-release version. Please verify if this is intentional or if it should be downgraded to the latest stable version (currently 5.3.x).

Unable to verify TypeScript version using npm. Extracting directly from package.json.

Verifying presence and version of TypeScript in dependencies.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the latest stable TypeScript version
npm view typescript versions --json | jq -r '.[-1]'

Length of output: 124

Script:

#!/bin/bash
# Extract TypeScript version from package.json
jq -r '.devDependencies.typescript' package.json

Length of output: 53

Script:

#!/bin/bash
# Extract TypeScript version from dependencies or devDependencies
jq -r '.dependencies.typescript // .devDependencies.typescript' package.json

Length of output: 83

"dependencies": {
"@dojoengine/core": "workspace:*",
"@dojoengine/create-burner": "workspace:*",
"@dojoengine/recs": "^2.0.13",
"@dojoengine/state": "workspace:*",
"@dojoengine/torii-client": "workspace:*",
"@dojoengine/utils": "workspace:*",
"@latticexyz/utils": "^2.1.1",
"starknet": "^6.11.0",
"vite-plugin-top-level-await": "^1.4.4",
"vite-plugin-wasm": "^3.3.0"
}
}
Loading
Loading