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

feat: Svelte #310

Merged
merged 5 commits into from
Oct 31, 2024
+3,939 −25
Merged

feat: Svelte #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 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
5bec93a
fix: lint
ponderingdemocritus Oct 31, 2024
e283447
fix: linting
ponderingdemocritus Oct 31, 2024
7b72142
fix: lint
ponderingdemocritus Oct 31, 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.

Comment on lines +36 to +41
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance HMR state preservation explanation.

The explanation about HMR state preservation is important. Consider adding a complete code example demonstrating:

  1. A component with local state that doesn't persist
  2. The same component refactored to use an external store

Example addition:

<!-- Example.svelte -->
<!-- ❌ Local state that won't persist during HMR -->
<script lang="ts">
  let count = 0;
</script>

<!-- ✅ Using external store that persists during HMR -->
<script lang="ts">
  import countStore from './store';
</script>
🧰 Tools
🪛 LanguageTool

[uncategorized] ~40-~40: Possible missing comma found.
Context: ...omponent, consider creating an external store which would not be replaced by HMR. ``...

(AI_HYDRA_LEO_MISSING_COMMA)

```ts
// store.ts
// An extremely simple external store
import { writable } from "svelte/store";
export default writable(0);
```
Comment on lines +42 to +47
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance the store example.

Consider expanding the example to show:

  1. Type definitions
  2. Store subscription
  3. Multiple store values for a real-world scenario
// store.ts
import { writable } from 'svelte/store';

interface GameState {
  score: number;
  level: number;
  isActive: boolean;
}

const initialState: GameState = {
  score: 0,
  level: 1,
  isActive: false
};

export const gameStore = writable<GameState>(initialState);

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 "../../worlds/dojo-starter/manifests/dev/deployment/manifest.json";

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

export const dojoConfig = createDojoConfig({
manifest,
});
Comment on lines +5 to +7
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add type safety to the configuration.

The configuration lacks type information which could lead to runtime errors if the manifest structure changes.

Consider adding type information:

+import type { DojoConfig } from "@dojoengine/core";
+import type { Manifest } from "@dojoengine/core";

-export const dojoConfig = createDojoConfig({
+export const dojoConfig: DojoConfig = createDojoConfig<Manifest>({
   manifest,
});
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
export const dojoConfig = createDojoConfig({
manifest,
});
import type { DojoConfig } from "@dojoengine/core";
import type { Manifest } from "@dojoengine/core";
export const dojoConfig: DojoConfig = createDojoConfig<Manifest>({
manifest,
});

💡 Codebase verification

The manifest import path is incorrect and needs to be fixed

The import statement references a manifest file at ../../worlds/dojo-starter/manifests/dev/deployment/manifest.json, but this file does not exist in the repository. While the worlds/dojo-starter directory exists, it appears to be empty or doesn't contain the expected manifest structure.

  • The manifest file should either be:
    • Added to the expected location
    • Or the import path should be updated to point to the correct manifest location
🔗 Analysis chain

Verify manifest path resolution.

The relative import path traverses outside the example directory. Let's verify that this path resolves correctly.

Let me check the actual import statement and manifest location in the codebase.

Let me verify if the referenced manifest path exists relative to the example directory.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the manifest file exists and is accessible

# Test 1: Check if the manifest file exists
if [ -f "worlds/dojo-starter/manifests/dev/deployment/manifest.json" ]; then
    echo "✓ Manifest file exists"
    # Test 2: Verify it's a valid JSON file
    if jq empty "worlds/dojo-starter/manifests/dev/deployment/manifest.json" 2>/dev/null; then
        echo "✓ Manifest is valid JSON"
    else
        echo "✗ Invalid JSON in manifest file"
    fi
else
    echo "✗ Manifest file not found"
fi

# Test 3: Check for other manifest files that might be relevant
echo "Other manifest files in the project:"
fd -e json -p "manifest.*\.json$"

Length of output: 251

Script:

#!/bin/bash
# Check the actual import statement in the file
echo "Content of dojoConfig.ts:"
cat examples/example-vite-svelte-recs/dojoConfig.ts

echo -e "\nSearching for manifest files in or near the example directory:"
fd manifest examples/example-vite-svelte-recs -e json

echo -e "\nChecking for manifest-related imports:"
rg "import.*manifest" examples/example-vite-svelte-recs

Length of output: 806

Script:

#!/bin/bash
# Check if the manifest exists at the relative path from the example
cd examples/example-vite-svelte-recs
if [ -f "../../worlds/dojo-starter/manifests/dev/deployment/manifest.json" ]; then
    echo "✓ Manifest file exists at the relative path"
    jq empty "../../worlds/dojo-starter/manifests/dev/deployment/manifest.json" 2>/dev/null && echo "✓ Valid JSON" || echo "✗ Invalid JSON"
else
    echo "✗ Manifest file not found at the relative path"
    echo -e "\nListing contents of parent directories to debug:"
    ls -la ../..
    echo -e "\nListing worlds directory if it exists:"
    ls -la ../../worlds 2>/dev/null || echo "worlds directory not found"
fi

Length of output: 2346

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 + Dojo</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"
},
Comment on lines +6 to +11
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding more development convenience scripts.

While the basic scripts are present, additional scripts would enhance the development experience.

     "scripts": {
         "dev": "vite",
         "build": "vite build",
         "preview": "vite preview",
-        "check": "svelte-check --tsconfig ./tsconfig.json && tsc -p tsconfig.node.json"
+        "check": "svelte-check --tsconfig ./tsconfig.json && tsc -p tsconfig.node.json",
+        "lint": "eslint . --ext .js,.ts,.svelte",
+        "format": "prettier --write .",
+        "test": "vitest",
+        "clean": "rimraf dist"

Committable suggestion was skipped due to low confidence.

"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"
},
"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