nept-frameworks 0.1.0

package/README.md

@@ -0,0 +1,81 @@
+# nept-frameworks
+
+Generates production Dockerfiles for 33 backend and full-stack targets across
+JavaScript, Python, Go, Rust, Java, Ruby, PHP, .NET, Deno, and Bun. The typed
+`FRAMEWORK_DEFAULTS` registry is the source of truth for deployment metadata.
+
+## Generate
+
+```ts
+import { DOCKERIGNORE, generateDockerfile } from "nept-frameworks";
+
+const dockerfile = generateDockerfile({
+  outputDir: null,
+  installCMD: "bun install --frozen-lockfile",
+  buildCMD: null,
+  runCMD: null,
+  cmd: '["bun", ".output/server/index.mjs"]',
+  envVars: {},
+  version: "1.3.14-slim",
+  framework: "nuxt",
+});
+```
+
+The install command identifies the JavaScript package manager. When it is
+`null`, exactly one supported lockfile must exist in the current directory.
+Write `dockerfile` to `Dockerfile` and `DOCKERIGNORE` to `.dockerignore` in the
+Docker build context.
+
+Framework requirements:
+
+- Next.js: `output: "standalone"`
+- Nuxt: built-in Nitro Node or Bun preset
+- Astro: `@astrojs/node` in standalone mode
+- SvelteKit: `@sveltejs/adapter-node`
+- Remix: Remix v2 Vite build with `@remix-run/serve`
+- Qwik: Qwik City Node server adapter
+
+Node-targeted adapters can run under Bun's Node compatibility layer, but
+application dependencies may still require Node. Nuxt receives its native Bun
+preset when `runtime: "bun"` is selected.
+
+Runtime versions accept pinned official image tags:
+
+```ts
+generateDockerfile({
+  outputDir: null,
+  installCMD: null,
+  buildCMD: null,
+  runCMD: null,
+  cmd: null,
+  envVars: {},
+  version: "1.20.14-bookworm",
+  framework: "go",
+});
+```
+
+`version` is the official image tag for the selected framework runtime. Use
+full tags such as `3.11.15-slim-bookworm`, not floating shorthand.
+Framework versions are supplied by the application's package and lock files;
+the Dockerfile generator does not replace them.
+
+## Test
+
+A running Docker daemon is required. The complete test builds and runs 50
+images from disposable copies of the apps under `playground/`.
+
+```sh
+bun install
+bunx tsc --noEmit
+bun test
+```
+
+## Install
+
+```sh
+npm install nept-frameworks
+```
+
+Every container is checked for SSR output, its JSON route, runtime environment
+values, static assets, non-root execution, and image size. Baseline changes in
+`tests/baselines/image-size.json` require explicit review.

package/dist/framework-defaults.d.ts

