@flisk-sh/flisk-import 0.2.2 → 0.2.4

package/README.md

@@ -1,24 +1,60 @@
-# tdk import
+# flisk import
 
-Import the services in a repo's root `docker-compose.yml` into [TDK](https://github.com/flisk-sh/flisk) as `service.json` files. This is the Compose first tier of flisk-sh/flisk#511.
+Import the services in a repo's root `docker-compose.yml` into [Flisk](https://github.com/flisk-sh/flisk) as `service.json` files. This is the Compose first tier of flisk-sh/flisk#511.
 
 ```bash
-tdk import . --dry-run     # plan only
-tdk import .               # plan, then ask before writing
-tdk import . --yes         # write service.json files and project setup
+flisk import . --dry-run     # plan only
+flisk import .               # plan, then ask before writing
+flisk import . --yes         # write service.json files and project setup
 ```
 
 ## What to expect
 
 - **Reads one file:** the root `docker-compose.yml`. Not `compose.yaml`, override files, nested Compose files, Dockerfiles on their own, `package.json`, or Procfiles.
-- **Writes:** one bring-your-own `service.json` per Compose service, plus `.tdk/project.json` if the repo is not a TDK project yet. It never edits the Compose file or overwrites a `service.json` without `--force`.
+- **Writes:** one bring-your-own `service.json` per Compose service, plus `.tdk/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 build context and Dockerfile (or the image), the container port, `depends_on`, and an HTTP health path. Databases and brokers are private, with no proxy route.
 - **Drops, and says so:** env values, volumes, `command`, `env_file` and every other untranslated key; services with `profiles`, `extends`, an out-of-tree build or a `${VAR}` image.
-- **Does not start anything.** Put env values in `.env`, then run `tdk up` with TDK core **1.3.145 or later**. The importer does not check the core version.
+- **Does not start anything.** Put env values in `.env`, then run `flisk up` with Flisk core **1.3.145 or later**. The importer does not check the core version.
 - **Exit codes:** `0` when the plan succeeds (`--dry-run`, files written, or all `service.json` files already exist), `1` when no root `docker-compose.yml` or mappable service is found, and `2` when the write prompt is declined or closed without an answer (`Nothing written.`).
 
-See [docs/import.md](docs/import.md) for the full mapping and limits. `tdk import` is the core CLI command backed by this package.
+See [docs/import.md](docs/import.md) for the full mapping and limits. `flisk import` is the core CLI command backed by this package.
 
 ```bash
 bun install && bun run build && bun run test
 ```
+
+## Publishing
+
+`flisk-import` is published to npmjs.org by the workflow in
+[`.github/workflows/publish-npm.yml`](.github/workflows/publish-npm.yml), triggered by a
+GitHub release. It uses **npm trusted publishing (OIDC)**, so no long-lived npm token
+lives in this repository. The package is published under two names: the unscoped
+`flisk-import` and the scoped `@flisk-sh/flisk-import` (the same archive with the name
+rewritten in the packed manifest).
+
+### One-time owner setup
+
+A trusted publisher has to exist on npm before the first OIDC publish succeeds, and it is
+configured per package name:
+
+1. Open the package on npmjs.com → **Settings** → **Trusted Publisher** → **GitHub Actions**
+2. Fill in:
+   - Organization: `flisk-sh`
+   - Repository: `flisk-import`
+   - Workflow filename: `publish-npm.yml`
+   - Allowed actions: `npm publish`
+3. Repeat for `@flisk-sh/flisk-import` once that package exists
+
+The same thing from the command line, for either name:
+
+```bash
+npm trust github flisk-import --file publish-npm.yml --repo flisk-sh/flisk-import --allow-publish
+npm trust list flisk-import
+```
+
+### The first version
+
+A package's first version cannot be published through OIDC — npm has no trusted publisher
+for a name that does not exist yet. Version 0.2.2 was therefore published once with a
+token; every version after that publishes over OIDC from the release workflow.
+

package/dist/cli.js

@@ -25,7 +25,7 @@ async function confirm(message) {
 }
 const program = new Command("flisk-import")
     .version(JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8")).version)
-    .description("Import services from the root docker-compose.yml into TDK")
+    .description("Import services from the root docker-compose.yml into Flisk")
     .argument("[dir]", "Directory containing docker-compose.yml", ".")
     .option("--dry-run", "Print the plan and write nothing", false)
     .option("--yes", "Write without prompting", false)
@@ -60,7 +60,7 @@ const program = new Command("flisk-import")
     console.log("\nNext:");
     if (plan.services.some((s) => s.envKeys.length))
         console.log(`  - Put the environment values these services need in ${envFile}; values in docker-compose.yml were not copied.`);
-    console.log(`  - Run \`tdk up\` with TDK core ${MIN_CORE_VERSION} or later. The import did not start anything.`);
+    console.log(`  - Run \`flisk up\` with Flisk core ${MIN_CORE_VERSION} or later. The import did not start anything.`);
 });
 try {
     await program.parseAsync();

package/dist/detectors/compose.js

@@ -21,7 +21,7 @@ const NON_HTTP_PORTS = new Set([
     22, 25, 1883, 2181, 3306, 5432, 5672, 6379, 9092, 9200, 11211, 27017,
 ]);
 /**
- * Service keys this detector translates. Every other key is named in the report: TDK runs a
+ * Service keys this detector translates. Every other key is named in the report: Flisk runs a
  * bring-your-own container without volumes, command overrides, env files and the rest.
  * `healthcheck` only contributes an HTTP path; `environment` only contributes names.
  */
@@ -116,7 +116,7 @@ registerDetector({
             if (raw.profiles !== undefined) {
                 skips.push({
                     ...base,
-                    reason: `service "${name}" has profiles ${JSON.stringify(raw.profiles)}; profiles are not enforced by TDK`,
+                    reason: `service "${name}" has profiles ${JSON.stringify(raw.profiles)}; profiles are not enforced by Flisk`,
                 });
                 continue;
             }
@@ -166,7 +166,7 @@ registerDetector({
             else if (ports.length > 1) {
                 skips.push({
                     ...base,
-                    reason: `service "${name}" publishes extra container ports (${ports.filter((port) => port !== selectedPort).join(", ")}); TDK routes only ${selectedPort}`,
+                    reason: `service "${name}" publishes extra container ports (${ports.filter((port) => port !== selectedPort).join(", ")}); Flisk routes only ${selectedPort}`,
                 });
             }
             const dependsOn = Array.isArray(raw.depends_on)
@@ -183,7 +183,7 @@ registerDetector({
             if (foundHealthPath && !healthCheckPath) {
                 skips.push({
                     ...base,
-                    reason: `service "${name}" health path "${foundHealthPath}" has characters TDK does not accept (only a-z, 0-9, / and -); not used`,
+                    reason: `service "${name}" health path "${foundHealthPath}" has characters Flisk does not accept (only a-z, 0-9, / and -); not used`,
                 });
             }
             const untranslated = Object.keys(raw).filter((key) => !TRANSLATED_KEYS.has(key));

package/dist/format.js

@@ -10,7 +10,7 @@ export function formatPlan(plan, writes) {
     const jobs = plan.services.filter((s) => s.kind === "job").length;
     out.push(`Found ${plan.services.length - jobs} service(s) and ${jobs} job(s) in ${plan.root}`, `Read only: ${plan.files.join(", ")}. Lines below name what was not translated.`, "");
     if (writes.projectConfig)
-        out.push(`  .tdk/project.json  [create TDK project]`, "");
+        out.push(`  .tdk/project.json  [create Flisk project]`, "");
     for (const service of plan.services) {
         const item = writes.items.find((i) => i.service === service);
         out.push(`  ${service.name}  (${service.kind}${service.dir ? `, ${service.dir}/` : ""})`);

package/dist/plan.js

@@ -29,11 +29,11 @@ export function buildPlan(dir) {
     const isFile = (name) => statSync(resolve(root, name), { throwIfNoEntry: false })?.isFile() ?? false;
     if (!isFile(composePath)) {
         const others = OTHER_COMPOSE_FILES.filter(isFile);
-        throw new ImportError(`No root docker-compose.yml found in ${root}${others.length ? ` (found ${others.join(", ")})` : ""}; tdk import reads only that file`, others.length
+        throw new ImportError(`No root docker-compose.yml found in ${root}${others.length ? ` (found ${others.join(", ")})` : ""}; flisk import reads only that file`, others.length
             ? [
                 `Other Compose file names are not read yet. To import ${others[0]}, link it: ln -s ${others[0]} docker-compose.yml`,
             ]
-            : ["Run tdk import in the directory that holds docker-compose.yml"]);
+            : ["Run flisk import in the directory that holds docker-compose.yml"]);
     }
     for (const name of OTHER_COMPOSE_FILES.filter(isFile)) {
         skips.push({
@@ -46,7 +46,7 @@ export function buildPlan(dir) {
         skips.push({
             file: name,
             detector: "compose",
-            reason: `not applied; \`docker compose up\` merges it over ${COMPOSE_FILE}, tdk import does not`,
+            reason: `not applied; \`docker compose up\` merges it over ${COMPOSE_FILE}, flisk import does not`,
         });
     }
     for (const detector of detectors) {

package/dist/scan.js

@@ -7,7 +7,7 @@ export const HARD_SKIPS = new Set([
     "target",
     "dist",
     ".autogenerated",
-    // Output of `tdk project`: never a source of services.
+    // Output of `flisk project`: never a source of services.
     ".tdk",
     "shared-platform-engineering",
 ]);
@@ -83,15 +83,15 @@ export function scanTree(root, limits = { depth: MAX_DEPTH, files: MAX_FILES })
     const managed = [];
     let depthCapped = false;
     let fileCapped = false;
-    // In a TDK project, `services/` holds manifests and generated compose files, not sources.
+    // In a Flisk project, `services/` holds manifests and generated compose files, not sources.
     const isTdkProject = existsSync(join(root, ".tdk", "project.json"));
     if (isTdkProject)
-        notes.push("TDK project detected: services/ was not scanned");
+        notes.push("Flisk project detected: services/ was not scanned");
     const walk = (rel, depth, inherited) => {
         const abs = join(root, rel);
         const rules = [...inherited, ...readIgnoreRules(abs, rel, notes)];
         const entries = readdirSync(abs, { withFileTypes: true }).sort((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0);
-        // A directory with a service.json is already a TDK service (possibly written by an earlier
+        // A directory with a service.json is already a Flisk service (possibly written by an earlier
         // import, with a scaffolded Dockerfile): re-importing it would not be idempotent.
         if (rel !== "" && entries.some((e) => e.isFile() && e.name === "service.json")) {
             managed.push(rel);
@@ -127,7 +127,7 @@ export function scanTree(root, limits = { depth: MAX_DEPTH, files: MAX_FILES })
     };
     walk("", 0, []);
     if (managed.length) {
-        notes.push(`${managed.length} director${managed.length === 1 ? "y" : "ies"} with a service.json skipped (already TDK services)`);
+        notes.push(`${managed.length} director${managed.length === 1 ? "y" : "ies"} with a service.json skipped (already Flisk services)`);
     }
     if (depthCapped)
         notes.push(`directories deeper than ${limits.depth} levels were not scanned`);

package/dist/tdk.js

@@ -1,18 +1,18 @@
 import { existsSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
-/** Manifest constants of the TDK service.json this tool writes. */
+/** Manifest constants of the Flisk service.json this tool writes. */
 export const SERVICE_MANIFEST_SCHEMA_VERSION = 1;
 export const SERVICE_MANIFEST_SCHEMA_URL = "https://flisk.sh/schema.service.json";
 /**
- * Oldest TDK core that starts an imported project: 1.3.104 added `buildContext`, and 1.3.145
+ * Oldest Flisk core that starts an imported project: 1.3.104 added `buildContext`, and 1.3.145
  * (flisk#1018) bootstraps a project that has `.tdk/project.json` but no Tiltfile yet.
  * Stated, not checked: the importer does not read the installed core version.
  */
 export const MIN_CORE_VERSION = "1.3.145";
-/** TDK's bring-your-own port range. */
+/** Flisk's bring-your-own port range. */
 export const BYO_PORT_RANGE = { min: 4000, max: 5999, label: "4000-5999" };
 /**
- * Values TDK copies into generated Compose and Traefik config must match these, or `tdk up` refuses
+ * Values Flisk copies into generated Compose and Traefik config must match these, or `flisk up` refuses
  * the manifest (flisk `cli/src/utils/service-manifest.ts`, engine `manifest/parser.star`).
  */
 export const HEALTH_CHECK_PATH_PATTERN = /^\/[a-z0-9/-]*$/;

package/dist/write.js

@@ -14,7 +14,7 @@ function existingPort(path) {
     }
 }
 /**
- * Maps merged services onto TDK bring-your-own manifests. This is the only stage that knows the
+ * Maps merged services onto Flisk bring-your-own manifests. This is the only stage that knows the
  * layout `<project>/services/<stack>/<name>/service.json`. Nothing is written here.
  */
 /** Images that serve a protocol other than HTTP. Matched against the image name, not its tag. */
@@ -40,7 +40,7 @@ export function planWrites(plan, force) {
                 phases: {
                     pre_alpha: {
                         name: "Pre-Alpha",
-                        description: "TDK proxy and imported Compose services",
+                        description: "Flisk proxy and imported Compose services",
                         enabledStacks: ["proxy", stack],
                     },
                     alpha: { name: "Alpha", description: "", enabledStacks: [] },
@@ -71,7 +71,7 @@ export function planWrites(plan, force) {
                 : !service.image
                     ? "Compose gives it neither `image` nor a usable `build`"
                     : !IMAGE_PATTERN.test(service.image)
-                        ? `image "${service.image}" uses Compose variables or characters TDK does not accept; set a literal image in docker-compose.yml, or write this service.json by hand`
+                        ? `image "${service.image}" uses Compose variables or characters Flisk does not accept; set a literal image in docker-compose.yml, or write this service.json by hand`
                         : undefined;
         if (reason)
             rejected.push({ name: service.name, reason });
@@ -138,9 +138,9 @@ export function planWrites(plan, force) {
         if (service.envKeys.length)
             notes.push("environment values are not written; put them in the project .env");
         if (service.dockerfile && service.image)
-            notes.push(`image "${service.image}" is not written: with build and image, TDK builds from ${service.dockerfile} and does not pull the tag`);
+            notes.push(`image "${service.image}" is not written: with build and image, Flisk builds from ${service.dockerfile} and does not pull the tag`);
         // With both build and image, Compose builds the Dockerfile and tags the result as `image`.
-        // Omit `image` from service.json so TDK builds from the Dockerfile instead of pulling the tag.
+        // Omit `image` from service.json so Flisk builds from the Dockerfile instead of pulling the tag.
         const source = service.dockerfile
             ? {
                 buildContext: relative(dirname(path), resolve(plan.root, service.dir)).split("\\").join("/") || ".",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flisk-sh/flisk-import",
-  "version": "0.2.2",
-  "description": "Import services from a repository's root docker-compose.yml into TDK service.json files.",
+  "version": "0.2.4",
+  "description": "Import services from a repository's root docker-compose.yml into Flisk service.json files.",
   "type": "module",
   "license": "MIT",
   "bin": {