From 3da58ced90e6e9a8bc37f70cdb91127ed7b09cd3 Mon Sep 17 00:00:00 2001 From: Ryan Turnquist Date: Wed, 1 Jul 2026 02:14:32 +0000 Subject: [PATCH 1/3] feat: add Docker deployment adapter Add @marko/run-adapter-docker for deploying Marko Run apps as a container. - Builds a self-contained Node.js server (dist/index.mjs) with all dependencies bundled (noExternal), so the image needs no node_modules install; the server handles routes and serves static assets from dist/public, listening on PORT - Generates a Dockerfile and .dockerignore in the project root (only when absent, so user edits are preserved); base image configurable via the `baseImage` option - Reuses the base adapter's dev/preview so `marko-run preview` runs the built server directly - Adds a run-package fixture covering both dev and preview --- .changeset/docker-adapter.md | 5 + package-lock.json | 447 ++++++++++++++++++ packages/adapters/docker/README.md | 68 +++ packages/adapters/docker/package.json | 33 ++ packages/adapters/docker/scripts/build.ts | 45 ++ .../adapters/docker/scripts/importMetaURL.js | 2 + packages/adapters/docker/src/index.ts | 95 ++++ packages/adapters/docker/src/types.ts | 8 + packages/adapters/docker/tsconfig.json | 10 + .../fixtures/docker-adapter/.gitignore | 3 + .../docker-adapter/.marko-run/routes.d.ts | 36 ++ .../__snapshots__/dev.expected.md | 35 ++ .../__snapshots__/preview.expected.md | 35 ++ .../fixtures/docker-adapter/package.json | 5 + .../src/components/counter.marko | 11 + .../docker-adapter/src/routes/+page.marko | 12 + .../fixtures/docker-adapter/test.config.ts | 11 + .../fixtures/docker-adapter/tsconfig.json | 4 + .../fixtures/docker-adapter/vite.config.ts | 10 + 19 files changed, 875 insertions(+) create mode 100644 .changeset/docker-adapter.md create mode 100644 packages/adapters/docker/README.md create mode 100644 packages/adapters/docker/package.json create mode 100644 packages/adapters/docker/scripts/build.ts create mode 100644 packages/adapters/docker/scripts/importMetaURL.js create mode 100644 packages/adapters/docker/src/index.ts create mode 100644 packages/adapters/docker/src/types.ts create mode 100644 packages/adapters/docker/tsconfig.json create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/.gitignore create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/.marko-run/routes.d.ts create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/dev.expected.md create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/preview.expected.md create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/package.json create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/src/components/counter.marko create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/src/routes/+page.marko create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/test.config.ts create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/tsconfig.json create mode 100644 packages/run/src/__tests__/fixtures/docker-adapter/vite.config.ts diff --git a/.changeset/docker-adapter.md b/.changeset/docker-adapter.md new file mode 100644 index 00000000..6255801c --- /dev/null +++ b/.changeset/docker-adapter.md @@ -0,0 +1,5 @@ +--- +"@marko/run-adapter-docker": minor +--- + +Add a Docker adapter that builds a self-contained Node.js server and generates a Dockerfile for deploying @marko/run apps as a container (Fly.io, Railway, Render, Cloud Run, ECS, Kubernetes, etc.). diff --git a/package-lock.json b/package-lock.json index a01363b5..5d27f8d7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2485,6 +2485,10 @@ "resolved": "packages/run", "link": true }, + "node_modules/@marko/run-adapter-docker": { + "resolved": "packages/adapters/docker", + "link": true + }, "node_modules/@marko/run-adapter-netlify": { "resolved": "packages/adapters/netlify", "link": true @@ -14038,6 +14042,381 @@ } } }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.59.0.tgz", + "integrity": "sha512-upnNBkA6ZH2VKGcBj9Fyl9IGNPULcjXRlg0LLeaioQWueH30p6IXtJEbKAgvyv+mJaMxSm1l6xwDXYjpEMiLMg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-android-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.59.0.tgz", + "integrity": "sha512-hZ+Zxj3SySm4A/DylsDKZAeVg0mvi++0PYVceVyX7hemkw7OreKdCvW2oQ3T1FMZvCaQXqOTHb8qmBShoqk69Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.59.0.tgz", + "integrity": "sha512-W2Psnbh1J8ZJw0xKAd8zdNgF9HRLkdWwwdWqubSVk0pUuQkoHnv7rx4GiF9rT4t5DIZGAsConRE3AxCdJ4m8rg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-darwin-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.59.0.tgz", + "integrity": "sha512-ZW2KkwlS4lwTv7ZVsYDiARfFCnSGhzYPdiOU4IM2fDbL+QGlyAbjgSFuqNRbSthybLbIJ915UtZBtmuLrQAT/w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.59.0.tgz", + "integrity": "sha512-EsKaJ5ytAu9jI3lonzn3BgG8iRBjV4LxZexygcQbpiU0wU0ATxhNVEpXKfUa0pS05gTcSDMKpn3Sx+QB9RlTTA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.59.0.tgz", + "integrity": "sha512-d3DuZi2KzTMjImrxoHIAODUZYoUUMsuUiY4SRRcJy6NJoZ6iIqWnJu9IScV9jXysyGMVuW+KNzZvBLOcpdl3Vg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.59.0.tgz", + "integrity": "sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.59.0.tgz", + "integrity": "sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.59.0.tgz", + "integrity": "sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.59.0.tgz", + "integrity": "sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.59.0.tgz", + "integrity": "sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.59.0.tgz", + "integrity": "sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.59.0.tgz", + "integrity": "sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.59.0.tgz", + "integrity": "sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.59.0.tgz", + "integrity": "sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.59.0.tgz", + "integrity": "sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.59.0.tgz", + "integrity": "sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.59.0.tgz", + "integrity": "sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.59.0.tgz", + "integrity": "sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.59.0.tgz", + "integrity": "sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.59.0.tgz", + "integrity": "sha512-tt9KBJqaqp5i5HUZzoafHZX8b5Q2Fe7UjYERADll83O4fGqJ49O1FsL6LpdzVFQcpwvnyd0i+K/VSwu/o/nWlA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.59.0.tgz", + "integrity": "sha512-V5B6mG7OrGTwnxaNUzZTDTjDS7F75PO1ae6MJYdiMu60sq0CqN5CVeVsbhPxalupvTX8gXVSU9gq+Rx1/hvu6A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.59.0.tgz", + "integrity": "sha512-UKFMHPuM9R0iBegwzKF4y0C4J9u8C6MEJgFuXTBerMk7EJ92GFVFYBfOZaSGLu6COf7FxpQNqhNS4c4icUPqxA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.59.0.tgz", + "integrity": "sha512-laBkYlSS1n2L8fSo1thDNGrCTQMmxjYY5G0WFWjFFYZkKPjsMBsgJfGf4TLxXrF6RyhI60L8TMOjBMvXiTcxeA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, + "node_modules/netlify-cli/node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.59.0.tgz", + "integrity": "sha512-2HRCml6OztYXyJXAvdDXPKcawukWY2GpR5/nxKp4iBgiO3wcoEGkAaqctIbZcNB6KlUQBIqt8VYkNSj2397EfA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "peer": true + }, "node_modules/netlify-cli/node_modules/@sec-ant/readable-stream": { "version": "0.4.1", "dev": true, @@ -17283,6 +17662,19 @@ "safe-buffer": "~5.1.0" } }, + "node_modules/netlify-cli/node_modules/fsevents": { + "version": "2.3.3", + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "peer": true, + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, "node_modules/netlify-cli/node_modules/function-bind": { "version": "1.1.2", "dev": true, @@ -21065,6 +21457,53 @@ "dev": true, "license": "MIT" }, + "node_modules/netlify-cli/node_modules/rollup": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.59.0.tgz", + "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==", + "dev": true, + "license": "MIT", + "optional": true, + "peer": true, + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.59.0", + "@rollup/rollup-android-arm64": "4.59.0", + "@rollup/rollup-darwin-arm64": "4.59.0", + "@rollup/rollup-darwin-x64": "4.59.0", + "@rollup/rollup-freebsd-arm64": "4.59.0", + "@rollup/rollup-freebsd-x64": "4.59.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.59.0", + "@rollup/rollup-linux-arm-musleabihf": "4.59.0", + "@rollup/rollup-linux-arm64-gnu": "4.59.0", + "@rollup/rollup-linux-arm64-musl": "4.59.0", + "@rollup/rollup-linux-loong64-gnu": "4.59.0", + "@rollup/rollup-linux-loong64-musl": "4.59.0", + "@rollup/rollup-linux-ppc64-gnu": "4.59.0", + "@rollup/rollup-linux-ppc64-musl": "4.59.0", + "@rollup/rollup-linux-riscv64-gnu": "4.59.0", + "@rollup/rollup-linux-riscv64-musl": "4.59.0", + "@rollup/rollup-linux-s390x-gnu": "4.59.0", + "@rollup/rollup-linux-x64-gnu": "4.59.0", + "@rollup/rollup-linux-x64-musl": "4.59.0", + "@rollup/rollup-openbsd-x64": "4.59.0", + "@rollup/rollup-openharmony-arm64": "4.59.0", + "@rollup/rollup-win32-arm64-msvc": "4.59.0", + "@rollup/rollup-win32-ia32-msvc": "4.59.0", + "@rollup/rollup-win32-x64-gnu": "4.59.0", + "@rollup/rollup-win32-x64-msvc": "4.59.0", + "fsevents": "~2.3.2" + } + }, "node_modules/netlify-cli/node_modules/router": { "version": "2.2.0", "dev": true, @@ -25556,6 +25995,14 @@ "url": "https://github.com/sponsors/colinhacks" } }, + "packages/adapters/docker": { + "name": "@marko/run-adapter-docker", + "version": "0.1.0", + "license": "MIT", + "peerDependencies": { + "@marko/run": "^0.7||^0.8||^0.9||^0.10" + } + }, "packages/adapters/netlify": { "name": "@marko/run-adapter-netlify", "version": "3.0.3", diff --git a/packages/adapters/docker/README.md b/packages/adapters/docker/README.md new file mode 100644 index 00000000..fe67b795 --- /dev/null +++ b/packages/adapters/docker/README.md @@ -0,0 +1,68 @@ +