@@ -0,0 +1,514 @@
+import type { Framework, Runtime } from "./types/dockerfile";
+export type FrameworkStatus = "supported" | "planned" | "excluded";
+export type StackType = "backend" | "fullstack" | "static";
+export interface JavaScriptDeployment {
+    kind: "js-artifact";
+    selfContained: boolean;
+    copies: readonly (readonly [source: string, destination: string])[];
+    entrypoint: string;
+    entrypointArgument?: string;
+}
+export interface JavaScriptSourceDeployment {
+    kind: "js-source";
+    build: boolean;
+    entrypoint: string;
+}
+export interface DenoDeployment {
+    kind: "deno-source";
+    entrypoint: string;
+}
+export interface BunDeployment {
+    kind: "bun-source";
+    entrypoint: string;
+}
+export interface PythonDeployment {
+    kind: "python";
+    command: readonly string[];
+}
+export interface GoDeployment {
+    kind: "go";
+}
+export interface RustDeployment {
+    kind: "rust";
+}
+export interface JavaDeployment {
+    kind: "java";
+    mode: "class" | "jar" | "quarkus";
+}
+export interface RubyDeployment {
+    kind: "ruby";
+    command: readonly string[];
+}
+export interface PhpDeployment {
+    kind: "php";
+}
+export interface DotnetDeployment {
+    kind: "dotnet";
+    aspnet: boolean;
+    dll: string;
+}
+export interface CustomDeployment {
+    kind: "custom";
+}
+export type Deployment = BunDeployment | CustomDeployment | DenoDeployment | DotnetDeployment | GoDeployment | JavaDeployment | JavaScriptDeployment | JavaScriptSourceDeployment | PythonDeployment | PhpDeployment | RubyDeployment | RustDeployment;
+export interface FrameworkDefault {
+    displayName: string;
+    language: string;
+    stackType: StackType;
+    defaultPort: number;
+    defaultRuntime: string;
+    defaultVersion: string;
+    status: FrameworkStatus;
+    deployment?: Deployment;
+}
+export declare const FRAMEWORK_DEFAULTS: {
+    readonly express: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-source";
+            readonly build: false;
+            readonly entrypoint: "server.js";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly nest: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-source";
+            readonly build: true;
+            readonly entrypoint: "dist/main.js";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly fastify: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-source";
+            readonly build: false;
+            readonly entrypoint: "server.js";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly koa: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-source";
+            readonly build: false;
+            readonly entrypoint: "server.js";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly deno: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "deno-source";
+            readonly entrypoint: "main.ts";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly bun: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "bun-source";
+            readonly entrypoint: "server.ts";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly django: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "python";
+            readonly command: readonly ["gunicorn", "config.wsgi:application", "--bind", "0.0.0.0:8000"];
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly flask: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "python";
+            readonly command: readonly ["gunicorn", "app:app", "--bind", "0.0.0.0:8000"];
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly fastapi: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "python";
+            readonly command: readonly ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "8000"];
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly python: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "python";
+            readonly command: readonly ["gunicorn", "app:app", "--bind", "0.0.0.0:8000"];
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly go: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "go";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly gin: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "go";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly echo: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "go";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly rust: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "rust";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly actix: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "rust";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly rocket: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "rust";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly java: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "java";
+            readonly mode: "class";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly springBoot: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "java";
+            readonly mode: "jar";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly quarkus: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "java";
+            readonly mode: "quarkus";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly ruby: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "ruby";
+            readonly command: readonly ["ruby", "app.rb"];
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly rails: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "ruby";
+            readonly command: readonly ["bundle", "exec", "rails", "server", "-b", "0.0.0.0", "-p", "3000"];
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly php: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "php";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly laravel: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "php";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly symfony: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "php";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly csharp: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "dotnet";
+            readonly aspnet: false;
+            readonly dll: "App.dll";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly aspnet: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "dotnet";
+            readonly aspnet: true;
+            readonly dll: "App.dll";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly other: {
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "custom";
+        };
+        readonly displayName: string;
+        readonly language: string;
+        readonly stackType: StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly html: FrameworkDefault;
+    readonly react: FrameworkDefault;
+    readonly vue: FrameworkDefault;
+    readonly angular: FrameworkDefault;
+    readonly svelte: FrameworkDefault;
+    readonly vite: FrameworkDefault;
+    readonly gatsby: FrameworkDefault;
+    readonly solid: FrameworkDefault;
+    readonly next: {
+        readonly displayName: "Next.js";
+        readonly language: "TypeScript";
+        readonly stackType: "fullstack";
+        readonly defaultPort: 3000;
+        readonly defaultRuntime: "node";
+        readonly defaultVersion: "24.18.0-trixie-slim";
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-artifact";
+            readonly selfContained: true;
+            readonly copies: readonly [readonly ["/app/public", "./public"], readonly ["/app/.next/standalone", "./"], readonly ["/app/.next/static", "./.next/static"]];
+            readonly entrypoint: "server.js";
+        };
+    };
+    readonly nuxt: {
+        readonly displayName: "Nuxt";
+        readonly language: "TypeScript";
+        readonly stackType: "fullstack";
+        readonly defaultPort: 3000;
+        readonly defaultRuntime: "node";
+        readonly defaultVersion: "24.18.0-trixie-slim";
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-artifact";
+            readonly selfContained: true;
+            readonly copies: readonly [readonly ["/app/.output", "./.output"]];
+            readonly entrypoint: ".output/server/index.mjs";
+        };
+    };
+    readonly astro: {
+        readonly displayName: "Astro";
+        readonly language: "TypeScript";
+        readonly stackType: "fullstack";
+        readonly defaultPort: 3000;
+        readonly defaultRuntime: "node";
+        readonly defaultVersion: "24.18.0-trixie-slim";
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-artifact";
+            readonly selfContained: false;
+            readonly copies: readonly [readonly ["/app/dist", "./dist"]];
+            readonly entrypoint: "dist/server/entry.mjs";
+        };
+    };
+    readonly sveltekit: {
+        readonly displayName: "SvelteKit";
+        readonly language: "TypeScript";
+        readonly stackType: "fullstack";
+        readonly defaultPort: 3000;
+        readonly defaultRuntime: "node";
+        readonly defaultVersion: "24.18.0-trixie-slim";
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-artifact";
+            readonly selfContained: false;
+            readonly copies: readonly [readonly ["/app/build", "./build"]];
+            readonly entrypoint: "build/index.js";
+        };
+    };
+    readonly remix: {
+        readonly displayName: "Remix";
+        readonly language: "TypeScript";
+        readonly stackType: "fullstack";
+        readonly defaultPort: 3000;
+        readonly defaultRuntime: "node";
+        readonly defaultVersion: "24.18.0-trixie-slim";
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-artifact";
+            readonly selfContained: false;
+            readonly copies: readonly [readonly ["/app/build", "./build"]];
+            readonly entrypoint: "node_modules/@remix-run/serve/dist/cli.js";
+            readonly entrypointArgument: "build/server/index.js";
+        };
+    };
+    readonly qwik: {
+        readonly displayName: "Qwik";
+        readonly language: "TypeScript";
+        readonly stackType: "fullstack";
+        readonly defaultPort: 3000;
+        readonly defaultRuntime: "node";
+        readonly defaultVersion: "24.18.0-trixie-slim";
+        readonly status: "supported";
+        readonly deployment: {
+            readonly kind: "js-artifact";
+            readonly selfContained: false;
+            readonly copies: readonly [readonly ["/app/dist", "./dist"], readonly ["/app/server", "./server"]];
+            readonly entrypoint: "server/entry.node-server.js";
+        };
+    };
+};
+export type FrameworkId = keyof typeof FRAMEWORK_DEFAULTS;
+export declare function getJavaScriptDeployment(framework: Framework): JavaScriptDeployment;
+export declare function defaultVersionFor(runtime: Runtime): string;