Skip to content

Restructure templates #307

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

Merged
merged 2 commits into from
Jan 21, 2025
Merged

Restructure templates #307

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cf1cc2
update templates
karthik2804 Jan 20, 2025
64bde83
address review comments
karthik2804 Jan 21, 2025
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 templates/http-js/content/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
KNITWIT_SOURCE=./config/knitwit.json
0 templates/http-js/content/knitwit.json → ...lates/http-js/content/config/knitwit.json
View file
Open in desktop
File renamed without changes.
9 changes: 5 additions & 4 deletions templates/http-js/content/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@
"description": "{{project-description}}",
"main": "index.js",
"scripts": {
"build": "npx webpack --mode=production && npx mkdirp target && npx j2w -i dist.js -d combined-wit -n combined -o target/{{project-name | kebab_case}}.wasm {% if enable-aot == 'y' or enable-aot == 'Y' %}--aot{% endif %}",
"build": "npx webpack --mode=production && npx mkdirp dist && npx j2w -i build/bundle.js -d build/wit/knitwit -n combined -o dist/{{project-name | kebab_case}}.wasm",
"test": "echo \"Error: no test specified\" && exit 1",
"postinstall": "knitwit"
"postinstall": "knitwit --out-dir build/wit/knitwit --out-world combined"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"mkdirp": "^3.0.1",
"webpack": "^5.74.0",
"webpack-cli": "^4.10.0"
"webpack-cli": "^4.10.0",
"@fermyon/knitwit": "0.3.0"
},
"dependencies": {
"@fermyon/spin-sdk": "^2.3.0"
"@fermyon/spin-sdk": "^2.4.0"
}
}
4 changes: 2 additions & 2 deletions templates/http-js/content/spin.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ route = "{{http-path}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "target/{{project-name | kebab_case}}.wasm"
source = "dist/{{project-name | kebab_case}}.wasm"
exclude_files = ["**/node_modules"]
[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
watch = ["src/**/*.ts", "package.json"]
18 changes: 15 additions & 3 deletions templates/http-js/content/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
import { ResponseBuilder } from "@fermyon/spin-sdk";
import { ResponseBuilder, Router } from "@fermyon/spin-sdk";

export async function handler(req, res) {
console.log(req);
let router = Router();
router.get("*", (_, req, res) => { handleDefaultRoute(req, res) })
Copy link
Member

@radu-matei radu-matei Jan 20, 2025

Choose a reason for hiding this comment

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

potential nit that you can ignore: instead of separate functions, lambdas here?

Copy link
Collaborator Author

@karthik2804 karthik2804 Jan 20, 2025

Choose a reason for hiding this comment

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

I have a slight preference in this case to use functions as it keeps the router structure easily readable when more are added.

router.all("*", (_, req, res) => { notFound(req, res) })

async function handleDefaultRoute(req, res) {
res.send("hello universe");
}

async function notFound(req, res) {
res.status(404);
res.send("not found");
}

export async function handler(req, res) {
await router.handleRequest(req, res);
}
4 changes: 2 additions & 2 deletions templates/http-js/content/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ module.exports = {
outputModule: true,
},
output: {
path: path.resolve(__dirname, './'),
filename: 'dist.js',
path: path.resolve(__dirname, './build'),
filename: 'bundle.js',
module: true,
library: {
type: "module",
Expand Down
4 changes: 2 additions & 2 deletions templates/http-js/metadata/snippets/component.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ route = "{{http-path}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "{{ output-path }}/target/{{project-name | kebab_case}}.wasm"
source = "{{ output-path }}/dist/{{project-name | kebab_case}}.wasm"
allowed_outbound_hosts = []

[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
workdir = "{{ output-path }}"
1 change: 0 additions & 1 deletion templates/http-js/metadata/spin-template.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ component = "component.txt"
[parameters]
project-description = { type = "string", prompt = "Description", default = "" }
http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
enable-aot = { type = "string", prompt = "Enable AoT Compilation [y/N]", default = "N", pattern = "^[yYnN]$" }
1 change: 1 addition & 0 deletions templates/http-ts/content/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
KNITWIT_SOURCE=./config/knitwit.json
0 templates/http-ts/content/knitwit.json → ...lates/http-ts/content/config/knitwit.json
View file
Open in desktop
File renamed without changes.
9 changes: 5 additions & 4 deletions templates/http-ts/content/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
"description": "{{project-description}}",
"main": "index.js",
"scripts": {
"build": "npx webpack --mode=production && npx mkdirp target && npx j2w -i dist.js -d combined-wit -n combined -o target/{{ project-name | kebab_case }}.wasm {% if enable-aot == 'y' or enable-aot == 'Y' %}--aot{% endif %}",
"build": "npx webpack --mode=production && npx mkdirp dist && npx j2w -i build/bundle.js -d build/wit/knitwit -n combined -o dist/{{ project-name | kebab_case }}.wasm",
"test": "echo \"Error: no test specified\" && exit 1",
"postinstall": "knitwit"
"postinstall": "knitwit --out-dir build/wit/knitwit --out-world combined"
},
"keywords": [],
"author": "",
Expand All @@ -16,9 +16,10 @@
"ts-loader": "^9.4.1",
"typescript": "^4.8.4",
"webpack": "^5.74.0",
"webpack-cli": "^4.10.0"
"webpack-cli": "^4.10.0",
"@fermyon/knitwit": "0.3.0"
},
"dependencies": {
"@fermyon/spin-sdk": "^2.3.0"
"@fermyon/spin-sdk": "^2.4.0"
}
}
4 changes: 2 additions & 2 deletions templates/http-ts/content/spin.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ route = "{{http-path}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "target/{{project-name | kebab_case}}.wasm"
source = "dist/{{project-name | kebab_case}}.wasm"
exclude_files = ["**/node_modules"]
[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
watch = ["src/**/*.ts", "package.json"]
18 changes: 15 additions & 3 deletions templates/http-ts/content/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
import { ResponseBuilder } from "@fermyon/spin-sdk";
import { ResponseBuilder, Router } from "@fermyon/spin-sdk";

export async function handler(req: Request, res: ResponseBuilder) {
console.log(req);
let router = Router();
router.get("*", (_, req, res) => { handleDefaultRoute(req, res) })
router.all("*", (_, req, res) => { notFound(req, res) })

async function handleDefaultRoute(req: Request, res: ResponseBuilder) {
res.send("hello universe");
}

async function notFound(req: Request, res: ResponseBuilder) {
res.status(404);
res.send("not found");
}

export async function handler(req: Request, res: ResponseBuilder) {
await router.handleRequest(req, res);
}
4 changes: 2 additions & 2 deletions templates/http-ts/content/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ module.exports = {
extensions: ['.tsx', '.ts', '.js'],
},
output: {
path: path.resolve(__dirname, './'),
filename: 'dist.js',
path: path.resolve(__dirname, './build'),
filename: 'bundle.js',
module: true,
library: {
type: "module",
Expand Down
4 changes: 2 additions & 2 deletions templates/http-ts/metadata/snippets/component.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ route = "{{http-path}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "{{ output-path }}/target/{{project-name | kebab_case}}.wasm"
source = "{{ output-path }}/dist/{{project-name | kebab_case}}.wasm"
allowed_outbound_hosts = []

[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
workdir = "{{ output-path }}"
1 change: 0 additions & 1 deletion templates/http-ts/metadata/spin-template.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ component = "component.txt"
[parameters]
project-description = { type = "string", prompt = "Description", default = "" }
http-path = { type = "string", prompt = "HTTP path", default = "/...", pattern = "^/\\S*$" }
enable-aot = { type = "string", prompt = "Enable AoT Compilation [y/N]", default = "N", pattern = "^[yYnN]$" }
1 change: 1 addition & 0 deletions templates/redis-js/content/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
KNITWIT_SOURCE=./config/knitwit.json
0 templates/redis-js/content/knitwit.json → ...ates/redis-js/content/config/knitwit.json
View file
Open in desktop
File renamed without changes.
9 changes: 5 additions & 4 deletions templates/redis-js/content/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@
"description": "{{project-description}}",
"main": "index.js",
"scripts": {
"build": "npx webpack --mode=production && npx mkdirp target && npx j2w -i dist.js -d combined-wit -n combined -o target/{{project-name | kebab_case}}.wasm {% if enable-aot == 'y' or enable-aot == 'Y' %}--aot{% endif %}",
"build": "npx webpack --mode=production && npx mkdirp dist && npx j2w -i build/bundle.js -d build/wit/knitwit -n combined -o dist/{{project-name | kebab_case}}.wasm",
"test": "echo \"Error: no test specified\" && exit 1",
"postinstall": "knitwit"
"postinstall": "knitwit --out-dir build/wit/knitwit --out-world combined"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"mkdirp": "^3.0.1",
"webpack": "^5.74.0",
"webpack-cli": "^4.10.0"
"webpack-cli": "^4.10.0",
"@fermyon/knitwit": "0.3.0"
},
"dependencies": {
"@fermyon/spin-sdk": "^2.3.0"
"@fermyon/spin-sdk": "^2.4.0"
}
}
4 changes: 2 additions & 2 deletions templates/redis-js/content/spin.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ channel = "{{redis-channel}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "target/{{project-name | kebab_case}}.wasm"
source = "dist/{{project-name | kebab_case}}.wasm"
exclude_files = ["**/node_modules"]
[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
watch = ["src/**/*.ts", "package.json"]
4 changes: 2 additions & 2 deletions templates/redis-js/content/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ module.exports = {
outputModule: true,
},
output: {
path: path.resolve(__dirname, './'),
filename: 'dist.js',
path: path.resolve(__dirname, './build'),
filename: 'bundle.js',
module: true,
library: {
type: "module",
Expand Down
4 changes: 2 additions & 2 deletions templates/redis-js/metadata/snippets/component.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ channel = "{{redis-channel}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "{{ output-path }}/target/{{project-name | kebab_case}}.wasm"
source = "{{ output-path }}/dist/{{project-name | kebab_case}}.wasm"
allowed_outbound_hosts = []
[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
workdir = "{{ output-path }}"
1 change: 0 additions & 1 deletion templates/redis-js/metadata/spin-template.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ skip_snippets = ["application_trigger"]
project-description = { type = "string", prompt = "Description", default = "" }
redis-address = { type = "string", prompt = "Redis address", default = "redis://localhost:6379" }
redis-channel = { type = "string", prompt = "Redis channel" }
enable-aot = { type = "string", prompt = "Enable AoT Compilation [y/N]", default = "N", pattern = "^[yYnN]$" }
1 change: 1 addition & 0 deletions templates/redis-ts/content/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
KNITWIT_SOURCE=./config/knitwit.json
0 templates/redis-ts/content/knitwit.json → ...ates/redis-ts/content/config/knitwit.json
View file
Open in desktop
File renamed without changes.
9 changes: 5 additions & 4 deletions templates/redis-ts/content/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
"description": "{{project-description}}",
"main": "index.js",
"scripts": {
"build": "npx webpack --mode=production && npx mkdirp target && npx j2w -i dist.js -d combined-wit -n combined -o target/{{project-name | kebab_case}}.wasm {% if enable-aot == 'y' or enable-aot == 'Y' %}--aot{% endif %}",
"build": "npx webpack --mode=production && npx mkdirp dist && npx j2w -i build/bundle.js -d build/wit/knitwit -n combined -o dist/{{project-name | kebab_case}}.wasm",
"test": "echo \"Error: no test specified\" && exit 1",
"postinstall": "knitwit"
"postinstall": "knitwit --out-dir build/wit/knitwit --out-world combined"
},
"keywords": [],
"author": "",
Expand All @@ -16,9 +16,10 @@
"ts-loader": "^9.4.1",
"typescript": "^4.8.4",
"webpack": "^5.74.0",
"webpack-cli": "^4.10.0"
"webpack-cli": "^4.10.0",
"@fermyon/knitwit": "0.3.0"
},
"dependencies": {
"@fermyon/spin-sdk": "^2.3.0"
"@fermyon/spin-sdk": "^2.4.0"
}
}
4 changes: 2 additions & 2 deletions templates/redis-ts/content/spin.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ channel = "{{redis-channel}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "target/{{project-name | kebab_case}}.wasm"
source = "dist/{{project-name | kebab_case}}.wasm"
exclude_files = ["**/node_modules"]
[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
watch = ["src/**/*.ts", "package.json"]
4 changes: 2 additions & 2 deletions templates/redis-ts/content/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ module.exports = {
extensions: ['.tsx', '.ts', '.js'],
},
output: {
path: path.resolve(__dirname, './'),
filename: 'dist.js',
path: path.resolve(__dirname, './build'),
filename: 'bundle.js',
module: true,
library: {
type: "module",
Expand Down
4 changes: 2 additions & 2 deletions templates/redis-ts/metadata/snippets/component.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ channel = "{{redis-channel}}"
component = "{{project-name | kebab_case}}"

[component.{{project-name | kebab_case}}]
source = "{{ output-path }}/target/{{project-name | kebab_case}}.wasm"
source = "{{ output-path }}/dist/{{project-name | kebab_case}}.wasm"
allowed_outbound_hosts = []
[component.{{project-name | kebab_case}}.build]
command = "npm run build"
command = "npm install && npm run build"
workdir = "{{ output-path }}"
1 change: 0 additions & 1 deletion templates/redis-ts/metadata/spin-template.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ skip_snippets = ["application_trigger"]
project-description = { type = "string", prompt = "Description", default = "" }
redis-address = { type = "string", prompt = "Redis address", default = "redis://localhost:6379" }
redis-channel = { type = "string", prompt = "Redis channel" }
enable-aot = { type = "string", prompt = "Enable AoT Compilation [y/N]", default = "N", pattern = "^[yYnN]$" }
Loading