+ + + + + Marko Run Logo + +
+ @marko/run-adapter-docker +
+

+ +Preview and deploy [@marko/run](../../run/README.md) apps as a Docker container + +## Installation + +```sh +npm install @marko/run-adapter-docker +``` + +## Usage + +In your application's Vite config file (eg. `vite.config.js`), import and register this adapter with the `@marko/run` Vite plugin: + +```ts +import { defineConfig } from "vite"; +import marko from "@marko/run/vite"; +import dockerAdapter from "@marko/run-adapter-docker"; + +export default defineConfig({ + plugins: [ + marko({ + adapter: dockerAdapter(), + }), + ], +}); +``` + +Running `marko-run build` produces a self-contained Node.js server (`dist/index.mjs`) that serves your app and its static assets, and generates a `Dockerfile` and `.dockerignore` in your project root. + +Because the server is bundled, the image doesn't need a `node_modules` install: + +```sh +marko-run build +docker build -t my-app . +docker run -p 3000:3000 my-app +``` + +The container listens on the `PORT` environment variable (defaulting to `3000`). + +> The generated `Dockerfile`/`.dockerignore` are only written if they don't already exist, so you can safely customize them — delete a file to have it regenerated. + +## Configuration + +```ts +dockerAdapter({ + // Base image to build from (default: "node:20-alpine") + baseImage: "node:22-slim", +}); +``` + +## Deploying + +The resulting image runs anywhere containers do — [Fly.io](https://fly.io), [Railway](https://railway.app), [Render](https://render.com), Google Cloud Run, AWS ECS/Fargate, Kubernetes, etc. + +## Platform info + +Route handlers receive the underlying Node request and response objects via the exported `DockerPlatformInfo` type. diff --git a/packages/adapters/docker/package.json b/packages/adapters/docker/package.json new file mode 100644 index 00000000..7f6894e5 --- /dev/null +++ b/packages/adapters/docker/package.json @@ -0,0 +1,33 @@ +{ + "name": "@marko/run-adapter-docker", + "version": "0.1.0", + "description": "Preview and deploy @marko/run apps as a Docker container", + "keywords": [ + "marko" + ], + "homepage": "https://github.com/marko-js/run/tree/main/packages/adapters/docker", + "repository": { + "type": "git", + "url": "https://github.com/marko-js/run.git" + }, + "license": "MIT", + "author": "Ryan Turnquist ", + "type": "module", + "exports": { + ".": "./src/index.ts" + }, + "types": "./src/index.ts", + "files": [ + "dist" + ], + "scripts": { + "build": "tsc -b && tsx scripts/build.ts", + "test": "" + }, + "peerDependencies": { + "@marko/run": "^0.7||^0.8||^0.9||^0.10" + }, + "logo": { + "url": "https://github.com/marko-js/run/raw/main/assets/marko-run.png" + } +} diff --git a/packages/adapters/docker/scripts/build.ts b/packages/adapters/docker/scripts/build.ts new file mode 100644 index 00000000..690083e2 --- /dev/null +++ b/packages/adapters/docker/scripts/build.ts @@ -0,0 +1,45 @@ +import { build, BuildOptions } from "esbuild"; +import path from "path"; + +const srcdir = path.resolve("src"); +const outdir = path.resolve("dist"); + +const opts: BuildOptions = { + entryPoints: ["src/index.ts"], + outdir, + outbase: srcdir, + platform: "node", + target: ["node14"], + bundle: true, + plugins: [ + { + name: "external-modules", + setup(build) { + build.onResolve( + { filter: /^[^./]|^\.[^./]|^\.\.[^/]/ }, + ({ path }) => ({ + path, + external: true, + }), + ); + }, + }, + ], +}; + +await Promise.all([ + build({ + ...opts, + format: "cjs", + outExtension: { ".js": ".cjs" }, + define: { + "import.meta.url": "__importMetaURL", + }, + inject: ["./scripts/importMetaURL.js"], + }), + build({ + ...opts, + format: "esm", + splitting: true, + }), +]); diff --git a/packages/adapters/docker/scripts/importMetaURL.js b/packages/adapters/docker/scripts/importMetaURL.js new file mode 100644 index 00000000..c993f7f5 --- /dev/null +++ b/packages/adapters/docker/scripts/importMetaURL.js @@ -0,0 +1,2 @@ +import { pathToFileURL } from "url"; +export const __importMetaURL = pathToFileURL(__filename); diff --git a/packages/adapters/docker/src/index.ts b/packages/adapters/docker/src/index.ts new file mode 100644 index 00000000..0afd5740 --- /dev/null +++ b/packages/adapters/docker/src/index.ts @@ -0,0 +1,95 @@ +import baseAdapter, { type Adapter } from "@marko/run/adapter"; +import fs from "fs/promises"; +import path from "path"; + +export type { DockerPlatformInfo } from "./types"; + +/** The port the container listens on. Matches the server's default. */ +const PORT = 3000; + +export interface Options { + /** + * The base Docker image to build from. Defaults to `"node:20-alpine"`. + */ + baseImage?: string; +} + +export default function dockerAdapter(options: Options = {}): Adapter { + const { baseImage = "node:20-alpine" } = options; + const base = baseAdapter(); + + return { + ...base, + name: "docker-adapter", + + viteConfig(config) { + if (config.build?.ssr) { + return { + ssr: { + // Bundle everything so the built server is self-contained and the + // image doesn't need a `node_modules` install. + noExternal: true, + }, + }; + } + }, + + async buildEnd({ config }) { + // During the client build `outDir` points at the static assets dir + // (`/public`); its parent is the build dir containing the + // server entry (`index.mjs`). + const publicDir = path.resolve(config.root, config.build.outDir); + const distDir = path.dirname(publicDir); + const relDist = path.relative(config.root, distDir) || "."; + + await writeIfAbsent( + path.join(config.root, "Dockerfile"), + dockerfile(baseImage, relDist), + ); + await writeIfAbsent( + path.join(config.root, ".dockerignore"), + dockerignore(relDist), + ); + }, + + typeInfo(writer) { + writer( + `import type { DockerPlatformInfo } from '@marko/run-adapter-docker';`, + ); + return "DockerPlatformInfo"; + }, + }; +} + +function dockerfile(baseImage: string, relDist: string) { + return `# syntax=docker/dockerfile:1 +# Generated by @marko/run-adapter-docker. Build your app before building this +# image (\`marko-run build\`), then \`docker build\`. Delete this file to have it +# regenerated, or edit it freely — it will not be overwritten once it exists. +FROM ${baseImage} + +WORKDIR /app +ENV NODE_ENV=production +ENV PORT=${PORT} + +COPY ${relDist} ./${relDist} + +EXPOSE ${PORT} +CMD ["node", "${path.posix.join(relDist, "index.mjs")}"] +`; +} + +function dockerignore(relDist: string) { + return `* +!${relDist} +`; +} + +async function writeIfAbsent(file: string, contents: string) { + try { + await fs.access(file); + // Already exists — leave the user's file untouched. + } catch { + await fs.writeFile(file, contents); + } +} diff --git a/packages/adapters/docker/src/types.ts b/packages/adapters/docker/src/types.ts new file mode 100644 index 00000000..244d7dd2 --- /dev/null +++ b/packages/adapters/docker/src/types.ts @@ -0,0 +1,8 @@ +import type { NodePlatformInfo } from "@marko/run/adapter"; + +/** + * The platform object passed to Marko Run route handlers when running the + * containerized Node.js server. Exposes the underlying Node request and + * response objects. + */ +export interface DockerPlatformInfo extends NodePlatformInfo {} diff --git a/packages/adapters/docker/tsconfig.json b/packages/adapters/docker/tsconfig.json new file mode 100644 index 00000000..5464c159 --- /dev/null +++ b/packages/adapters/docker/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../../tsconfig.json", + "include": ["src/**/*"], + "exclude": ["src/**/__tests__/**/*"], + "compilerOptions": { + "rootDir": "src", + "outDir": "dist", + "tsBuildInfoFile": "dist/.tsbuildinfo" + } +} diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/.gitignore b/packages/run/src/__tests__/fixtures/docker-adapter/.gitignore new file mode 100644 index 00000000..1f7a3fdb --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/.gitignore @@ -0,0 +1,3 @@ +dist +Dockerfile +.dockerignore diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/.marko-run/routes.d.ts b/packages/run/src/__tests__/fixtures/docker-adapter/.marko-run/routes.d.ts new file mode 100644 index 00000000..011eb43f --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/.marko-run/routes.d.ts @@ -0,0 +1,36 @@ +/* + WARNING: This file is automatically generated and any changes made to it will be overwritten without warning. + Do NOT manually edit this file or your changes will be lost. +*/ + +import { NotHandled, NotMatched, GetPaths, PostPaths, GetablePath, GetableHref, PostablePath, PostableHref, Platform } from "@marko/run/namespace"; +import type * as Run from "@marko/run"; +import type { DockerPlatformInfo } from '@marko/run-adapter-docker'; + +declare module "@marko/run" { + interface Platform extends DockerPlatformInfo {} + + interface AppData extends Run.DefineApp<{ + routes: { + "/": { verb: "get"; }; + } + }> {} +} + +declare module "../src/routes/+page.marko" { + namespace MarkoRun { + export { NotHandled, NotMatched, GetPaths, PostPaths, GetablePath, GetableHref, PostablePath, PostableHref, Platform }; + export type Route = Run.Routes["/"]; + export type Context = Run.MultiRouteContext & Marko.Global; + export type Handler = Run.HandlerLike; + export type GET = Run.HandlerLike; + export type HEAD = Run.HandlerLike; + export type POST = Run.HandlerLike; + export type PUT = Run.HandlerLike; + export type DELETE = Run.HandlerLike; + export type PATCH = Run.HandlerLike; + export type OPTIONS = Run.HandlerLike; + /** @deprecated use `((context, next) => { ... }) satisfies MarkoRun.Handler` instead */ + export const route: Run.HandlerTypeFn; + } +} diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/dev.expected.md b/packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/dev.expected.md new file mode 100644 index 00000000..1ec2ae91 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/dev.expected.md @@ -0,0 +1,35 @@ +# Loading + +```html + +``` + +# Step 0 +ctx=>click(ctx) + +```diff +- 0 ++ 1 + +``` + +# Step 1 +ctx=>click(ctx) + +```diff +- 1 ++ 2 + +``` + +# Step 2 +ctx=>click(ctx) + +```diff +- 2 ++ 3 + +``` + diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/preview.expected.md b/packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/preview.expected.md new file mode 100644 index 00000000..1ec2ae91 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/__snapshots__/preview.expected.md @@ -0,0 +1,35 @@ +# Loading + +```html + +``` + +# Step 0 +ctx=>click(ctx) + +```diff +- 0 ++ 1 + +``` + +# Step 1 +ctx=>click(ctx) + +```diff +- 1 ++ 2 + +``` + +# Step 2 +ctx=>click(ctx) + +```diff +- 2 ++ 3 + +``` + diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/package.json b/packages/run/src/__tests__/fixtures/docker-adapter/package.json new file mode 100644 index 00000000..2c38bc43 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/package.json @@ -0,0 +1,5 @@ +{ + "name": "docker-adapter", + "version": "1.0.0", + "scripts": {} +} diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/src/components/counter.marko b/packages/run/src/__tests__/fixtures/docker-adapter/src/components/counter.marko new file mode 100644 index 00000000..436a9eb5 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/src/components/counter.marko @@ -0,0 +1,11 @@ +class { + declare state: { count: number }; + onCreate() { + this.state = { count: 0 }; + } + handleIncrement() { + this.state.count++; + } +} + + \ No newline at end of file diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/src/routes/+page.marko b/packages/run/src/__tests__/fixtures/docker-adapter/src/routes/+page.marko new file mode 100644 index 00000000..5dd8370a --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/src/routes/+page.marko @@ -0,0 +1,12 @@ + + + + + @marko/run Test Fixture + + + + + + + diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/test.config.ts b/packages/run/src/__tests__/fixtures/docker-adapter/test.config.ts new file mode 100644 index 00000000..2b2c7170 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/test.config.ts @@ -0,0 +1,11 @@ +import { Step, StepContext } from "../../main.test"; + +export const steps: Step[] = [ + (ctx) => click(ctx), + (ctx) => click(ctx), + (ctx) => click(ctx), +]; + +async function click({ page }: StepContext) { + await page.click("button"); +} diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/tsconfig.json b/packages/run/src/__tests__/fixtures/docker-adapter/tsconfig.json new file mode 100644 index 00000000..03ff88a5 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig-base.json", + "include": ["src/**/*", ".marko-run/*"], +} \ No newline at end of file diff --git a/packages/run/src/__tests__/fixtures/docker-adapter/vite.config.ts b/packages/run/src/__tests__/fixtures/docker-adapter/vite.config.ts new file mode 100644 index 00000000..aa5531f1 --- /dev/null +++ b/packages/run/src/__tests__/fixtures/docker-adapter/vite.config.ts @@ -0,0 +1,10 @@ +import marko from "@marko/run/vite"; +import adapter from "@marko/run-adapter-docker"; +import { defineConfig } from "vite"; + +export default defineConfig({ + plugins: [marko({ adapter: adapter() })], + server: { + hmr: false, + }, +}); From 80e02d7e2cd9f0a49b77109be2a1a90a4ad6a109 Mon Sep 17 00:00:00 2001 From: Ryan Turnquist Date: Wed, 1 Jul 2026 05:00:51 +0000 Subject: [PATCH 2/3] fix: address review feedback for the Docker adapter - Add package.toggle.json so publish points exports/types at dist/ - Make the injected import.meta.url shim a string (.href) for the CJS build - Normalize the generated Dockerfile paths to POSIX separators so the Dockerfile is valid when the build runs on Windows --- packages/adapters/docker/package.toggle.json | 15 +++++++++++++++ packages/adapters/docker/scripts/importMetaURL.js | 2 +- packages/adapters/docker/src/index.ts | 6 +++++- 3 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 packages/adapters/docker/package.toggle.json diff --git a/packages/adapters/docker/package.toggle.json b/packages/adapters/docker/package.toggle.json new file mode 100644 index 00000000..a2f5767a --- /dev/null +++ b/packages/adapters/docker/package.toggle.json @@ -0,0 +1,15 @@ +{ + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js", + "require": "./dist/index.cjs" + } + }, + "types": "./dist/index.d.ts", + "typesVersions": { + "*": { + "*": ["./dist/index.d.ts"] + } + } +} diff --git a/packages/adapters/docker/scripts/importMetaURL.js b/packages/adapters/docker/scripts/importMetaURL.js index c993f7f5..b1277af3 100644 --- a/packages/adapters/docker/scripts/importMetaURL.js +++ b/packages/adapters/docker/scripts/importMetaURL.js @@ -1,2 +1,2 @@ import { pathToFileURL } from "url"; -export const __importMetaURL = pathToFileURL(__filename); +export const __importMetaURL = pathToFileURL(__filename).href; diff --git a/packages/adapters/docker/src/index.ts b/packages/adapters/docker/src/index.ts index 0afd5740..f124e950 100644 --- a/packages/adapters/docker/src/index.ts +++ b/packages/adapters/docker/src/index.ts @@ -40,7 +40,11 @@ export default function dockerAdapter(options: Options = {}): Adapter { // server entry (`index.mjs`). const publicDir = path.resolve(config.root, config.build.outDir); const distDir = path.dirname(publicDir); - const relDist = path.relative(config.root, distDir) || "."; + // Normalize to POSIX separators so the generated Dockerfile is valid on + // Windows hosts too (the image is always Linux-based). + const relDist = (path.relative(config.root, distDir) || ".") + .split(path.sep) + .join("/"); await writeIfAbsent( path.join(config.root, "Dockerfile"), From c1b51512f84f8657d01d75c605a5e0bcce19f357 Mon Sep 17 00:00:00 2001 From: Ryan Turnquist Date: Wed, 1 Jul 2026 19:17:18 +0000 Subject: [PATCH 3/3] docs: note adapter auto-discovery and add a Deploying section (Docker) Clarify that Marko Run automatically uses an installed adapter with no Vite config, and put the `npm run build` + docker build/run steps in a Deploying section right after installation. --- packages/adapters/docker/README.md | 50 +++++++++++++----------------- 1 file changed, 22 insertions(+), 28 deletions(-) diff --git a/packages/adapters/docker/README.md b/packages/adapters/docker/README.md index fe67b795..50d4afc7 100644 --- a/packages/adapters/docker/README.md +++ b/packages/adapters/docker/README.md @@ -18,51 +18,45 @@ Preview and deploy [@marko/run](../../run/README.md) apps as a Docker container npm install @marko/run-adapter-docker ``` -## Usage +That's all the setup required — Marko Run automatically discovers an installed adapter and uses it, so you **don't** need to register it in your Vite config. See [Configuration](#configuration) to change the base image. -In your application's Vite config file (eg. `vite.config.js`), import and register this adapter with the `@marko/run` Vite plugin: +`marko-run build` produces a self-contained Node.js server (`dist/index.mjs`) that serves your app and its static assets, and generates a `Dockerfile` and `.dockerignore` in your project root. The container listens on the `PORT` environment variable (defaulting to `3000`). -```ts -import { defineConfig } from "vite"; -import marko from "@marko/run/vite"; -import dockerAdapter from "@marko/run-adapter-docker"; - -export default defineConfig({ - plugins: [ - marko({ - adapter: dockerAdapter(), - }), - ], -}); -``` +> The generated `Dockerfile`/`.dockerignore` are only written if they don't already exist, so you can safely customize them — delete a file to have it regenerated. -Running `marko-run build` produces a self-contained Node.js server (`dist/index.mjs`) that serves your app and its static assets, and generates a `Dockerfile` and `.dockerignore` in your project root. +## Deploying -Because the server is bundled, the image doesn't need a `node_modules` install: +Because the server is bundled, the image doesn't need a `node_modules` install — build it and run it: ```sh -marko-run build +npm run build docker build -t my-app . docker run -p 3000:3000 my-app ``` -The container listens on the `PORT` environment variable (defaulting to `3000`). - -> The generated `Dockerfile`/`.dockerignore` are only written if they don't already exist, so you can safely customize them — delete a file to have it regenerated. +The resulting image runs anywhere containers do — [Fly.io](https://fly.io), [Railway](https://railway.app), [Render](https://render.com), Google Cloud Run, AWS ECS/Fargate, Kubernetes, etc. Push it to a registry and deploy it with your platform of choice. ## Configuration +Marko Run uses this adapter automatically, but you can register it in your Vite config (eg. `vite.config.js`) to change the base image: + ```ts -dockerAdapter({ - // Base image to build from (default: "node:20-alpine") - baseImage: "node:22-slim", +import { defineConfig } from "vite"; +import marko from "@marko/run/vite"; +import dockerAdapter from "@marko/run-adapter-docker"; + +export default defineConfig({ + plugins: [ + marko({ + adapter: dockerAdapter({ + // Base image to build from (default: "node:20-alpine") + baseImage: "node:22-slim", + }), + }), + ], }); ``` -## Deploying - -The resulting image runs anywhere containers do — [Fly.io](https://fly.io), [Railway](https://railway.app), [Render](https://render.com), Google Cloud Run, AWS ECS/Fargate, Kubernetes, etc. - ## Platform info Route handlers receive the underlying Node request and response objects via the exported `DockerPlatformInfo` type.