@flisk-sh/flisk-export 0.4.1 → 0.5.0

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`, `envFile`, `profiles`, `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

@@ -15,6 +15,10 @@ 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 TMPFS = /^\/[A-Za-z0-9_./-]*(:[a-z0-9=,_-]+)?$/;
+const CPUS = /^[0-9]+(\.[0-9]{1,2})?$/;
+const MEMORY = /^[0-9]+([bBkKmMgG][bB]?)?$/;
+const PROFILE = /^[a-z0-9][a-z0-9-]*$/;
 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";
@@ -192,6 +196,42 @@ function serviceLines(resource, outDir, services) {
         }
         lines.push(`    shm_size: ${q(container.shmSize)}`);
     }
+    const tmpfs = strings(container.tmpfs);
+    if (tmpfs.length > 0) {
+        for (const t of tmpfs) {
+            if (!TMPFS.test(t))
+                throw new ExportError(`${name}: tmpfs "${t}" is not /path or /path:options`);
+        }
+        lines.push("    tmpfs:", ...tmpfs.map((t) => `      - ${q(t)}`));
+    }
+    const cpus = container.cpus === undefined ? undefined : String(container.cpus);
+    const memory = typeof container.memory === "string" ? container.memory : undefined;
+    if (cpus !== undefined && !CPUS.test(cpus))
+        throw new ExportError(`${name}: cpus "${cpus}" is not a number of CPUs`);
+    if (memory !== undefined && !MEMORY.test(memory))
+        throw new ExportError(`${name}: memory "${memory}" is not a size such as 2g`);
+    if (cpus !== undefined || memory !== undefined) {
+        lines.push("    deploy:", "      resources:", "        limits:", ...(cpus !== undefined ? [`          cpus: ${q(cpus)}`] : []), ...(memory !== undefined ? [`          memory: ${q(memory)}`] : []));
+    }
+    // Paths in envFile are relative to the service directory; a missing file is skipped, as Flisk does.
+    const envFiles = strings(c.envFile);
+    if (envFiles.length > 0) {
+        lines.push("    env_file:");
+        for (const file of envFiles) {
+            if (!/^[A-Za-z0-9_.-]+(\/[A-Za-z0-9_.-]+)*$/.test(file)) {
+                throw new ExportError(`${name}: envFile "${file}" is not a relative path`);
+            }
+            lines.push(`      - path: ${q(hostPath(outDir, resolveFrom(resource.path, file)))}`, "        required: false");
+        }
+    }
+    const profiles = strings(c.profiles);
+    if (profiles.length > 0) {
+        for (const p of profiles) {
+            if (!PROFILE.test(p))
+                throw new ExportError(`${name}: profile "${p}" is not a profile name`);
+        }
+        lines.push("    profiles:", ...profiles.map((p) => `      - ${q(p)}`));
+    }
     return { lines, namedVolumes, models };
 }
 /** What Compose waits for before starting a dependent: a passing check, a finished one-shot job, or the start. */
@@ -282,7 +322,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.1",
+  "version": "0.5.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",