nept-frameworks 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,458 @@
+import * as dockerfileGenerator from "./lib/dockerfile-generator";
+import * as nextDockerfileGenerator from "./lib/next-js/next-dockerfile-generator";
+import * as frameworkDefaults from "./framework-defaults";
+export declare const detectPackageManager: typeof dockerfileGenerator.detectPackageManager;
+export declare const DOCKERIGNORE = "node_modules\n.next\n.nuxt\n.output\ndist\nbuild\n.svelte-kit\n.astro\n.git\n.env*\n!.env.example\ncoverage\n*.log\n";
+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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.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: frameworkDefaults.StackType;
+        readonly defaultPort: number;
+        readonly defaultRuntime: string;
+        readonly defaultVersion: string;
+    };
+    readonly html: frameworkDefaults.FrameworkDefault;
+    readonly react: frameworkDefaults.FrameworkDefault;
+    readonly vue: frameworkDefaults.FrameworkDefault;
+    readonly angular: frameworkDefaults.FrameworkDefault;
+    readonly svelte: frameworkDefaults.FrameworkDefault;
+    readonly vite: frameworkDefaults.FrameworkDefault;
+    readonly gatsby: frameworkDefaults.FrameworkDefault;
+    readonly solid: frameworkDefaults.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 declare const generateDockerfile: typeof dockerfileGenerator.generateDockerfile;
+export declare const generateNextDockerfile: typeof nextDockerfileGenerator.generateNextDockerfile;
+export declare const NEXT_DOCKERIGNORE = "node_modules\n.next\n.nuxt\n.output\ndist\nbuild\n.svelte-kit\n.astro\n.git\n.env*\n!.env.example\ncoverage\n*.log\n";
+export type { FrameworkDefault, FrameworkId, FrameworkStatus, StackType, } from "./framework-defaults";
+export type { CustomDockerPlan, DockerfileParams, Framework, NextDockerfileParams, PackageManager, Runtime, } from "./types/dockerfile";