Add SvelteKit support to fedify init
#971
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| - Added [SvelteKit] option to `fedify init` command. This option allows users | ||
| to initialize a new Fedify project with SvelteKit integration. | ||
| [[#892], [#971] by Jang Hanarae] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| links: | ||
| '#971': https://github.com/fedify-dev/fedify/pull/971 | ||
| --- | ||
| - Supported [SvelteKit] as a web framework option in | ||
| `fedify init`. [[#892], [#971] by Jang Hanarae] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -75,7 +75,7 @@ | |
| "pnpm" | ||
| ], | ||
| "dependencies": { | ||
| "npm:mysql2": "^3.23.2" | ||
| }, | ||
| "imports": { | ||
| "@fedify/mysql": { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -75,7 +75,7 @@ | |
| "pnpm" | ||
| ], | ||
| "dependencies": { | ||
| "npm:mysql2": "^3.23.2" | ||
| }, | ||
| "imports": { | ||
| "@fedify/mysql": { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import { fedifyHook } from "@fedify/sveltekit"; | ||
| import { sequence } from "@sveltejs/kit/hooks"; | ||
| import federation from "$lib/federation"; | ||
|
|
||
| export const handle = sequence( | ||
| fedifyHook(federation), | ||
| ); | ||
|
Comment on lines
+1
to
+7
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
set -euo pipefail
# Inspect the SvelteKit server entry.
rg -n -C 3 'logging|federation|fedifyHook' \
packages/init/src/templates/sveltekit/hooks.server.ts.tpl
# Locate and inspect the template that generates src/lib/federation.ts.
fd -t f -g 'federation.ts.tpl' packages/init/src/templates -x \
rg -n -C 3 'logging|federation' {}Repository: fedify-dev/fedify Length of output: 892 🏁 Script executed: #!/bin/bash
set -euo pipefail
echo "== target template =="
cat -n packages/init/src/templates/sveltekit/hooks.server.ts.tpl
echo
echo "== federation template(s) =="
fd -t f -g 'federation.ts.tpl' packages/init/src/templates -x sh -c 'printf "\n--- %s ---\n" "$1"; cat -n "$1"' sh {}
echo
echo "== generate hook and logging references =="
rg -n -C 4 'logging|src/lib/logging|hooks\.server|federation\.ts.tpl' packages/init/src
echo
echo "== static init flow snippets =="
fd -t f 'sveltekit\.ts|hooks\.server\.ts\.tpl|federation\.ts\.tpl' packages/init/src -x sh -c 'echo "--- $1 linecount ---"; wc -l "$1"' sh {}Repository: fedify-dev/fedify Length of output: 30074 Load LogTape in the SvelteKit server entry. The generated 🤖 Prompt for AI Agents |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| import { PACKAGE_MANAGER } from "../const.ts"; | ||
| import deps from "../json/deps.json" with { type: "json" }; | ||
| import { PACKAGE_VERSION, readTemplate } from "../lib.ts"; | ||
| import type { PackageManager, WebFrameworkDescription } from "../types.ts"; | ||
| import { defaultDenoDependencies, defaultDevDependencies } from "./const.ts"; | ||
| import { getInstruction, nodeBunDevToolTasks, pmToRt } from "./utils.ts"; | ||
|
|
||
| const sveltekitDescription: WebFrameworkDescription = { | ||
| label: "SvelteKit", | ||
| packageManagers: PACKAGE_MANAGER, | ||
| defaultPort: 5173, | ||
| init: async ({ packageManager: pm, testMode }) => ({ | ||
| command: Array.from(getInitCommand(pm)), | ||
| dependencies: { | ||
| "@fedify/sveltekit": PACKAGE_VERSION, | ||
| ...(pm === "deno" ? defaultDenoDependencies : {}), | ||
| }, | ||
| devDependencies: { | ||
| ...defaultDevDependencies, | ||
| "typescript": deps["npm:typescript"], | ||
| "@types/node": deps["npm:@types/node@25"], | ||
| ...(pmToRt(pm) === "deno" | ||
| ? {} | ||
| : { "@dotenvx/dotenvx": deps["npm:@dotenvx/dotenvx"] }), | ||
| }, | ||
| federationFile: "src/lib/federation.ts", | ||
| loggingFile: "src/lib/logging.ts", | ||
| env: testMode ? { HOST: "127.0.0.1" } : {} as Record<string, string>, | ||
| files: { | ||
| "src/hooks.server.ts": await readTemplate("sveltekit/hooks.server.ts"), | ||
| }, | ||
| tasks: pmToRt(pm) === "deno" ? {} : { ...TASKS }, | ||
| instruction: getInstruction(pm, 5173), | ||
| }), | ||
| }; | ||
|
|
||
| export default sveltekitDescription; | ||
|
|
||
| /** | ||
| * Returns the shell command array to scaffold a new SvelteKit project | ||
| * in the current directory using the given package manager. | ||
| */ | ||
| function* getInitCommand(pm: PackageManager) { | ||
| yield* getSvelteKitInitCommand(pm); | ||
| yield* [ | ||
| ".", | ||
| "--template", | ||
| "minimal", | ||
| "--types", | ||
| "ts", | ||
| "--no-add-ons", | ||
| "--no-dir-check", | ||
| "--no-download-check", | ||
| "--install", | ||
| pm, | ||
| ]; | ||
| } | ||
|
|
||
| const getSvelteKitInitCommand = (pm: PackageManager): string[] => | ||
| pm === "bun" | ||
| ? ["bunx", "sv", "create"] | ||
| : pm === "deno" | ||
| ? ["deno", "run", "-A", "npm:sv", "create"] | ||
| : pm === "npm" | ||
| ? ["npx", "sv", "create"] | ||
| : [pm, "dlx", "sv", "create"]; | ||
|
|
||
| const TASKS = { | ||
| "dev": "dotenvx run -- vite dev", | ||
| "build": "dotenvx run -- vite build", | ||
| "preview": "dotenvx run -- vite preview", | ||
| ...nodeBunDevToolTasks, | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Point the SvelteKit reference to the SvelteKit documentation.
The current reference opens the generic Svelte homepage. Use the SvelteKit documentation URL already used in
CHANGES.md.Proposed fix
🤖 Prompt for AI Agents