@flisk-sh/flisk-export 0.4.0 → 0.4.2

package/README.md

@@ -45,7 +45,7 @@ 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`, `models`, `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 without Flisk (`docker compose --env-file .env -f .autogenerated/docker-compose.yml up -d` from the project root, since Compose looks for `.env` next to the file it reads): 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`.

package/dist/compose.js

@@ -7,6 +7,8 @@
  */
 import { relative, sep } from "node:path";
 import { ExportError } from "./errors.js";
+/** extraPorts `publish`: digits, dots, colons and `${NAME:-default}`, as flisk core accepts it (flisk#2947). */
+const PUBLISH = /^(?:[0-9.:]|\$\{[A-Za-z_][A-Za-z0-9_]*:-[0-9.:]+\})+$/;
 /** The only resource type the Compose export covers: it is the one whose service.json is a Compose service. */
 export const COMPOSE_TYPE = "bring-your-own";
 const RESTART_POLICIES = new Set(["no", "on-failure", "unless-stopped", "always"]);
@@ -130,9 +132,20 @@ function serviceLines(resource, outDir, services) {
             if (!Number.isInteger(port) || port < 1 || port > 65535) {
                 throw new ExportError(`${name}: extraPorts needs a port from 1 to 65535`);
             }
-            const hostPort = p.hostPort === undefined ? port : Number(p.hostPort);
-            const bind = typeof p.bind === "string" && p.bind ? p.bind : "127.0.0.1";
             const protocol = p.protocol === "udp" ? "udp" : "tcp";
+            // `publish` (flisk#2947): the host side as the project's Compose wrote it, e.g. "${APP_HTTP_BIND:-80}"; Compose resolves it.
+            if (p.publish !== undefined) {
+                if (typeof p.publish !== "string" || !PUBLISH.test(p.publish)) {
+                    throw new ExportError(`${name}: extraPorts publish must be a port, an IPv4 address:port, or \${NAME:-default}`);
+                }
+                lines.push(`      - ${q(`${p.publish}:${port}/${protocol}`)}`);
+                continue;
+            }
+            const hostPort = p.hostPort === undefined ? port : Number(p.hostPort);
+            const bind = p.bind === undefined ? "127.0.0.1" : p.bind;
+            if (bind !== "127.0.0.1" && bind !== "0.0.0.0") {
+                throw new ExportError(`${name}: extraPorts bind must be 127.0.0.1 or 0.0.0.0`);
+            }
             lines.push(`      - ${q(`${bind}:${hostPort}:${port}/${protocol}`)}`);
         }
     }
@@ -269,7 +282,9 @@ export function buildCompose(outDir, resources) {
         "# GENERATED by `flisk export compose` from the service.json files. DO NOT EDIT.",
         "# Change service.json and run `flisk export compose --force`; CI can run",
         "# `flisk export compose --check` to fail when this file is out of date.",
-        "# Runs with plain `docker compose up`; Flisk is not needed to start it.",
+        "# Flisk is not needed to start it. Compose reads .env from this file's folder,",
+        "# so from the project root pass the project's .env:",
+        "#   docker compose --env-file .env -f .autogenerated/docker-compose.yml up -d",
         "###############################################################################",
         "",
         // Without a name Compose takes the folder's (autogenerated), so containers and unnamed volumes would not match the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk-sh/flisk-export",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "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",