Merge pull request #381 from karthik2804/update_templates

Update templates

Author: karthik2804

.gitignore

@@ -8,3 +8,4 @@ dist.js
 dist/
 build/
 docs/
+!templates/**/.vscode/

templates/http-js/content/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "starlingmonkey",
+            "request": "launch",
+            "name": "Debug StarlingMonkey component",
+            "component": "${workspaceFolder}/dist/{{ project-name | kebab_case }}.wasm",
+            "program": "${workspaceFolder}/src/index.js",
+            "stopOnEntry": false,
+            "trace": true
+        }
+    ]
+}

templates/http-js/content/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "starlingmonkey": {
+        "componentRuntime": {
+            "executable": "spin",
+            "options": [
+                "up",
+                "-f",
+                "${workspaceFolder}",
+            ],
+        }
+    }
+}

templates/http-js/content/README.md

@@ -29,4 +29,11 @@ To use additional Spin interfaces, install the corresponding packages:
 | PostgreSQL    | `@spinframework/spin-postgres`  |
 | Redis         | `@spinframework/spin-redis`     |
 | SQLite        | `@spinframework/spin-sqlite`    |
-| Variables     | `@spinframework/spin-variables` |
+| Variables     | `@spinframework/spin-variables` |
+
+## Using the StarlingMonkey Debugger for VS Code
+
+1. First install the [StarlingMonkey Debugger](https://marketplace.visualstudio.com/items?itemName=BytecodeAlliance.starlingmonkey-debugger) extension.
+2. Build the component using the debug command `npm run build:debug`.
+3. Uncomment `tcp://127.0.0.1:*` in the `allowed_outbound_hosts` field in the `spin.toml`.
+4. Start the debugger in VS Code which should start Spin and attach the debugger. The debugger needs to be restarted for each http call.

templates/http-js/content/build.mjs

@@ -0,0 +1,42 @@
+// build.mjs
+import { build } from 'esbuild';
+import path from 'path';
+import { SpinEsbuildPlugin } from "@spinframework/build-tools/plugins/esbuild/index.js";
+import fs from 'fs';
+
+const spinPlugin = await SpinEsbuildPlugin();
+
+// plugin to handle vendor files in node_modules that may not be bundled.
+// Instead of generating a real source map for these files, it appends a minimal
+// inline source map pointing to an empty source. This avoids errors and ensures
+// source maps exist even for unbundled vendor code.
+let SourceMapPlugin = {
+    name: 'excludeVendorFromSourceMap',
+    setup(build) {
+        build.onLoad({ filter: /node_modules/ }, args => {
+            return {
+                contents: fs.readFileSync(args.path, 'utf8')
+                    + '\n//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIiJdLCJtYXBwaW5ncyI6IkEifQ==',
+                loader: 'default',
+            }
+        })
+    },
+}
+
+await build({
+    entryPoints: ['./src/index.js'],
+    outfile: './build/bundle.js',
+    bundle: true,
+    format: 'esm',
+    platform: 'node',
+    sourcemap: true,
+    minify: false,
+    plugins: [spinPlugin, SourceMapPlugin],
+    logLevel: 'error',
+    loader: {
+        '.ts': 'ts',
+        '.tsx': 'tsx',
+    },
+    resolveExtensions: ['.ts', '.tsx', '.js'],
+    sourceRoot: path.resolve(process.cwd(), 'src'),
+});

templates/http-js/content/package.json

@@ -4,16 +4,16 @@
   "description": "{{project-description}}",
   "main": "index.js",
   "scripts": {
-    "build": "npx webpack && mkdirp dist && j2w -i build/bundle.js --initLocation http://{{project-name | kebab_case}}.localhost -o dist/{{ project-name | kebab_case }}.wasm",
+    "build": "node build.mjs && mkdirp dist && j2w -i build/bundle.js --initLocation http://{{project-name | kebab_case}}.localhost -o dist/{{ project-name | kebab_case }}.wasm",
+    "build:debug": "node build.mjs && mkdirp dist && j2w -d -i build/bundle.js --initLocation http://{{project-name | kebab_case}}.localhost -o dist/{{ project-name | kebab_case }}.wasm",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "mkdirp": "^3.0.1",
-    "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0"
+    "esbuild": "^0.25.8"
   },
   "dependencies": {
     {%- case http-router -%}

templates/http-js/content/spin.toml

@@ -13,6 +13,9 @@ component = "{{project-name | kebab_case}}"
 [component.{{project-name | kebab_case}}]
 source = "dist/{{project-name | kebab_case}}.wasm"
 exclude_files = ["**/node_modules"]
+allowed_outbound_hosts = [
+    # "tcp://127.0.0.1:*", # Uncomment this line to while using the StarlingMonkey Debugger
+]
 [component.{{project-name | kebab_case}}.build]
 command = ["npm install", "npm run build"]
 watch = ["src/**/*.js"]

templates/http-js/content/webpack.config.js

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "starlingmonkey",
+            "request": "launch",
+            "name": "Debug StarlingMonkey component",
+            "component": "${workspaceFolder}/dist/{{ project-name | kebab_case }}.wasm",
+            "program": "${workspaceFolder}/src/index.ts",
+            "stopOnEntry": false,
+            "trace": true
+        }
+    ]
+}

templates/http-ts/content/.vscode/launch.json

@@ -0,0 +1,12 @@
+{
+    "starlingmonkey": {
+        "componentRuntime": {
+            "executable": "spin",
+            "options": [
+                "up",
+                "-f",
+                "${workspaceFolder}",
+            ],
+        }
+    }
+}