@ethlete/cli 2.1.0-next.5 → 2.1.0-next.7

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @ethlete/cli
 
+## 2.1.0-next.7
+
+### Patch Changes
+
+- [#3074](https://github.com/ethlete-io/ethdk/pull/3074) [`63a528a`](https://github.com/ethlete-io/ethdk/commit/63a528a0ab1b1e7163e71c1cf5f65415bdda32d9) Thanks [@github-actions](https://github.com/apps/github-actions)! - `et auth` now takes a host written as a url, and asks before it replaces a token `auth.json`
+  already holds for that host.
+
+## 2.1.0-next.6
+
+### Minor Changes
+
+- [`a1c489e`](https://github.com/ethlete-io/ethdk/commit/a1c489e0a1da4b479fd6e47743dec4c1bad0152f) Thanks [@TomTomB](https://github.com/TomTomB)! - `et api up` now refuses a port another program holds and prints a per-service state table instead of
+  the engine's output. New `et api clear` removes a managed checkout, and offers to take its containers down first.
+
+- [`12dcd51`](https://github.com/ethlete-io/ethdk/commit/12dcd5118ca8d2089cc3e9379efe4e9d0502a0f6) Thanks [@TomTomB](https://github.com/TomTomB)! - Every `et api` command now takes a comma-separated list of names, so `et api up hub,platform` starts
+  both APIs.
+
+- [`0e060b2`](https://github.com/ethlete-io/ethdk/commit/0e060b28436e9444726a35a93264a046242e348e) Thanks [@TomTomB](https://github.com/TomTomB)! - `et api help <name>` now answers for one API: the commands it accepts, what each one runs, its url
+  and services, and the state of its checkout. `--help` after a known API name prints the same text.
+
+- [`0e060b2`](https://github.com/ethlete-io/ethdk/commit/0e060b28436e9444726a35a93264a046242e348e) Thanks [@TomTomB](https://github.com/TomTomB)! - `et api` now runs an API's `setupCommand` itself: `et api setup <name>` on its own, or as an offer
+  when a command finds the `envFile` missing. `--setup` accepts that offer without the question.
+
+- [`c3dd7c3`](https://github.com/ethlete-io/ethdk/commit/c3dd7c3d7e0e2a060e081c7fe820f9774537418b) Thanks [@TomTomB](https://github.com/TomTomB)! - `et auth <token>` writes a GitLab token into composer's `auth.json`, which the API containers mount. It asks the host whether the token can download code before it writes anything.
+
+### Patch Changes
+
+- [`0e060b2`](https://github.com/ethlete-io/ethdk/commit/0e060b28436e9444726a35a93264a046242e348e) Thanks [@TomTomB](https://github.com/TomTomB)! - An unknown API name in `et api` now names the closest match and the APIs there are, in place of the
+  whole help text. An unknown command suggests the closest command the same way.
+
+- [`c3dd7c3`](https://github.com/ethlete-io/ethdk/commit/c3dd7c3d7e0e2a060e081c7fe820f9774537418b) Thanks [@TomTomB](https://github.com/TomTomB)! - A failing `et api` exec command no longer always blames a private dependency. That hint is kept for a command that installs dependencies; any other one suggests running the install command first.
+
+- [`0e060b2`](https://github.com/ethlete-io/ethdk/commit/0e060b28436e9444726a35a93264a046242e348e) Thanks [@TomTomB](https://github.com/TomTomB)! - `et api setup` keeps the setup command's own output back and prints one line for the result. The output is only shown when the command fails, so a checkout's advice about its Makefile no longer competes with the CLI.
+
+- [`0e060b2`](https://github.com/ethlete-io/ethdk/commit/0e060b28436e9444726a35a93264a046242e348e) Thanks [@TomTomB](https://github.com/TomTomB)! - Every `et` message now names a command the reader can type, for example `yarn api` or `npx et api`,
+  in place of a bare `et`. `et doctor` names the `et api` command that fixes each problem.
+
 ## 2.1.0-next.5
 
 ### Minor Changes

package/README.md

@@ -16,13 +16,33 @@ yarn et release
 
 Turns pending changesets into a tagged, pushed release commit (version → tag → commit → push).
 
+## `et auth`
+
+Writes a GitLab token into composer's `auth.json`, so a private PHP dependency can be downloaded.
+The compose file of each API mounts `$HOME/.composer` into its container, so this is the token the
+composer inside the container reads.
+
+```bash
+yarn et auth glpat-xxxxxxxxxxxxxxxxxxxx                     # the host comes from ethlete.apis.js
+yarn et auth gitlab.example.com glpat-xxxxxxxxxxxxxxxxxxxx  # name it when more than one is in use
+```
+
+The host may be written as a url. Only its host name is used.
+
+The token is checked against the host first: once for the token itself, and once with the request
+`git clone` makes for a private dependency. A token that can read the API but not fetch code answers
+`403` there, and nothing is written. A token the file already holds for that host is replaced only
+after a question. `--force` skips both.
+
 ## `et api`
 
 Runs the API an app in this repo talks to, from a checkout on your own machine.
 
 ```bash
 yarn et api --help              # the commands, the APIs and what each one accepts
+yarn et api help hub            # what hub accepts, and where its checkout is
 yarn et api up hub              # start the containers
+yarn et api up hub,platform     # the same, for both APIs
 yarn et api down hub            # stop them
 yarn et api logs hub            # follow the API's log
 yarn et api shell hub           # a shell in the API container
@@ -32,12 +52,27 @@ yarn et api checkout hub        # switch the checkout to the branch apiRepoBranc
 yarn et api pull hub            # fetch and fast-forward the checked-out branch
 yarn et api pull hub --force    # the same, discarding local commits and tracked changes
 yarn et api clone hub           # clone the API into .ethlete/hub
+yarn et api clear hub           # remove that clone again
+yarn et api clear --all         # remove every managed clone
+yarn et api setup hub           # run the API's own setupCommand, which writes its .env
 ```
 
-`checkout` and `pull` act on the checkout itself, so they work before `make setup` has run and need
-no container engine. `pull` refuses to run on a checkout with uncommitted changes unless you pass
-`--force`. `--force` resets the branch to its remote and throws away local commits and tracked
-changes; it never touches untracked or ignored files, so a `vendor/` directory or a `.env` survives.
+Every command takes a comma-separated list of names, and acts on each API in turn.
+
+`clone`, `checkout`, `pull`, `setup` and `clear` act on the checkout itself, so they work before the
+API has an `.env` and need no container engine. `pull` refuses to run on a checkout with uncommitted
+changes unless you pass `--force`. `--force` resets the branch to its remote and throws away local
+commits and tracked changes; it never touches untracked or ignored files, so a `vendor/` directory or
+a `.env` survives.
+
+`clear` removes a managed checkout in `.ethlete/<name>`, and only that one: a path you set in
+`apiRepoPaths` is your own. It asks one question for every API you named, takes their containers down
+first, and refuses a checkout that holds uncommitted changes or commits no remote holds. `--force`
+skips those two git checks.
+
+Before it starts anything, `up` reads the host ports the requested services publish and checks
+whether something already holds them. In a terminal it offers to stop the containers that hold them.
+`--force` skips the check and lets the engine report the conflict itself.
 
 The first container tool that answers is used, in this order: `docker compose`,
 `container compose`, `podman-compose`, `podman compose`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/cli",
-  "version": "2.1.0-next.5",
+  "version": "2.1.0-next.7",
   "license": "MIT",
   "type": "commonjs",
   "main": "./src/index.js",

package/src/index.js

@@ -2,14 +2,40 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const lib_1 = require("./lib");
-const USAGE = `et — Ethlete repo tooling
-
-  et release            Turn pending changesets into a tagged, pushed release commit
-  et api <cmd> <api>    Run an API from this repo's ethlete.apis.js locally
-                        (up, down, logs, shell, plus that API's own exec entries)
-  et doctor             Check this machine's ethlete.config.local.json, container engine
-                        and every API checkout
-`;
+const USAGE_ROWS = [
+    { subcommand: 'release', args: '', lines: ['Turn pending changesets into a tagged, pushed release commit'] },
+    {
+        subcommand: 'api',
+        args: ' <cmd> <api>',
+        lines: [
+            "Run an API from this repo's ethlete.apis.js locally",
+            "(up, down, logs, shell, setup, plus that API's own exec entries)",
+        ],
+    },
+    {
+        subcommand: 'auth',
+        args: ' [host] <token>',
+        lines: [
+            "Write a GitLab token into composer's auth.json, which the",
+            'API containers mount, after checking it can download code',
+        ],
+    },
+    {
+        subcommand: 'doctor',
+        args: '',
+        lines: ["Check this machine's ethlete.config.local.json, container engine", 'and every API checkout'],
+    },
+];
+const usage = (root) => {
+    const rows = USAGE_ROWS.map((row) => (Object.assign(Object.assign({}, row), { command: `${(0, lib_1.repoInvocation)({ root, subcommand: row.subcommand })}${row.args}` })));
+    const width = Math.max(...rows.map((row) => row.command.length));
+    return [
+        'et — Ethlete repo tooling',
+        '',
+        ...rows.flatMap((row) => row.lines.map((line, index) => `  ${(index === 0 ? row.command : '').padEnd(width)}  ${line}`)),
+        '',
+    ].join('\n');
+};
 const cli = (args) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
     switch (args[0]) {
         case 'release':
@@ -18,11 +44,25 @@ const cli = (args) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
             yield (0, lib_1.release)(args.join('=').split('='));
             return 0;
         case 'api':
-            return (0, lib_1.apiCommand)({ root: process.cwd(), argv: args.slice(1) });
+            return (0, lib_1.apiCommand)({
+                root: process.cwd(),
+                argv: args.slice(1),
+                invocation: (0, lib_1.repoInvocation)({ root: process.cwd(), subcommand: 'api' }),
+            });
+        case 'auth':
+            return (0, lib_1.authCommand)({
+                root: process.cwd(),
+                argv: args.slice(1),
+                invocation: (0, lib_1.repoInvocation)({ root: process.cwd(), subcommand: 'auth' }),
+            });
         case 'doctor':
-            return (0, lib_1.doctorCommand)({ root: process.cwd() });
+            // Every fix it names is an `et api` command, so it needs that script rather than its own.
+            return (0, lib_1.doctorCommand)({
+                root: process.cwd(),
+                apiInvocation: (0, lib_1.repoInvocation)({ root: process.cwd(), subcommand: 'api' }),
+            });
         default:
-            console.log(USAGE);
+            console.log(usage(process.cwd()));
             return args[0] === undefined || args[0] === '--help' || args[0] === '-h' ? 0 : 1;
     }
 });

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/cli/src/index.ts"],"names":[],"mappings":";;;AAAA,+BAA2D;AAE3D,MAAM,KAAK,GAAG;;;;;;;CAOb,CAAC;AAEF,MAAM,GAAG,GAAG,CAAO,IAAc,EAAmB,EAAE;IACpD,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAChB,KAAK,SAAS;YACZ,0FAA0F;YAC1F,wDAAwD;YACxD,MAAM,IAAA,aAAO,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YAEzC,OAAO,CAAC,CAAC;QAEX,KAAK,KAAK;YACR,OAAO,IAAA,gBAAU,EAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAElE,KAAK,QAAQ;YACX,OAAO,IAAA,mBAAa,EAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAEhD;YACE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEnB,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;AACH,CAAC,CAAA,CAAC;AAEF,gDAAsB;AAEtB,oFAAoF;AACpF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACvB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAC1B,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACxB,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/cli/src/index.ts"],"names":[],"mappings":";;;AAAA,+BAAwF;AAExF,MAAM,UAAU,GAAG;IACjB,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,8DAA8D,CAAC,EAAE;IAC5G;QACE,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE;YACL,qDAAqD;YACrD,kEAAkE;SACnE;KACF;IACD;QACE,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,iBAAiB;QACvB,KAAK,EAAE;YACL,2DAA2D;YAC3D,2DAA2D;SAC5D;KACF;IACD;QACE,UAAU,EAAE,QAAQ;QACpB,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,CAAC,kEAAkE,EAAE,wBAAwB,CAAC;KACtG;CACF,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE;IAC7B,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,iCAChC,GAAG,KACN,OAAO,EAAE,GAAG,IAAA,oBAAc,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,IAC7E,CAAC,CAAC;IACJ,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjE,OAAO;QACL,2BAA2B;QAC3B,EAAE;QACF,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CACtB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAC/F;QACD,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,CAAO,IAAc,EAAmB,EAAE;IACpD,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAChB,KAAK,SAAS;YACZ,0FAA0F;YAC1F,wDAAwD;YACxD,MAAM,IAAA,aAAO,EAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YAEzC,OAAO,CAAC,CAAC;QAEX,KAAK,KAAK;YACR,OAAO,IAAA,gBAAU,EAAC;gBAChB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;gBACnB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;gBACnB,UAAU,EAAE,IAAA,oBAAc,EAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;aACvE,CAAC,CAAC;QAEL,KAAK,MAAM;YACT,OAAO,IAAA,iBAAW,EAAC;gBACjB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;gBACnB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;gBACnB,UAAU,EAAE,IAAA,oBAAc,EAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;aACxE,CAAC,CAAC;QAEL,KAAK,QAAQ;YACX,0FAA0F;YAC1F,OAAO,IAAA,mBAAa,EAAC;gBACnB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;gBACnB,aAAa,EAAE,IAAA,oBAAc,EAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;aAC1E,CAAC,CAAC;QAEL;YACE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAElC,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;AACH,CAAC,CAAA,CAAC;AAEF,gDAAsB;AAEtB,oFAAoF;AACpF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACvB,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAC1B,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACxB,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACP,CAAC"}

package/src/lib/api/api-command.d.ts

@@ -1,4 +1,5 @@
-export declare const apiCommand: ({ root, argv }: {
+export declare const apiCommand: ({ root, argv, invocation }: {
     root: string;
     argv: string[];
+    invocation?: string;
 }) => 1 | Promise<number>;

package/src/lib/api/api-command.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.apiCommand = void 0;
 const load_definitions_1 = require("./load-definitions");
 const run_1 = require("./run");
-const apiCommand = ({ root, argv }) => {
+const apiCommand = ({ root, argv, invocation }) => {
     const { found, apis } = (0, load_definitions_1.loadApiDefinitions)(root);
     if (!found) {
         console.error(`No API definitions found. Create ${load_definitions_1.API_DEFINITIONS_FILE_NAMES[0]} in the repo root:\n\n` +
@@ -21,7 +21,7 @@ const apiCommand = ({ root, argv }) => {
             `  };`);
         return 1;
     }
-    return (0, run_1.runApiCommand)({ apis, argv, root });
+    return (0, run_1.runApiCommand)({ apis, argv, root, invocation });
 };
 exports.apiCommand = apiCommand;
 //# sourceMappingURL=api-command.js.map

package/src/lib/api/api-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-command.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/api-command.ts"],"names":[],"mappings":";;;AAAA,yDAAoF;AACpF,+BAAsC;AAE/B,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAoC,EAAE,EAAE;IAC7E,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAA,qCAAkB,EAAC,IAAI,CAAC,CAAC;IAEjD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CACX,oCAAoC,6CAA0B,CAAC,CAAC,CAAC,wBAAwB;YACvF,uDAAuD;YACvD,wBAAwB;YACxB,cAAc;YACd,oCAAoC;YACpC,wCAAwC;YACxC,6BAA6B;YAC7B,qBAAqB;YACrB,0BAA0B;YAC1B,qCAAqC;YACrC,qDAAqD;YACrD,UAAU;YACV,MAAM,CACT,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,IAAA,mBAAa,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC;AAxBW,QAAA,UAAU,cAwBrB"}
+{"version":3,"file":"api-command.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/api-command.ts"],"names":[],"mappings":";;;AAAA,yDAAoF;AACpF,+BAAsC;AAE/B,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAyD,EAAE,EAAE;IAC9G,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAA,qCAAkB,EAAC,IAAI,CAAC,CAAC;IAEjD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CACX,oCAAoC,6CAA0B,CAAC,CAAC,CAAC,wBAAwB;YACvF,uDAAuD;YACvD,wBAAwB;YACxB,cAAc;YACd,oCAAoC;YACpC,wCAAwC;YACxC,6BAA6B;YAC7B,qBAAqB;YACrB,0BAA0B;YAC1B,qCAAqC;YACrC,qDAAqD;YACrD,UAAU;YACV,MAAM,CACT,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,IAAA,mBAAa,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC;AAxBW,QAAA,UAAU,cAwBrB"}

package/src/lib/api/auth-hint.d.ts

@@ -7,3 +7,10 @@ export declare const printPrivateDependencyHint: (options: {
 }) => void;
 /** The host of a git url, for naming it in the hint. Undefined when the url has no host. */
 export declare const gitUrlHost: (repoUrl: string) => string | undefined;
+/**
+ * The host a user names on the command line, which is often pasted as a url: `https://git.example.com/`
+ * holds the same host as `git.example.com`. Undefined when there is no host name in it at all.
+ */
+export declare const gitHostFromInput: (value: string) => string | undefined;
+/** The `group/project` part of a git url, for addressing the project in a host's own API. */
+export declare const gitUrlProjectPath: (repoUrl: string) => string | undefined;

package/src/lib/api/auth-hint.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gitUrlHost = exports.printPrivateDependencyHint = void 0;
+exports.gitUrlProjectPath = exports.gitHostFromInput = exports.gitUrlHost = exports.printPrivateDependencyHint = void 0;
 /**
  * A private dependency that will not download is the most common way these commands fail, and git
  * and the package managers report it as a bare 403 or a public-key error. This says what to check.
@@ -30,4 +30,30 @@ const gitUrlHost = (repoUrl) => {
     }
 };
 exports.gitUrlHost = gitUrlHost;
+/**
+ * The host a user names on the command line, which is often pasted as a url: `https://git.example.com/`
+ * holds the same host as `git.example.com`. Undefined when there is no host name in it at all.
+ */
+const gitHostFromInput = (value) => {
+    var _a;
+    const trimmed = value.trim();
+    if (!trimmed || trimmed.startsWith('/'))
+        return undefined;
+    return (_a = (0, exports.gitUrlHost)(trimmed)) !== null && _a !== void 0 ? _a : (0, exports.gitUrlHost)(`https://${trimmed}`);
+};
+exports.gitHostFromInput = gitHostFromInput;
+/** The `group/project` part of a git url, for addressing the project in a host's own API. */
+const gitUrlProjectPath = (repoUrl) => {
+    var _a;
+    const scpLike = /^[^/]+@[^:]+:(.+)$/.exec(repoUrl);
+    if (scpLike)
+        return ((_a = scpLike[1]) !== null && _a !== void 0 ? _a : '').replace(/\.git$/, '') || undefined;
+    try {
+        return new URL(repoUrl).pathname.replace(/^\/+/, '').replace(/\.git$/, '') || undefined;
+    }
+    catch (_b) {
+        return undefined;
+    }
+};
+exports.gitUrlProjectPath = gitUrlProjectPath;
 //# sourceMappingURL=auth-hint.js.map

package/src/lib/api/auth-hint.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth-hint.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/auth-hint.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CAAC,OAA8B,EAAE,EAAE;;IAC3E,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,eAAe,CAAC;IAEjD,OAAO,CAAC,KAAK,CACX,wFAAwF;QACtF,sCAAsC;QACtC,oCAAoC,IAAI,sCAAsC;QAC9E,6FAA6F;QAC7F,0CAA0C,IAAI,8CAA8C;QAC5F,0FAA0F;QAC1F,sFAAsF,CACzF,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,0BAA0B,8BAYrC;AAEF,4FAA4F;AACrF,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,EAAE;IAC5C,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEhD,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IAE/B,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,IAAI,SAAS,CAAC;IAChD,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,UAAU,cAUrB"}
+{"version":3,"file":"auth-hint.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/auth-hint.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CAAC,OAA8B,EAAE,EAAE;;IAC3E,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,eAAe,CAAC;IAEjD,OAAO,CAAC,KAAK,CACX,wFAAwF;QACtF,sCAAsC;QACtC,oCAAoC,IAAI,sCAAsC;QAC9E,6FAA6F;QAC7F,0CAA0C,IAAI,8CAA8C;QAC5F,0FAA0F;QAC1F,sFAAsF,CACzF,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,0BAA0B,8BAYrC;AAEF,4FAA4F;AACrF,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,EAAE;IAC5C,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEhD,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IAE/B,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,IAAI,SAAS,CAAC;IAChD,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,UAAU,cAUrB;AAEF;;;GAGG;AACI,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAE,EAAE;;IAChD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAE7B,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAE1D,OAAO,MAAA,IAAA,kBAAU,EAAC,OAAO,CAAC,mCAAI,IAAA,kBAAU,EAAC,WAAW,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC,CAAC;AANW,QAAA,gBAAgB,oBAM3B;AAEF,6FAA6F;AACtF,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAE,EAAE;;IACnD,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEnD,IAAI,OAAO;QAAE,OAAO,CAAC,MAAA,OAAO,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC;IAE1E,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC;IAC1F,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAVW,QAAA,iBAAiB,qBAU5B"}

package/src/lib/api/clear.d.ts

@@ -0,0 +1,36 @@
+import { ApiDefinitions } from './definition';
+export type ApiClearTarget = {
+    name: string;
+    /** Absolute path that would be removed. */
+    repoPath: string;
+    /** Directory that holds the compose file. */
+    composePath: string;
+    /** Whether any container of its compose project still exists. Those are taken down before the removal. */
+    hasContainers: boolean;
+    /** Why it must stay. Empty when it can be removed. */
+    blockers: string[];
+};
+export type ApiClearPlanOptions = {
+    apis: ApiDefinitions;
+    names: string[];
+    root: string;
+    invocation: string;
+    /** Skips the checks on uncommitted changes and unpushed commits. */
+    force: boolean;
+    /** Whether any container of the API's compose project exists. */
+    hasContainers: (composePath: string) => boolean;
+};
+/**
+ * What `clear` would do to each named API: the path it would remove, and every reason it must stay.
+ * An API without a managed checkout is left out, because there is nothing of ours to remove.
+ */
+export declare const planApiClear: (options: ApiClearPlanOptions) => ApiClearTarget[];
+export type ApiClearOptions = ApiClearPlanOptions & {
+    /** Takes the containers of one compose project down. False when the compose command failed. */
+    takeDown: (composePath: string) => boolean;
+};
+/**
+ * Removes the managed checkout of each named API, after one question that defaults to no. It offers to
+ * take down the containers that still exist, and refuses an API with work only this checkout holds.
+ */
+export declare const clearApiCheckouts: (options: ApiClearOptions) => Promise<number>;

package/src/lib/api/clear.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearApiCheckouts = exports.planApiClear = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const utils_1 = require("../utils");
+const git_1 = require("./git");
+const resolve_checkout_1 = require("./resolve-checkout");
+const MAX_LISTED = 5;
+/** The first few lines of a git listing, so a refusal shows what stands in the way. */
+const listed = (lines) => [
+    ...lines.slice(0, MAX_LISTED).map((line) => `  ${line}`),
+    ...(lines.length > MAX_LISTED ? [`  and ${lines.length - MAX_LISTED} more`] : []),
+].join('\n');
+/**
+ * What `clear` would do to each named API: the path it would remove, and every reason it must stay.
+ * An API without a managed checkout is left out, because there is nothing of ours to remove.
+ */
+const planApiClear = (options) => {
+    const { apis, names, root, invocation, force, hasContainers } = options;
+    return names.flatMap((name) => {
+        const api = apis[name];
+        if (!api)
+            return [];
+        const checkout = (0, resolve_checkout_1.resolveApiCheckout)({ root, name, api, needs: 'repo' });
+        if (!checkout.ok)
+            return [];
+        const { repoPath, composePath } = checkout.checkout;
+        const managed = (0, resolve_checkout_1.managedCheckoutPath)(root, name);
+        if (repoPath !== managed) {
+            return [
+                {
+                    name,
+                    repoPath,
+                    composePath,
+                    hasContainers: false,
+                    blockers: [
+                        `${repoPath} is your own checkout, not the one ${invocation} manages. ` +
+                            `Remove it yourself, or drop apiRepoPaths.${name} first.`,
+                    ],
+                },
+            ];
+        }
+        const changes = (0, git_1.uncommittedChanges)(repoPath);
+        const unpushed = (0, git_1.unpushedCommits)(repoPath);
+        return [
+            {
+                name,
+                repoPath,
+                composePath,
+                hasContainers: hasContainers(composePath),
+                blockers: [
+                    ...(!force && changes.length > 0
+                        ? [
+                            `${repoPath} has uncommitted changes:\n\n${listed(changes)}\n\n` +
+                                'Commit them, or pass --force to lose them.',
+                        ]
+                        : []),
+                    ...(!force && unpushed.length > 0
+                        ? [
+                            `${repoPath} has commits no remote holds:\n\n${listed(unpushed)}\n\n` +
+                                'Push them, or pass --force to lose them.',
+                        ]
+                        : []),
+                ],
+            },
+        ];
+    });
+};
+exports.planApiClear = planApiClear;
+/**
+ * Removes the managed checkout of each named API, after one question that defaults to no. It offers to
+ * take down the containers that still exist, and refuses an API with work only this checkout holds.
+ */
+const clearApiCheckouts = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { names, invocation, takeDown } = options;
+    const targets = (0, exports.planApiClear)(options);
+    const blocked = targets.filter(({ blockers }) => blockers.length > 0);
+    const removable = targets.filter(({ blockers }) => blockers.length === 0);
+    for (const { blockers } of blocked) {
+        console.error(blockers.join('\n\n'));
+    }
+    if (blocked.length > 0)
+        console.error('');
+    if (removable.length === 0) {
+        if (blocked.length === 0) {
+            console.log(`Nothing to remove. ${names.join(', ')} has no checkout ${invocation} manages.`);
+        }
+        return blocked.length > 0 ? 1 : 0;
+    }
+    const paths = removable.map(({ repoPath }) => `  ${repoPath}`).join('\n');
+    const running = removable.filter(({ hasContainers }) => hasContainers).map(({ name }) => name);
+    const stopped = running.join(', ');
+    const checkouts = removable.length === 1 ? 'the checkout' : 'the checkouts';
+    const accepted = yield (0, utils_1.confirm)({
+        problem: running.length > 0 ? `This takes ${stopped} down, then removes:\n\n${paths}` : `This removes:\n\n${paths}`,
+        question: running.length > 0
+            ? `Take ${stopped} down and remove ${checkouts}?`
+            : `Remove ${removable.map(({ name }) => name).join(', ')}?`,
+        hint: running.length > 0
+            ? `Re-run in a terminal to answer the question, or run "${invocation} down ${stopped}" and remove the ` +
+                'directories yourself.'
+            : 'Re-run in a terminal to answer the question, or remove the directories yourself.',
+        defaultsToYes: false,
+    });
+    if (!accepted)
+        return 1;
+    let failed = 0;
+    for (const { name, repoPath, composePath, hasContainers } of removable) {
+        if (hasContainers && !takeDown(composePath)) {
+            console.error(`Could not take ${name} down, so ${repoPath} stays.`);
+            failed += 1;
+            continue;
+        }
+        (0, fs_1.rmSync)(repoPath, { recursive: true, force: true });
+        console.log(`Removed ${repoPath}. Run "${invocation} clone ${name}" to get it back.`);
+    }
+    return blocked.length > 0 || failed > 0 ? 1 : 0;
+});
+exports.clearApiCheckouts = clearApiCheckouts;
+//# sourceMappingURL=clear.js.map

package/src/lib/api/clear.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clear.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/clear.ts"],"names":[],"mappings":";;;;AAAA,2BAA4B;AAC5B,oCAAmC;AAEnC,+BAA4D;AAC5D,yDAA6E;AAc7E,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,uFAAuF;AACvF,MAAM,MAAM,GAAG,CAAC,KAAe,EAAE,EAAE,CACjC;IACE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;IACxD,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,UAAU,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CAClF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAaf;;;GAGG;AACI,MAAM,YAAY,GAAG,CAAC,OAA4B,EAAoB,EAAE;IAC7E,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAExE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvB,IAAI,CAAC,GAAG;YAAE,OAAO,EAAE,CAAC;QAEpB,MAAM,QAAQ,GAAG,IAAA,qCAAkB,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAExE,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,OAAO,EAAE,CAAC;QAE5B,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACpD,MAAM,OAAO,GAAG,IAAA,sCAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEhD,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACzB,OAAO;gBACL;oBACE,IAAI;oBACJ,QAAQ;oBACR,WAAW;oBACX,aAAa,EAAE,KAAK;oBACpB,QAAQ,EAAE;wBACR,GAAG,QAAQ,sCAAsC,UAAU,YAAY;4BACrE,4CAA4C,IAAI,SAAS;qBAC5D;iBACF;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,IAAA,wBAAkB,EAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAA,qBAAe,EAAC,QAAQ,CAAC,CAAC;QAE3C,OAAO;YACL;gBACE,IAAI;gBACJ,QAAQ;gBACR,WAAW;gBACX,aAAa,EAAE,aAAa,CAAC,WAAW,CAAC;gBACzC,QAAQ,EAAE;oBACR,GAAG,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;wBAC9B,CAAC,CAAC;4BACE,GAAG,QAAQ,gCAAgC,MAAM,CAAC,OAAO,CAAC,MAAM;gCAC9D,4CAA4C;yBAC/C;wBACH,CAAC,CAAC,EAAE,CAAC;oBACP,GAAG,CAAC,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;wBAC/B,CAAC,CAAC;4BACE,GAAG,QAAQ,oCAAoC,MAAM,CAAC,QAAQ,CAAC,MAAM;gCACnE,0CAA0C;yBAC7C;wBACH,CAAC,CAAC,EAAE,CAAC;iBACR;aACF;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAxDW,QAAA,YAAY,gBAwDvB;AAOF;;;GAGG;AACI,MAAM,iBAAiB,GAAG,CAAO,OAAwB,EAAmB,EAAE;IACnF,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAChD,MAAM,OAAO,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAE1E,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,OAAO,EAAE,CAAC;QACnC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAE1C,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,UAAU,WAAW,CAAC,CAAC;QAC/F,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC/F,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC;IAC5E,MAAM,QAAQ,GAAG,MAAM,IAAA,eAAO,EAAC;QAC7B,OAAO,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,OAAO,2BAA2B,KAAK,EAAE,CAAC,CAAC,CAAC,oBAAoB,KAAK,EAAE;QACnH,QAAQ,EACN,OAAO,CAAC,MAAM,GAAG,CAAC;YAChB,CAAC,CAAC,QAAQ,OAAO,oBAAoB,SAAS,GAAG;YACjD,CAAC,CAAC,UAAU,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QAC/D,IAAI,EACF,OAAO,CAAC,MAAM,GAAG,CAAC;YAChB,CAAC,CAAC,wDAAwD,UAAU,SAAS,OAAO,mBAAmB;gBACrG,uBAAuB;YACzB,CAAC,CAAC,kFAAkF;QACxF,aAAa,EAAE,KAAK;KACrB,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ;QAAE,OAAO,CAAC,CAAC;IAExB,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,SAAS,EAAE,CAAC;QACvE,IAAI,aAAa,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,OAAO,CAAC,KAAK,CAAC,kBAAkB,IAAI,aAAa,QAAQ,SAAS,CAAC,CAAC;YACpE,MAAM,IAAI,CAAC,CAAC;YAEZ,SAAS;QACX,CAAC;QAED,IAAA,WAAM,EAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,UAAU,UAAU,UAAU,IAAI,mBAAmB,CAAC,CAAC;IACxF,CAAC;IAED,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC,CAAA,CAAC;AAvDW,QAAA,iBAAiB,qBAuD5B"}

package/src/lib/api/compose.d.ts

@@ -15,3 +15,32 @@ export declare const engineEnv: (engine: string) => {
 export declare const lanAddress: () => string | undefined;
 /** Path of this machine's SSH key, for a compose file that mounts one into the API container. */
 export declare const sshKeyPath: () => string | undefined;
+export type ComposeCall = {
+    tool: ComposeTool;
+    /** Directory that holds the compose file. */
+    cwd: string;
+    env?: NodeJS.ProcessEnv;
+};
+/** Runs a compose command and captures its stdout. `undefined` when the tool itself failed. */
+export declare const composeOutput: (options: ComposeCall & {
+    args: string[];
+}) => string | undefined;
+/** Container ids of a compose project, or `undefined` when the tool could not answer. */
+export declare const composeContainerIds: (call: ComposeCall) => string[] | undefined;
+export type PortMapping = {
+    host: number;
+    container: number;
+};
+export type ContainerState = {
+    id: string;
+    name: string;
+    /** Compose service, empty for a container compose did not start. */
+    service: string;
+    /** The engine's own words, for example `Up 42 minutes` or `Exited (1) 3 seconds ago`. */
+    status: string;
+    ports: PortMapping[];
+};
+/** True for a status the engine prints while the container runs. */
+export declare const isRunningStatus: (status: string) => boolean;
+/** Every container the engine knows, with its compose service and published ports. */
+export declare const containerStates: (engine: string) => ContainerState[];

package/src/lib/api/compose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sshKeyPath = exports.lanAddress = exports.engineEnv = exports.composeToolNames = exports.resolveComposeTool = exports.composeBinary = void 0;
+exports.containerStates = exports.isRunningStatus = exports.composeContainerIds = exports.composeOutput = exports.sshKeyPath = exports.lanAddress = exports.engineEnv = exports.composeToolNames = exports.resolveComposeTool = exports.composeBinary = void 0;
 const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const os_1 = require("os");
@@ -55,4 +55,47 @@ exports.lanAddress = lanAddress;
 /** Path of this machine's SSH key, for a compose file that mounts one into the API container. */
 const sshKeyPath = () => [(0, path_1.join)((0, os_1.homedir)(), '.ssh/id_ed25519'), (0, path_1.join)((0, os_1.homedir)(), '.ssh/id_rsa')].find((path) => (0, fs_1.existsSync)(path));
 exports.sshKeyPath = sshKeyPath;
+/** Runs a compose command and captures its stdout. `undefined` when the tool itself failed. */
+const composeOutput = (options) => {
+    var _a;
+    const { tool, cwd, env, args } = options;
+    const [binary, ...prefix] = tool.compose;
+    const result = (0, child_process_1.spawnSync)(binary, [...prefix, ...args], { cwd, env, encoding: 'utf8' });
+    return result.error || result.status !== 0 ? undefined : ((_a = result.stdout) !== null && _a !== void 0 ? _a : '');
+};
+exports.composeOutput = composeOutput;
+/** Container ids of a compose project, or `undefined` when the tool could not answer. */
+const composeContainerIds = (call) => {
+    const stdout = (0, exports.composeOutput)(Object.assign(Object.assign({}, call), { args: ['ps', '-q'] }));
+    return stdout === undefined ? undefined : stdout.split('\n').filter((id) => id.trim() !== '');
+};
+exports.composeContainerIds = composeContainerIds;
+const PUBLISHED_MAPPING = /(\d+)->(\d+)/g;
+const parsePortMappings = (ports) => [...ports.matchAll(PUBLISHED_MAPPING)].map(([, host, container]) => ({
+    host: Number(host),
+    container: Number(container),
+}));
+const PS_FORMAT = '{{.ID}}\t{{.Names}}\t{{.Label "com.docker.compose.service"}}\t{{.Status}}\t{{.Ports}}';
+/** True for a status the engine prints while the container runs. */
+const isRunningStatus = (status) => /^up\b/i.test(status);
+exports.isRunningStatus = isRunningStatus;
+/** Every container the engine knows, with its compose service and published ports. */
+const containerStates = (engine) => {
+    var _a;
+    const result = (0, child_process_1.spawnSync)(engine, ['ps', '-a', '--format', PS_FORMAT], { encoding: 'utf8' });
+    if (result.error || result.status !== 0)
+        return [];
+    return ((_a = result.stdout) !== null && _a !== void 0 ? _a : '')
+        .split('\n')
+        .map((line) => line.split('\t'))
+        .filter((columns) => columns.length >= 5 && columns[0])
+        .map(([id, name, service, status, ports]) => ({
+        id: id !== null && id !== void 0 ? id : '',
+        name: name !== null && name !== void 0 ? name : '',
+        service: service !== null && service !== void 0 ? service : '',
+        status: status !== null && status !== void 0 ? status : '',
+        ports: parsePortMappings(ports !== null && ports !== void 0 ? ports : ''),
+    }));
+};
+exports.containerStates = containerStates;
 //# sourceMappingURL=compose.js.map

package/src/lib/api/compose.js.map

@@ -1 +1 @@
-{"version":3,"file":"compose.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/compose.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAC1C,2BAA4D;AAC5D,2BAAwD;AACxD,+BAA4B;AAQ5B;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,gDAAgD,CAAC,CAAC;AAE/E,MAAM,aAAa,GAAkB;IACnC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE;IACpD,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE;IAC1D,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,gBAAgB,EAAE,GAAG,mBAAmB,CAAC,EAAE;IACzE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,mBAAmB,CAAC,EAAE;CAC7E,CAAC;AAEF;;;;GAIG;AACH,MAAM,sBAAsB,GAAG,+EAA+E,CAAC;AAE/G,IAAI,wBAA4C,CAAC;AAEjD,MAAM,yBAAyB,GAAG,GAAG,EAAE;IACrC,wBAAwB,aAAxB,wBAAwB,cAAxB,wBAAwB,IAAxB,wBAAwB,GAAK,IAAA,WAAI,EAAC,IAAA,gBAAW,EAAC,IAAA,WAAI,EAAC,IAAA,WAAM,GAAE,EAAE,cAAc,CAAC,CAAC,EAAE,iBAAiB,CAAC,EAAC;IAClG,IAAA,kBAAa,EAAC,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAExE,OAAO,wBAAwB,CAAC;AAClC,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;AAAxF,QAAA,aAAa,iBAA2E;AAErG,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,IAAc,EAAE,EAAE;IACjD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;IAE7D,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,uFAAuF;AAChF,MAAM,kBAAkB,GAAG,CAAC,QAAuB,aAAa,EAAE,EAAE,CACzE,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;IACzB,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;IAEjD,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC;AALQ,QAAA,kBAAkB,sBAK1B;AAEE,MAAM,gBAAgB,GAAG,CAAC,QAAuB,aAAa,EAAE,EAAE,CACvE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AADlD,QAAA,gBAAgB,oBACkC;AAExD,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,EAAE,CAC1C,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAD5E,QAAA,SAAS,aACmE;AAElF,MAAM,UAAU,GAAG,GAAG,EAAE;;IAC7B,OAAA,MAAA,MAAM,CAAC,MAAM,CAAC,IAAA,sBAAiB,GAAE,CAAC;SAC/B,IAAI,EAAE;SACN,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,0CAAE,OAAO,CAAA;CAAA,CAAC;AAH/F,QAAA,UAAU,cAGqF;AAE5G,iGAAiG;AAC1F,MAAM,UAAU,GAAG,GAAG,EAAE,CAC7B,CAAC,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,iBAAiB,CAAC,EAAE,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,CAAC,CAAC;AAD3F,QAAA,UAAU,cACiF"}
+{"version":3,"file":"compose.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/compose.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAC1C,2BAA4D;AAC5D,2BAAwD;AACxD,+BAA4B;AAQ5B;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,gDAAgD,CAAC,CAAC;AAE/E,MAAM,aAAa,GAAkB;IACnC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE;IACpD,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE;IAC1D,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,gBAAgB,EAAE,GAAG,mBAAmB,CAAC,EAAE;IACzE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,mBAAmB,CAAC,EAAE;CAC7E,CAAC;AAEF;;;;GAIG;AACH,MAAM,sBAAsB,GAAG,+EAA+E,CAAC;AAE/G,IAAI,wBAA4C,CAAC;AAEjD,MAAM,yBAAyB,GAAG,GAAG,EAAE;IACrC,wBAAwB,aAAxB,wBAAwB,cAAxB,wBAAwB,IAAxB,wBAAwB,GAAK,IAAA,WAAI,EAAC,IAAA,gBAAW,EAAC,IAAA,WAAI,EAAC,IAAA,WAAM,GAAE,EAAE,cAAc,CAAC,CAAC,EAAE,iBAAiB,CAAC,EAAC;IAClG,IAAA,kBAAa,EAAC,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAExE,OAAO,wBAAwB,CAAC;AAClC,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;AAAxF,QAAA,aAAa,iBAA2E;AAErG,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,IAAc,EAAE,EAAE;IACjD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;IAE7D,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,uFAAuF;AAChF,MAAM,kBAAkB,GAAG,CAAC,QAAuB,aAAa,EAAE,EAAE,CACzE,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;IACzB,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC;IAEjD,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC;AALQ,QAAA,kBAAkB,sBAK1B;AAEE,MAAM,gBAAgB,GAAG,CAAC,QAAuB,aAAa,EAAE,EAAE,CACvE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAA,qBAAa,EAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AADlD,QAAA,gBAAgB,oBACkC;AAExD,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,EAAE,CAC1C,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,0BAA0B,EAAE,yBAAyB,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAD5E,QAAA,SAAS,aACmE;AAElF,MAAM,UAAU,GAAG,GAAG,EAAE;;IAC7B,OAAA,MAAA,MAAM,CAAC,MAAM,CAAC,IAAA,sBAAiB,GAAE,CAAC;SAC/B,IAAI,EAAE;SACN,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,MAAM,MAAK,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,0CAAE,OAAO,CAAA;CAAA,CAAC;AAH/F,QAAA,UAAU,cAGqF;AAE5G,iGAAiG;AAC1F,MAAM,UAAU,GAAG,GAAG,EAAE,CAC7B,CAAC,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,iBAAiB,CAAC,EAAE,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,CAAC,CAAC;AAD3F,QAAA,UAAU,cACiF;AASxG,+FAA+F;AACxF,MAAM,aAAa,GAAG,CAAC,OAAyC,EAAE,EAAE;;IACzE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;IACzC,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEvF,OAAO,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC;AACjF,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB;AAEF,yFAAyF;AAClF,MAAM,mBAAmB,GAAG,CAAC,IAAiB,EAAE,EAAE;IACvD,MAAM,MAAM,GAAG,IAAA,qBAAa,kCAAM,IAAI,KAAE,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,IAAG,CAAC;IAE9D,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAChG,CAAC,CAAC;AAJW,QAAA,mBAAmB,uBAI9B;AAcF,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAE1C,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAiB,EAAE,CACzD,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;IACnE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC;CAC7B,CAAC,CAAC,CAAC;AAEN,MAAM,SAAS,GAAG,uFAAuF,CAAC;AAE1G,oEAAoE;AAC7D,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAA5D,QAAA,eAAe,mBAA6C;AAEzE,sFAAsF;AAC/E,MAAM,eAAe,GAAG,CAAC,MAAc,EAAoB,EAAE;;IAClE,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAE5F,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEnD,OAAO,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC;SACzB,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC/B,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;SACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,EAAE,EAAE,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,EAAE;QACZ,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE;QAChB,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE;QACtB,MAAM,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE;QACpB,KAAK,EAAE,iBAAiB,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC;KACtC,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AAhBW,QAAA,eAAe,mBAgB1B"}

package/src/lib/api/definition.d.ts

@@ -10,7 +10,7 @@ export type ApiDefinition = {
     port: number;
     /** File that must exist in `composeDir` before the API can start, for example `.env`. */
     envFile?: string;
-    /** Command that creates `envFile`. Named in the error when the file is missing. */
+    /** Command that creates `envFile`, run by `setup` in `composeDir`. */
     setupCommand?: string;
     /** External container network to create before the first `up`. */
     network?: string;
@@ -26,7 +26,12 @@ export type ApiDefinition = {
     exec?: Record<string, string[]>;
 };
 export type ApiDefinitions = Record<string, ApiDefinition>;
-export declare const BUILT_IN_API_COMMANDS: readonly ["up", "down", "logs", "shell", "clone", "checkout", "pull"];
-/** These act on the checkout itself, so they run before `make setup` and need no container engine. */
+export declare const BUILT_IN_API_COMMANDS: readonly ["up", "down", "logs", "shell", "clone", "clear", "checkout", "pull", "setup"];
+/** These act on the checkout itself, so they run before `setupCommand` and need no container engine. */
 export declare const GIT_API_COMMANDS: string[];
+/** Whether an exec entry downloads dependencies, which is the only failure the private-dependency hint explains. */
+export declare const installsDependencies: (execCommand: readonly string[]) => boolean;
+/** The exec entry that installs dependencies, so a failure in another entry can point at it. */
+export declare const dependencyInstallCommandName: (api: ApiDefinition) => string | undefined;
+/** `setup` is dropped for an API that declares no `setupCommand`, so nothing lists a command it cannot run. */
 export declare const apiCommandNames: (api: ApiDefinition) => string[];