@flisk-sh/flisk-export 0.2.1 → 0.4.0

package/README.md

@@ -45,8 +45,9 @@ flisk-export compose --check    # exit 1 when that file is out of date (for CI)
 ```
 
 Writes a **standalone** `docker-compose.yml` from the bring-your-own `service.json` files (`image` or `dockerfile`, `env`,
-`secrets.required`, `volumes`, `extraPorts`, `dependsOn`, `healthCheck`, `sidecarOf`, `container`). It runs with plain `docker compose up` and no Flisk: no external
+`secrets.required`, `models`, `volumes`, `extraPorts`, `dependsOn`, `healthCheck`, `sidecarOf`, `container`). It runs with plain `docker compose up` and no Flisk: no external
 networks, no `FLISK_*` variables, no generated secrets. `${VAR}` references in `env`, and every name in `secrets.required`, pass through as `${NAME}` for Compose to read from `.env`.
+A volume's `name` (the Docker volume an install already has) is kept, and the project is named after its stack, so `docker compose up` finds the same data as before.
 `healthCheck.command` becomes a Compose `healthcheck`; a service that lists a checked service in `dependsOn` waits for `service_healthy`, and one that lists a `restart: "no"` job waits for `service_completed_successfully`.
 Other resource types and `command` (native) services are not exported. The file is generated: change `service.json` and run it
 again with `--force`. It never starts a container or calls an API.

package/dist/compose.js

@@ -13,6 +13,7 @@ const RESTART_POLICIES = new Set(["no", "on-failure", "unless-stopped", "always"
 const SERVICE_NAME = /^[a-z0-9][a-z0-9_.-]*$/i;
 const ENV_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
 const SHM_SIZE = /^\d+(b|k|kb|m|mb|g|gb)?$/i;
+const DOCKER_NAME = /^[A-Za-z0-9][A-Za-z0-9_.-]*$/;
 export function isComposeExportable(resource) {
     return resource.type === COMPOSE_TYPE && typeof resource.config.command !== "string";
 }
@@ -50,7 +51,8 @@ function serviceLines(resource, outDir, services) {
         ]);
     }
     const lines = [`  ${name}:`];
-    const namedVolumes = new Set();
+    const namedVolumes = new Map();
+    const models = new Map();
     const image = typeof c.image === "string" && c.image ? c.image : undefined;
     const dockerfile = typeof c.dockerfile === "string" && c.dockerfile ? c.dockerfile : undefined;
     const buildContext = typeof c.buildContext === "string" ? c.buildContext : undefined;
@@ -104,7 +106,11 @@ function serviceLines(resource, outDir, services) {
             }
             let source = v.source;
             if (isNamedVolume(source)) {
-                namedVolumes.add(source);
+                const dockerName = typeof v.name === "string" ? v.name : undefined;
+                if (dockerName !== undefined && !DOCKER_NAME.test(dockerName)) {
+                    throw new ExportError(`${name}: volume name "${dockerName}" is not a Docker volume name`);
+                }
+                namedVolumes.set(source, dockerName ?? namedVolumes.get(source));
             }
             else {
                 source = hostPath(outDir, resolveFrom(resource.path, source));
@@ -138,6 +144,21 @@ function serviceLines(resource, outDir, services) {
         }
     }
     lines.push(...healthcheckLines(name, c.healthCheck));
+    // Docker Model Runner: the service lists model names, the top-level `models` block says which model each is.
+    const modelRefs = (Array.isArray(c.models) ? c.models : []).map(record);
+    if (modelRefs.length > 0) {
+        lines.push("    models:");
+        for (const ref of modelRefs) {
+            if (typeof ref.name !== "string" || !ENV_NAME.test(ref.name.replace(/[-.]/g, "_"))) {
+                throw new ExportError(`${name}: a model needs a name of letters, digits, dashes and dots`);
+            }
+            if (typeof ref.model !== "string" || !ref.model) {
+                throw new ExportError(`${name}: model "${ref.name}" needs a model reference`);
+            }
+            lines.push(`      - ${q(ref.name)}`);
+            models.set(ref.name, ref.model);
+        }
+    }
     const capAdd = strings(container.capAdd);
     const capDrop = strings(container.capDrop);
     const securityOpt = strings(container.securityOpt);
@@ -158,7 +179,7 @@ function serviceLines(resource, outDir, services) {
         }
         lines.push(`    shm_size: ${q(container.shmSize)}`);
     }
-    return { lines, namedVolumes };
+    return { lines, namedVolumes, models };
 }
 /** What Compose waits for before starting a dependent: a passing check, a finished one-shot job, or the start. */
 function dependencyCondition(dep) {
@@ -224,13 +245,24 @@ export function buildCompose(outDir, resources) {
         ]);
     }
     const known = new Map(services.map((s) => [s.name, s]));
+    const stacks = new Set(services
+        .map((s) => s.config.stack)
+        .filter((v) => typeof v === "string" && /^[a-z0-9][a-z0-9_-]*$/.test(v)));
     const body = [];
-    const volumes = new Set();
+    const volumes = new Map();
+    const models = new Map();
     for (const service of services) {
         const built = serviceLines(service, outDir, known);
         body.push(...built.lines, "");
-        for (const v of built.namedVolumes)
-            volumes.add(v);
+        for (const [v, dockerName] of built.namedVolumes) {
+            const known = volumes.get(v);
+            if (known && dockerName && known !== dockerName) {
+                throw new ExportError(`volume "${v}" is given two names, "${known}" and "${dockerName}"`);
+            }
+            volumes.set(v, dockerName ?? known);
+        }
+        for (const [n, m] of built.models)
+            models.set(n, m);
     }
     const header = [
         "###############################################################################",
@@ -240,8 +272,29 @@ export function buildCompose(outDir, resources) {
         "# Runs with plain `docker compose up`; Flisk is not needed to start it.",
         "###############################################################################",
         "",
+        // Without a name Compose takes the folder's (autogenerated), so containers and unnamed volumes would not match the
+        // project the app had before. One stack gives the project its name.
+        ...(stacks.size === 1 ? [`name: ${q([...stacks][0])}`, ""] : []),
         "services:",
     ];
-    const tail = volumes.size > 0 ? ["volumes:", ...[...volumes].sort().map((v) => `  ${v}:`), ""] : [];
+    const tail = [
+        ...(models.size > 0
+            ? [
+                "models:",
+                ...[...models].sort().flatMap(([n, m]) => [`  ${n}:`, `    model: ${q(m)}`]),
+                "",
+            ]
+            : []),
+        // A volume with a name keeps the Docker volume an existing install has, so its data is used as it is.
+        ...(volumes.size > 0
+            ? [
+                "volumes:",
+                ...[...volumes]
+                    .sort(([a], [b]) => a.localeCompare(b))
+                    .flatMap(([v, dockerName]) => dockerName ? [`  ${v}:`, `    name: ${q(dockerName)}`] : [`  ${v}:`]),
+                "",
+            ]
+            : []),
+    ];
     return [...header, ...body, ...tail].join("\n").replace(/\n{3,}/g, "\n\n");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk-sh/flisk-export",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Write a Render Blueprint (render.yaml), a Cloudflare wrangler.toml or a standalone docker-compose.yml from Flisk service.json files. Never deploys.",
   "type": "module",
   "license": "MIT",