@flisk-sh/flisk-import 0.8.0 → 0.10.0

package/README.md

@@ -12,6 +12,7 @@ flisk import . --yes         # write service.json files and project setup
 
 - **Reads one file:** the root `docker-compose.yml`, or `compose.yaml`, `compose.yml` or `docker-compose.yaml` when that is absent. Not override files, nested Compose files, Dockerfiles on their own, `package.json`, or Procfiles.
 - **Writes:** one bring-your-own `service.json` per Compose service, plus `.flisk/project.json` if the repo is not a Flisk project yet. It never edits the Compose file or overwrites a `service.json` without `--force`.
+- **Keeps the install's data:** each named volume gets `name`, the Docker volume `docker compose up` created (`<project>_<volume>`, its own `name:`, or an `external` volume), so `flisk up` mounts the same data with no copy (needs the Flisk release with flisk#2964).
 - **Keeps:** the service names (`db` stays `db`, so it stays the hostname), the build context and Dockerfile (or the image), the container port as written (3000, 80, 5432), `depends_on`, and an HTTP health path. Databases and brokers are private, with no proxy route.
 - **Runtime keys:** named volumes and bind mounts inside the project (`volumes`), `cap_add`, `cap_drop`, `init`, `read_only`, `user`, `security_opt` and `shm_size` (`container`), extra published ports (`extraPorts`, on 127.0.0.1 only), `network_mode: service:<name>` (`sidecarOf`) and `restart`.
 - **Environment:** values that cannot be secrets go into the committed `service.json` `env`: numbers, `true`/`false`, another imported service's address without a user, password or query (`http://invidious:3000`, `redis:6379`), and pure `${VAR}` references. Every other name, and any name that looks like a credential (`PASSWORD`, `TOKEN`, `KEY`, ...), goes into `secrets.required`, with its literal value copied to the project `.env`, which is added to `.gitignore`. Values in `.env` already are kept.

package/dist/detectors/compose.js

@@ -1,5 +1,5 @@
 import { readFileSync } from "node:fs";
-import { dirname, isAbsolute, join, normalize } from "node:path/posix";
+import { basename, dirname, isAbsolute, join, normalize } from "node:path/posix";
 import { isAlias, isMap, parseDocument, visit } from "yaml";
 import { HEALTH_CHECK_PATH_PATTERN } from "../flisk.js";
 import { registerDetector } from "../registry.js";
@@ -46,6 +46,7 @@ const TRANSLATED_KEYS = new Set([
     "restart",
     "command",
     "entrypoint",
+    "models",
     // Flisk gives every service its own stack network and container name, so these change nothing it needs.
     "networks",
     "expose",
@@ -188,6 +189,26 @@ function volumeOf(entry, composeDir) {
         return undefined;
     return { source: resolved, target, ...(readOnly ? { readOnly } : {}), bind };
 }
+/** Compose's project name: top-level `name`, else the directory name, lowercased with other characters dropped. */
+function projectNameOf(root, absPath) {
+    const raw = isObj(root) && typeof root.name === "string" && !root.name.includes("$")
+        ? root.name
+        : basename(dirname(absPath));
+    const name = raw.toLowerCase().replace(/[^a-z0-9_-]/g, "");
+    return /^[a-z0-9]/.test(name) ? name : undefined;
+}
+/**
+ * The Docker name of a named volume, as `docker compose up` created it: its own `name:`, the key itself when it is
+ * `external`, else `<project>_<key>`. Undefined when the name uses Compose variables.
+ */
+function dockerVolumeName(key, volumes, project) {
+    const def = isObj(volumes) ? volumes[key] : undefined;
+    if (isObj(def) && typeof def.name === "string")
+        return /^[A-Za-z0-9][A-Za-z0-9_.-]*$/.test(def.name) ? def.name : undefined;
+    if (isObj(def) && (def.external === true || isObj(def.external)))
+        return key;
+    return project ? `${project}_${key}` : undefined;
+}
 function envNames(environment) {
     if (Array.isArray(environment)) {
         return environment
@@ -290,6 +311,20 @@ function healthProbeOf(healthcheck) {
         ...(retries ? { retries } : {}),
     };
 }
+/** The models a service uses, joined to their top-level definitions. A model without a literal `model` is skipped. */
+function modelsOf(uses, defined) {
+    const names = Array.isArray(uses) ? uses : isObj(uses) ? Object.keys(uses) : [];
+    const out = [];
+    for (const name of names) {
+        const def = isObj(defined) && typeof name === "string" ? defined[name] : undefined;
+        if (typeof name === "string" &&
+            isObj(def) &&
+            typeof def.model === "string" &&
+            /^[A-Za-z0-9_.-]+$/.test(name))
+            out.push({ name, model: def.model });
+    }
+    return out.length ? out : undefined;
+}
 function healthPathOf(healthcheck) {
     if (!isObj(healthcheck) || !Array.isArray(healthcheck.test))
         return undefined;
@@ -343,6 +378,7 @@ registerDetector({
         if (!services || !isMap(doc.get("services", true))) {
             return { candidates, skips: [...skips, { ...base, reason: "no `services:` map" }] };
         }
+        const project = projectNameOf(root, absPath);
         for (const [name, raw] of Object.entries(services)) {
             if (!isObj(raw)) {
                 skips.push({ ...base, reason: `service "${name}" is not a map` });
@@ -417,6 +453,7 @@ registerDetector({
                     ? Object.keys(raw.depends_on)
                     : [];
             const command = commandOf(raw.command);
+            const models = modelsOf(raw.models, isObj(root) ? root.models : undefined);
             const containerCommand = containerCommandOf(raw.command);
             const containerEntrypoint = containerCommandOf(raw.entrypoint);
             const healthProbe = healthProbeOf(raw.healthcheck);
@@ -461,8 +498,11 @@ registerDetector({
             const volumes = [];
             for (const entry of Array.isArray(raw.volumes) ? raw.volumes : []) {
                 const volume = volumeOf(entry, composeDir);
+                const dockerName = volume && !volume.bind
+                    ? dockerVolumeName(volume.source, isObj(root) ? root.volumes : undefined, project)
+                    : undefined;
                 if (volume)
-                    volumes.push(volume);
+                    volumes.push(dockerName ? { ...volume, name: dockerName } : volume);
                 else
                     skips.push({
                         ...base,
@@ -508,6 +548,7 @@ registerDetector({
                 ...(command ? { command } : {}),
                 ...(containerCommand ? { containerCommand } : {}),
                 ...(containerEntrypoint ? { containerEntrypoint } : {}),
+                ...(models ? { models } : {}),
                 ...(healthProbe ? { healthCheck: healthProbe } : {}),
                 ...(selectedPort !== undefined ? { port: selectedPort } : {}),
                 ...(healthCheckPath ? { healthCheckPath } : {}),

package/dist/merge.js

@@ -73,6 +73,7 @@ function mergeGroup(name, dir, members, resolve) {
         ...firstOf(ordered, "restart"),
         ...firstOf(ordered, "containerCommand"),
         ...firstOf(ordered, "containerEntrypoint"),
+        ...firstOf(ordered, "models"),
         ...firstOf(ordered, "healthCheck"),
         ...(ordered.find((c) => c.sidecarOf)?.sidecarOf
             ? { sidecarOf: resolve(ordered.find((c) => c.sidecarOf)?.sidecarOf) }

package/dist/write.js

@@ -271,14 +271,17 @@ export function planWrites(plan, force) {
             ...(secretNames.length ? { secrets: { required: secretNames } } : {}),
             ...(service.restart ? { restart: service.restart } : {}),
             ...(service.container ? { container: service.container } : {}),
+            ...(service.models ? { models: service.models } : {}),
             ...(extraPorts.length ? { extraPorts } : {}),
             ...(sidecarOf ? { sidecarOf } : {}),
             ...(volumes.length
                 ? {
-                    volumes: volumes.map(({ source, target, readOnly }) => ({
+                    // `name` keeps the Docker volume the Compose install already has, so its data is used with no copy.
+                    volumes: volumes.map(({ source, target, readOnly, name }) => ({
                         source,
                         target,
                         ...(readOnly ? { readOnly } : {}),
+                        ...(name ? { name } : {}),
                     })),
                 }
                 : {}),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk-sh/flisk-import",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Import a repository's root docker-compose.yml into Flisk service.json files, or register its Tiltfile.",
   "type": "module",
   "license": "MIT",