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

package/src/lib/api/git.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pullApiBranch = exports.checkoutApiBranch = exports.hasUncommittedChanges = exports.currentBranch = void 0;
+exports.pullApiBranch = exports.checkoutApiBranch = exports.unpushedCommits = exports.hasUncommittedChanges = exports.uncommittedChanges = exports.currentBranch = void 0;
 const child_process_1 = require("child_process");
 const git = (cwd, args) => {
     var _a, _b, _c;
@@ -17,8 +17,20 @@ const currentBranch = (cwd) => {
     return result.status === 0 ? result.stdout : undefined;
 };
 exports.currentBranch = currentBranch;
-const hasUncommittedChanges = (cwd) => git(cwd, ['status', '--porcelain']).stdout.length > 0;
+/** Modified tracked files and untracked files, as git's own porcelain lines. */
+const uncommittedChanges = (cwd) => {
+    const { stdout } = git(cwd, ['status', '--porcelain']);
+    return stdout.length > 0 ? stdout.split('\n') : [];
+};
+exports.uncommittedChanges = uncommittedChanges;
+const hasUncommittedChanges = (cwd) => (0, exports.uncommittedChanges)(cwd).length > 0;
 exports.hasUncommittedChanges = hasUncommittedChanges;
+/** Commits on any local branch that no remote holds, so work is never removed with a checkout. */
+const unpushedCommits = (cwd) => {
+    const { status, stdout } = git(cwd, ['log', '--branches', '--not', '--remotes', '--oneline']);
+    return status === 0 && stdout.length > 0 ? stdout.split('\n') : [];
+};
+exports.unpushedCommits = unpushedCommits;
 /** Switches the API checkout to the branch configured for it. Git's own refusal is passed through. */
 const checkoutApiBranch = (options) => {
     const { repoPath, branch } = options;

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

@@ -1 +1 @@
-{"version":3,"file":"git.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/git.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAI1C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,IAAc,EAAa,EAAE;;IACrD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEjE,OAAO;QACL,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,mCAAI,CAAC;QAC1B,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACpC,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;KACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,IAAc,EAAE,EAAE,WAAC,OAAA,MAAA,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,mCAAI,CAAC,CAAA,EAAA,CAAC;AAE3G,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/D,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAJW,QAAA,aAAa,iBAIxB;AAEK,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;AAA/F,QAAA,qBAAqB,yBAA0E;AAE5G,sGAAsG;AAC/F,MAAM,iBAAiB,GAAG,CAAC,OAA6C,EAAE,EAAE;IACjF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAErC,IAAI,IAAA,qBAAa,EAAC,QAAQ,CAAC,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,GAAG,CAAC,CAAC;QAErC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AAVW,QAAA,iBAAiB,qBAU5B;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,CAAC,OAAsE,EAAE,EAAE;IACtG,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACpD,MAAM,MAAM,GAAG,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,yBAAyB,CAAC,CAAC;QAEpD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,cAAc,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,MAAM,MAAM,iCAAiC,cAAc,aAAa,MAAM,KAAK,CAAC,CAAC;IACpG,CAAC;IAED,IAAI,CAAC,KAAK,IAAI,IAAA,6BAAqB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,kFAAkF,CAAC,CAAC;QAE7G,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAElE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAElC,IAAI,CAAC,KAAK;QAAE,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;IAEpF,OAAO,CAAC,GAAG,CAAC,mDAAmD,MAAM,GAAG,CAAC,CAAC;IAE1E,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC;AA7BW,QAAA,aAAa,iBA6BxB"}
+{"version":3,"file":"git.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/git.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAI1C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,IAAc,EAAa,EAAE;;IACrD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEjE,OAAO;QACL,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,mCAAI,CAAC;QAC1B,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACpC,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;KACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,IAAc,EAAE,EAAE,WAAC,OAAA,MAAA,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,mCAAI,CAAC,CAAA,EAAA,CAAC;AAE3G,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/D,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAJW,QAAA,aAAa,iBAIxB;AAEF,gFAAgF;AACzE,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE;IAChD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAEvD,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AAJW,QAAA,kBAAkB,sBAI7B;AAEK,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAA,0BAAkB,EAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAA5E,QAAA,qBAAqB,yBAAuD;AAEzF,kGAAkG;AAC3F,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE;IAC7C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAE9F,OAAO,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrE,CAAC,CAAC;AAJW,QAAA,eAAe,mBAI1B;AAEF,sGAAsG;AAC/F,MAAM,iBAAiB,GAAG,CAAC,OAA6C,EAAE,EAAE;IACjF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAErC,IAAI,IAAA,qBAAa,EAAC,QAAQ,CAAC,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,GAAG,CAAC,CAAC;QAErC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AAVW,QAAA,iBAAiB,qBAU5B;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,CAAC,OAAsE,EAAE,EAAE;IACtG,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACpD,MAAM,MAAM,GAAG,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,yBAAyB,CAAC,CAAC;QAEpD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,cAAc,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,MAAM,MAAM,iCAAiC,cAAc,aAAa,MAAM,KAAK,CAAC,CAAC;IACpG,CAAC;IAED,IAAI,CAAC,KAAK,IAAI,IAAA,6BAAqB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,kFAAkF,CAAC,CAAC;QAE7G,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAElE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAElC,IAAI,CAAC,KAAK;QAAE,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;IAEpF,OAAO,CAAC,GAAG,CAAC,mDAAmD,MAAM,GAAG,CAAC,CAAC;IAE1E,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC;AA7BW,QAAA,aAAa,iBA6BxB"}

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

@@ -1,3 +1,11 @@
-import { ApiDefinitions } from './definition';
+import { ApiDefinition, ApiDefinitions } from './definition';
 /** The help text for `et api`, listing the built-in commands and what each API adds to them. */
 export declare const apiHelp: (apis: ApiDefinitions, invocation: string) => string;
+/** The help text for one API: every command it accepts, what each one runs, and where its files are. */
+export declare const singleApiHelp: (options: {
+    name: string;
+    api: ApiDefinition;
+    invocation: string;
+    /** Where the checkout is, or what is wrong with it. */
+    checkout?: string;
+}) => string;

package/src/lib/api/help.js

@@ -1,39 +1,72 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiHelp = void 0;
+exports.singleApiHelp = exports.apiHelp = void 0;
 const definition_1 = require("./definition");
 const BUILT_IN_DESCRIPTIONS = {
     up: 'Start the containers of the API',
     down: 'Stop them',
-    logs: 'Follow the log of the API container',
-    shell: 'Open a shell in the API container',
+    logs: 'Follow the log of the API container, or of a service you name',
+    shell: 'Open a shell in the API container, or in a service you name',
     clone: 'Clone the API into .ethlete/<name> from its repoUrl',
+    clear: 'Remove the managed checkout in .ethlete/<name>',
     checkout: 'Switch the checkout to the branch apiRepoBranches names',
     pull: 'Fetch and fast-forward the checked-out branch',
+    setup: "Run the API's own setupCommand in its compose directory",
 };
 const pad = (text, width) => text.padEnd(width);
 /** The help text for `et api`, listing the built-in commands and what each API adds to them. */
 const apiHelp = (apis, invocation) => {
     const entries = Object.entries(apis);
     const width = Math.max(8, ...entries.map(([name]) => name.length));
+    const commandWidth = Math.max(8, ...definition_1.BUILT_IN_API_COMMANDS.map((command) => command.length), ...entries.flatMap(([, api]) => { var _a; return Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}).map((command) => command.length); }));
     const apiLines = entries.map(([name, api]) => `  ${pad(name, width)}  ${(0, definition_1.apiCommandNames)(api).join(', ')}`);
     const execNames = [...new Set(entries.flatMap(([, api]) => { var _a; return Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}); }))];
     return [
-        `Usage: ${invocation} <command> <api> [--host]`,
+        `Usage: ${invocation} <command> <api>[,<api>] [--host]`,
         '',
         'Commands',
-        ...definition_1.BUILT_IN_API_COMMANDS.map((command) => `  ${pad(command, 8)}  ${BUILT_IN_DESCRIPTIONS[command]}`),
-        ...execNames.map((command) => `  ${pad(command, 8)}  Declared by the API itself`),
+        ...definition_1.BUILT_IN_API_COMMANDS.map((command) => `  ${pad(command, commandWidth)}  ${BUILT_IN_DESCRIPTIONS[command]}`),
+        ...execNames.map((command) => `  ${pad(command, commandWidth)}  Declared by the API itself`),
+        `  ${pad('help', commandWidth)}  What one API accepts, and where its checkout is`,
         '',
         'APIs',
         ...(apiLines.length > 0 ? apiLines : ['  none — declare them in ethlete.apis.js']),
         '',
         'Options',
-        `  ${pad('--host', 8)}  Also print the address another device on this network can use`,
-        `  ${pad('--force', 8)}  With pull: discard local commits and tracked changes on the branch`,
-        `  ${pad('--clone', 8)}  Clone a missing checkout without asking first`,
-        `  ${pad('--help', 8)}  Show this text`,
+        `  ${pad('--host', commandWidth)}  Also print the address another device on this network can use`,
+        `  ${pad('--force', commandWidth)}  With up: start even when a port is taken. With pull or clear: lose local work`,
+        `  ${pad('--all', commandWidth)}  With clear: every API at once`,
+        `  ${pad('--clone', commandWidth)}  Clone a missing checkout without asking first`,
+        `  ${pad('--setup', commandWidth)}  Run the setup command for a missing env file without asking first`,
+        `  ${pad('--help', commandWidth)}  Show this text`,
     ].join('\n');
 };
 exports.apiHelp = apiHelp;
+const commandDescription = (api, command) => {
+    var _a, _b;
+    if (command === 'setup' && api.setupCommand)
+        return `Run "${api.setupCommand}" in ${api.composeDir}`;
+    const builtIn = definition_1.BUILT_IN_API_COMMANDS.find((candidate) => candidate === command);
+    return builtIn ? BUILT_IN_DESCRIPTIONS[builtIn] : ((_b = (_a = api.exec) === null || _a === void 0 ? void 0 : _a[command]) !== null && _b !== void 0 ? _b : []).join(' ');
+};
+/** The help text for one API: every command it accepts, what each one runs, and where its files are. */
+const singleApiHelp = (options) => {
+    const { name, api, invocation, checkout } = options;
+    const commands = (0, definition_1.apiCommandNames)(api);
+    const width = Math.max(8, ...commands.map((command) => command.length));
+    return [
+        `Usage: ${invocation} <command> ${name} [--host]`,
+        '',
+        'Commands',
+        ...commands.map((command) => `  ${pad(command, width)}  ${commandDescription(api, command)}`),
+        '',
+        'This API',
+        `  ${pad('url', width)}  http://localhost:${api.port}`,
+        `  ${pad('services', width)}  ${api.services.join(', ')}`,
+        ...(api.envFile ? [`  ${pad('env file', width)}  ${api.composeDir}/${api.envFile}`] : []),
+        ...(api.envKey ? [`  ${pad('envKey', width)}  ${api.envKey}`] : []),
+        ...(checkout ? ['', 'Checkout', ...checkout.split('\n').map((line) => `  ${line}`)] : []),
+    ].join('\n');
+};
+exports.singleApiHelp = singleApiHelp;
 //# sourceMappingURL=help.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"help.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/help.ts"],"names":[],"mappings":";;;AAAA,6CAAsF;AAEtF,MAAM,qBAAqB,GAA2D;IACpF,EAAE,EAAE,iCAAiC;IACrC,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,qCAAqC;IAC3C,KAAK,EAAE,mCAAmC;IAC1C,KAAK,EAAE,qDAAqD;IAC5D,QAAQ,EAAE,yDAAyD;IACnE,IAAI,EAAE,+CAA+C;CACtD,CAAC;AAEF,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAEhE,gGAAgG;AACzF,MAAM,OAAO,GAAG,CAAC,IAAoB,EAAE,UAAkB,EAAE,EAAE;IAClE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEnE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,IAAA,4BAAe,EAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAE3G,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,WAAC,OAAA,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC,CAAC,CAAC,CAAC;IAE1F,OAAO;QACL,UAAU,UAAU,2BAA2B;QAC/C,EAAE;QACF,UAAU;QACV,GAAG,kCAAqB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACpG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,8BAA8B,CAAC;QACjF,EAAE;QACF,MAAM;QACN,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,0CAA0C,CAAC,CAAC;QAClF,EAAE;QACF,SAAS;QACT,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,iEAAiE;QACtF,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,sEAAsE;QAC5F,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,iDAAiD;QACvE,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,kBAAkB;KACxC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC,CAAC;AAxBW,QAAA,OAAO,WAwBlB"}
+{"version":3,"file":"help.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/help.ts"],"names":[],"mappings":";;;AAAA,6CAAqG;AAErG,MAAM,qBAAqB,GAA2D;IACpF,EAAE,EAAE,iCAAiC;IACrC,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,+DAA+D;IACrE,KAAK,EAAE,6DAA6D;IACpE,KAAK,EAAE,qDAAqD;IAC5D,KAAK,EAAE,gDAAgD;IACvD,QAAQ,EAAE,yDAAyD;IACnE,IAAI,EAAE,+CAA+C;IACrD,KAAK,EAAE,yDAAyD;CACjE,CAAC;AAEF,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAEhE,gGAAgG;AACzF,MAAM,OAAO,GAAG,CAAC,IAAoB,EAAE,UAAkB,EAAE,EAAE;IAClE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAC3B,CAAC,EACD,GAAG,kCAAqB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,EACzD,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,WAAC,OAAA,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA,EAAA,CAAC,CAC9F,CAAC;IAEF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,IAAA,4BAAe,EAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAE3G,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,WAAC,OAAA,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC,CAAC,CAAC,CAAC;IAE1F,OAAO;QACL,UAAU,UAAU,mCAAmC;QACvD,EAAE;QACF,UAAU;QACV,GAAG,kCAAqB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,KAAK,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/G,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,8BAA8B,CAAC;QAC5F,KAAK,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,mDAAmD;QACjF,EAAE;QACF,MAAM;QACN,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,0CAA0C,CAAC,CAAC;QAClF,EAAE;QACF,SAAS;QACT,KAAK,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,iEAAiE;QACjG,KAAK,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,iFAAiF;QAClH,KAAK,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,iCAAiC;QAChE,KAAK,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,iDAAiD;QAClF,KAAK,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,qEAAqE;QACtG,KAAK,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,kBAAkB;KACnD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC,CAAC;AAhCW,QAAA,OAAO,WAgClB;AAEF,MAAM,kBAAkB,GAAG,CAAC,GAAkB,EAAE,OAAe,EAAE,EAAE;;IACjE,IAAI,OAAO,KAAK,OAAO,IAAI,GAAG,CAAC,YAAY;QAAE,OAAO,QAAQ,GAAG,CAAC,YAAY,QAAQ,GAAG,CAAC,UAAU,EAAE,CAAC;IAErG,MAAM,OAAO,GAAG,kCAAqB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,OAAO,CAAC,CAAC;IAEjF,OAAO,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAA,MAAA,GAAG,CAAC,IAAI,0CAAG,OAAO,CAAC,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1F,CAAC,CAAC;AAEF,wGAAwG;AACjG,MAAM,aAAa,GAAG,CAAC,OAM7B,EAAE,EAAE;IACH,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IACpD,MAAM,QAAQ,GAAG,IAAA,4BAAe,EAAC,GAAG,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAExE,OAAO;QACL,UAAU,UAAU,cAAc,IAAI,WAAW;QACjD,EAAE;QACF,UAAU;QACV,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;QAC7F,EAAE;QACF,UAAU;QACV,KAAK,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,sBAAsB,GAAG,CAAC,IAAI,EAAE;QACtD,KAAK,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzD,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzF,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC,CAAC;AAxBW,QAAA,aAAa,iBAwBxB"}

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

@@ -1,10 +1,15 @@
 export * from './api-command';
 export * from './compose';
 export * from './auth-hint';
+export * from './clear';
 export * from './clone';
 export * from './definition';
 export * from './git';
 export * from './help';
 export * from './load-definitions';
+export * from './ports';
 export * from './resolve-checkout';
 export * from './run';
+export * from './setup';
+export * from './state';
+export * from './suggest';

package/src/lib/api/index.js

@@ -4,11 +4,16 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./api-command"), exports);
 tslib_1.__exportStar(require("./compose"), exports);
 tslib_1.__exportStar(require("./auth-hint"), exports);
+tslib_1.__exportStar(require("./clear"), exports);
 tslib_1.__exportStar(require("./clone"), exports);
 tslib_1.__exportStar(require("./definition"), exports);
 tslib_1.__exportStar(require("./git"), exports);
 tslib_1.__exportStar(require("./help"), exports);
 tslib_1.__exportStar(require("./load-definitions"), exports);
+tslib_1.__exportStar(require("./ports"), exports);
 tslib_1.__exportStar(require("./resolve-checkout"), exports);
 tslib_1.__exportStar(require("./run"), exports);
+tslib_1.__exportStar(require("./setup"), exports);
+tslib_1.__exportStar(require("./state"), exports);
+tslib_1.__exportStar(require("./suggest"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,oDAA0B;AAC1B,sDAA4B;AAC5B,kDAAwB;AACxB,uDAA6B;AAC7B,gDAAsB;AACtB,iDAAuB;AACvB,6DAAmC;AACnC,6DAAmC;AACnC,gDAAsB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,oDAA0B;AAC1B,sDAA4B;AAC5B,kDAAwB;AACxB,kDAAwB;AACxB,uDAA6B;AAC7B,gDAAsB;AACtB,iDAAuB;AACvB,6DAAmC;AACnC,kDAAwB;AACxB,6DAAmC;AACnC,gDAAsB;AACtB,kDAAwB;AACxB,kDAAwB;AACxB,oDAA0B"}

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

@@ -0,0 +1,13 @@
+/**
+ * Host ports the named services publish, read from the resolved output of `compose config`. It
+ * accepts the short form podman-compose prints and the long form docker compose prints.
+ *
+ * Only the named services are read. A compose file usually declares more than an app needs, and a
+ * service that never starts must not make a port look taken.
+ */
+export declare const publishedPorts: (options: {
+    config: string;
+    services: readonly string[];
+}) => number[];
+/** The ports nothing else may bind right now, so `up` cannot publish them. */
+export declare const portsInUse: (ports: readonly number[]) => Promise<number[]>;

package/src/lib/api/ports.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.portsInUse = exports.publishedPorts = void 0;
+const tslib_1 = require("tslib");
+const net_1 = require("net");
+const indentOf = (line) => line.length - line.trimStart().length;
+const PUBLISHED_KEY = /^published:\s*['"]?(\d+)/;
+/**
+ * Host port of a short-form entry such as `8040:80`, `127.0.0.1:8040:80` or `[::1]:8040:80/udp`.
+ * It is the second-to-last segment, so a bind address of any shape stays out of the way. An entry
+ * that names only a container port, or a port range, has no single host port to check.
+ */
+const shortFormHostPort = (entry) => {
+    var _a, _b, _c;
+    const parts = (_b = (_a = entry.replace(/['"]/g, '').split('/')[0]) === null || _a === void 0 ? void 0 : _a.split(':')) !== null && _b !== void 0 ? _b : [];
+    if (parts.length < 2)
+        return undefined;
+    const host = (_c = parts[parts.length - 2]) !== null && _c !== void 0 ? _c : '';
+    return /^\d+$/.test(host) ? Number(host) : undefined;
+};
+/**
+ * Host ports the named services publish, read from the resolved output of `compose config`. It
+ * accepts the short form podman-compose prints and the long form docker compose prints.
+ *
+ * Only the named services are read. A compose file usually declares more than an app needs, and a
+ * service that never starts must not make a port look taken.
+ */
+const publishedPorts = (options) => {
+    var _a;
+    const { config, services } = options;
+    const wanted = new Set(services);
+    const ports = new Set();
+    let servicesIndent;
+    let serviceIndent;
+    let portsIndent;
+    let inWantedService = false;
+    for (const line of config.split('\n')) {
+        const text = line.trim();
+        if (text === '' || text.startsWith('#'))
+            continue;
+        const indent = indentOf(line);
+        if (servicesIndent === undefined) {
+            if (text === 'services:')
+                servicesIndent = indent;
+            continue;
+        }
+        if (indent <= servicesIndent && !text.startsWith('-')) {
+            servicesIndent = text === 'services:' ? indent : undefined;
+            serviceIndent = undefined;
+            portsIndent = undefined;
+            inWantedService = false;
+            continue;
+        }
+        serviceIndent !== null && serviceIndent !== void 0 ? serviceIndent : (serviceIndent = indent);
+        if (indent === serviceIndent) {
+            inWantedService = wanted.has(text.replace(/:$/, ''));
+            portsIndent = undefined;
+            continue;
+        }
+        if (!inWantedService)
+            continue;
+        if (text === 'ports:') {
+            portsIndent = indent;
+            continue;
+        }
+        if (portsIndent === undefined)
+            continue;
+        if (indent < portsIndent || (indent === portsIndent && !text.startsWith('-'))) {
+            portsIndent = undefined;
+            continue;
+        }
+        const published = (_a = PUBLISHED_KEY.exec(text)) === null || _a === void 0 ? void 0 : _a[1];
+        if (published !== undefined) {
+            ports.add(Number(published));
+            continue;
+        }
+        if (!text.startsWith('-'))
+            continue;
+        const short = shortFormHostPort(text.slice(1).trim());
+        if (short !== undefined)
+            ports.add(short);
+    }
+    return [...ports].sort((a, b) => a - b);
+};
+exports.publishedPorts = publishedPorts;
+const isPortFree = (port) => new Promise((resolve) => {
+    const server = (0, net_1.createServer)();
+    server.once('error', () => resolve(false));
+    server.once('listening', () => server.close(() => resolve(true)));
+    server.listen(port, '0.0.0.0');
+});
+/** The ports nothing else may bind right now, so `up` cannot publish them. */
+const portsInUse = (ports) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const checked = yield Promise.all(ports.map((port) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return ({ port, free: yield isPortFree(port) }); })));
+    return checked.filter(({ free }) => !free).map(({ port }) => port);
+});
+exports.portsInUse = portsInUse;
+//# sourceMappingURL=ports.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ports.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/ports.ts"],"names":[],"mappings":";;;;AAAA,6BAAmC;AAEnC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC;AAEzE,MAAM,aAAa,GAAG,0BAA0B,CAAC;AAEjD;;;;GAIG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE;;IAC1C,MAAM,KAAK,GAAG,MAAA,MAAA,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,GAAG,CAAC,mCAAI,EAAE,CAAC;IAEzE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAEvC,MAAM,IAAI,GAAG,MAAA,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,mCAAI,EAAE,CAAC;IAE3C,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC,CAAC;AAEF;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAAC,OAAwD,EAAE,EAAE;;IACzF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAEhC,IAAI,cAAkC,CAAC;IACvC,IAAI,aAAiC,CAAC;IACtC,IAAI,WAA+B,CAAC;IACpC,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAEzB,IAAI,IAAI,KAAK,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAElD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,IAAI,KAAK,WAAW;gBAAE,cAAc,GAAG,MAAM,CAAC;YAElD,SAAS;QACX,CAAC;QAED,IAAI,MAAM,IAAI,cAAc,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACtD,cAAc,GAAG,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3D,aAAa,GAAG,SAAS,CAAC;YAC1B,WAAW,GAAG,SAAS,CAAC;YACxB,eAAe,GAAG,KAAK,CAAC;YAExB,SAAS;QACX,CAAC;QAED,aAAa,aAAb,aAAa,cAAb,aAAa,IAAb,aAAa,GAAK,MAAM,EAAC;QAEzB,IAAI,MAAM,KAAK,aAAa,EAAE,CAAC;YAC7B,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;YACrD,WAAW,GAAG,SAAS,CAAC;YAExB,SAAS;QACX,CAAC;QAED,IAAI,CAAC,eAAe;YAAE,SAAS;QAE/B,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtB,WAAW,GAAG,MAAM,CAAC;YAErB,SAAS;QACX,CAAC;QAED,IAAI,WAAW,KAAK,SAAS;YAAE,SAAS;QAExC,IAAI,MAAM,GAAG,WAAW,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9E,WAAW,GAAG,SAAS,CAAC;YAExB,SAAS;QACX,CAAC;QAED,MAAM,SAAS,GAAG,MAAA,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,0CAAG,CAAC,CAAC,CAAC;QAEhD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YAE7B,SAAS;QACX,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAEpC,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAEtD,IAAI,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1C,CAAC,CAAC;AAzEW,QAAA,cAAc,kBAyEzB;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAClC,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,EAAE;IAC/B,MAAM,MAAM,GAAG,IAAA,kBAAY,GAAE,CAAC;IAE9B,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC;AAEL,8EAA8E;AACvE,MAAM,UAAU,GAAG,CAAO,KAAwB,EAAE,EAAE;IAC3D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAO,IAAI,EAAE,EAAE,0DAAC,OAAA,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA,GAAA,CAAC,CAAC,CAAC;IAEvG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC,CAAA,CAAC;AAJW,QAAA,UAAU,cAIrB"}

package/src/lib/api/resolve-checkout.d.ts

@@ -1,10 +1,19 @@
 import { CloneRequest } from './clone';
 import { ApiDefinition } from './definition';
+import { SetupRequest } from './setup';
 export type ApiCheckout = {
     repoPath: string;
     /** The directory the compose commands run in. */
     composePath: string;
 };
+export type ApiCheckoutFailure = {
+    ok: false;
+    problem: string;
+    /** Set when the managed directory is empty and the API declares where to clone from. */
+    clonable?: CloneRequest;
+    /** Set when the env file is missing and the API declares a `setupCommand` that creates it. */
+    setupable?: SetupRequest;
+};
 /**
  * `legacyConfigWarning` is set on failure too. A wrong path is exactly when the developer needs to
  * know which file the value actually came from.
@@ -14,12 +23,13 @@ export type ApiCheckoutResult = {
 } & ({
     ok: true;
     checkout: ApiCheckout;
-} | {
-    ok: false;
-    problem: string;
-    /** Set when the managed directory is empty and the API declares where to clone from. */
-    clonable?: CloneRequest;
-});
+} | ApiCheckoutFailure);
+/** The problem, plus the `et api` command that fixes it, so no message sends the reader to a Makefile. */
+export declare const checkoutProblem: (options: {
+    failure: ApiCheckoutFailure;
+    name: string;
+    invocation: string;
+}) => string;
 /** Where an API's managed checkout goes when the developer configured no path of their own. */
 export declare const managedCheckoutPath: (root: string, name: string) => string;
 /** Resolves where an API's containers live, with the one message that explains each way it can fail. */
@@ -28,8 +38,8 @@ export declare const resolveApiCheckout: (options: {
     name: string;
     api: ApiDefinition;
     /**
-     * The git commands act on the checkout itself, so they must not demand a compose directory or the
-     * output of `setupCommand` — both can legitimately be absent on a checkout that was just cloned.
+     * How much of the checkout the command needs. The git commands act on the checkout itself, and
+     * `setup` writes the env file, so neither can demand what it is there to produce.
      */
-    requireCompose?: boolean;
+    needs?: "repo" | "compose" | "env";
 }) => ApiCheckoutResult;

package/src/lib/api/resolve-checkout.js

@@ -1,10 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveApiCheckout = exports.managedCheckoutPath = void 0;
+exports.resolveApiCheckout = exports.managedCheckoutPath = exports.checkoutProblem = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const local_config_1 = require("../config/local-config");
 const clone_1 = require("./clone");
+/** The problem, plus the `et api` command that fixes it, so no message sends the reader to a Makefile. */
+const checkoutProblem = (options) => {
+    const { failure, name, invocation } = options;
+    if (failure.clonable)
+        return `${failure.problem} Run "${invocation} clone ${name}".`;
+    if (failure.setupable)
+        return `${failure.problem} Run "${invocation} setup ${name}".`;
+    return failure.problem;
+};
+exports.checkoutProblem = checkoutProblem;
 const isDirectory = (path) => (0, fs_1.existsSync)(path) && (0, fs_1.statSync)(path).isDirectory();
 const missingPathProblem = (options) => {
     var _a;
@@ -18,7 +28,7 @@ const managedCheckoutPath = (root, name) => (0, path_1.join)(root, clone_1.DEFAU
 exports.managedCheckoutPath = managedCheckoutPath;
 /** Resolves where an API's containers live, with the one message that explains each way it can fail. */
 const resolveApiCheckout = (options) => {
-    const { root, name, api, requireCompose = true } = options;
+    const { root, name, api, needs = 'env' } = options;
     const { config, fileName, isLegacy } = (0, local_config_1.readLocalConfig)(root);
     const configured = (0, local_config_1.configuredApiRepoPath)(config, name);
     const legacyConfigWarning = isLegacy
@@ -58,18 +68,21 @@ const resolveApiCheckout = (options) => {
         };
     }
     const composePath = (0, path_1.join)(repoPath, api.composeDir);
-    if (requireCompose && !isDirectory(composePath)) {
+    if (needs === 'repo')
+        return { ok: true, legacyConfigWarning, checkout: { repoPath, composePath } };
+    if (!isDirectory(composePath)) {
         return {
             ok: false,
             legacyConfigWarning,
             problem: `${repoPath} has no ${api.composeDir} directory. Is apiRepoPaths.${name} the right checkout?`,
         };
     }
-    if (requireCompose && api.envFile && !(0, fs_1.existsSync)((0, path_1.join)(composePath, api.envFile))) {
+    if (needs === 'env' && api.envFile && !(0, fs_1.existsSync)((0, path_1.join)(composePath, api.envFile))) {
         return {
             ok: false,
             legacyConfigWarning,
-            problem: `Missing ${api.envFile} in ${composePath}.${api.setupCommand ? ` Run "${api.setupCommand}" there first.` : ''}`,
+            problem: `Missing ${api.envFile} in ${composePath}.`,
+            setupable: api.setupCommand ? { setupCommand: api.setupCommand, composePath, envFile: api.envFile } : undefined,
         };
     }
     return { ok: true, legacyConfigWarning, checkout: { repoPath, composePath } };

package/src/lib/api/resolve-checkout.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-checkout.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/resolve-checkout.ts"],"names":[],"mappings":";;;AAAA,2BAA0C;AAC1C,+BAA4B;AAC5B,yDAOgC;AAChC,mCAA6D;AAuB7D,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,IAAI,IAAA,aAAQ,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AAEvF,MAAM,kBAAkB,GAAG,CAAC,OAA6D,EAAE,EAAE;;IAC3F,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEtC,OAAO,CACL,GAAG,MAAM,4BAA4B,IAAI,oBAAoB,qCAAsB,eAAe;QAClG,0EAA0E;QAC1E,sCAAsC,IAAI,OAAO,MAAA,GAAG,CAAC,WAAW,mCAAI,MAAM,IAAI,MAAM,eAAe,CACpG,CAAC;AACJ,CAAC,CAAC;AAEF,+FAA+F;AACxF,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,4BAAoB,EAAE,IAAI,CAAC,CAAC;AAA7F,QAAA,mBAAmB,uBAA0E;AAE1G,wGAAwG;AACjG,MAAM,kBAAkB,GAAG,CAAC,OASlC,EAAqB,EAAE;IACtB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAC3D,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAA,8BAAe,EAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,IAAA,oCAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvD,MAAM,mBAAmB,GAAG,QAAQ;QAClC,CAAC,CAAC,GAAG,4CAA6B,2CAA2C,qCAAsB,GAAG;QACtG,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,oCAAqB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAA,2BAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAExG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,IAAI,UAAU,EAAE,CAAC;YACf,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,mBAAmB;gBACnB,OAAO,EAAE,gBAAgB,IAAI,cAAc,QAAQ,yCAAyC;aAC7F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,mBAAmB;gBACnB,OAAO,EAAE,kBAAkB,CAAC;oBAC1B,IAAI;oBACJ,GAAG;oBACH,MAAM,EAAE,QAAQ;wBACd,CAAC,CAAC,GAAG,QAAQ,mCAAmC,IAAI,qCAAqC;wBACzF,CAAC,CAAC,GAAG,IAAI,oDAAoD;iBAChE,CAAC;aACH,CAAC;QACJ,CAAC;QAED,OAAO;YACL,EAAE,EAAE,KAAK;YACT,mBAAmB;YACnB,OAAO,EAAE,GAAG,IAAI,uBAAuB,QAAQ,GAAG;YAClD,QAAQ,EAAE;gBACR,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,IAAA,sCAAuB,EAAC,MAAM,EAAE,IAAI,CAAC;aAC9C;SACF,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAEnD,IAAI,cAAc,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;QAChD,OAAO;YACL,EAAE,EAAE,KAAK;YACT,mBAAmB;YACnB,OAAO,EAAE,GAAG,QAAQ,WAAW,GAAG,CAAC,UAAU,+BAA+B,IAAI,sBAAsB;SACvG,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QACjF,OAAO;YACL,EAAE,EAAE,KAAK;YACT,mBAAmB;YACnB,OAAO,EAAE,WAAW,GAAG,CAAC,OAAO,OAAO,WAAW,IAC/C,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,YAAY,gBAAgB,CAAC,CAAC,CAAC,EACjE,EAAE;SACH,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC;AAChF,CAAC,CAAC;AA3EW,QAAA,kBAAkB,sBA2E7B"}
+{"version":3,"file":"resolve-checkout.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/resolve-checkout.ts"],"names":[],"mappings":";;;AAAA,2BAA0C;AAC1C,+BAA4B;AAC5B,yDAOgC;AAChC,mCAA6D;AA2B7D,0GAA0G;AACnG,MAAM,eAAe,GAAG,CAAC,OAA0E,EAAE,EAAE;IAC5G,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAE9C,IAAI,OAAO,CAAC,QAAQ;QAAE,OAAO,GAAG,OAAO,CAAC,OAAO,SAAS,UAAU,UAAU,IAAI,IAAI,CAAC;IAErF,IAAI,OAAO,CAAC,SAAS;QAAE,OAAO,GAAG,OAAO,CAAC,OAAO,SAAS,UAAU,UAAU,IAAI,IAAI,CAAC;IAEtF,OAAO,OAAO,CAAC,OAAO,CAAC;AACzB,CAAC,CAAC;AARW,QAAA,eAAe,mBAQ1B;AAEF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,IAAI,IAAA,aAAQ,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AAEvF,MAAM,kBAAkB,GAAG,CAAC,OAA6D,EAAE,EAAE;;IAC3F,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEtC,OAAO,CACL,GAAG,MAAM,4BAA4B,IAAI,oBAAoB,qCAAsB,eAAe;QAClG,0EAA0E;QAC1E,sCAAsC,IAAI,OAAO,MAAA,GAAG,CAAC,WAAW,mCAAI,MAAM,IAAI,MAAM,eAAe,CACpG,CAAC;AACJ,CAAC,CAAC;AAEF,+FAA+F;AACxF,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,4BAAoB,EAAE,IAAI,CAAC,CAAC;AAA7F,QAAA,mBAAmB,uBAA0E;AAE1G,wGAAwG;AACjG,MAAM,kBAAkB,GAAG,CAAC,OASlC,EAAqB,EAAE;IACtB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IACnD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAA,8BAAe,EAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,IAAA,oCAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvD,MAAM,mBAAmB,GAAG,QAAQ;QAClC,CAAC,CAAC,GAAG,4CAA6B,2CAA2C,qCAAsB,GAAG;QACtG,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,oCAAqB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAA,2BAAmB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAExG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,IAAI,UAAU,EAAE,CAAC;YACf,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,mBAAmB;gBACnB,OAAO,EAAE,gBAAgB,IAAI,cAAc,QAAQ,yCAAyC;aAC7F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,mBAAmB;gBACnB,OAAO,EAAE,kBAAkB,CAAC;oBAC1B,IAAI;oBACJ,GAAG;oBACH,MAAM,EAAE,QAAQ;wBACd,CAAC,CAAC,GAAG,QAAQ,mCAAmC,IAAI,qCAAqC;wBACzF,CAAC,CAAC,GAAG,IAAI,oDAAoD;iBAChE,CAAC;aACH,CAAC;QACJ,CAAC;QAED,OAAO;YACL,EAAE,EAAE,KAAK;YACT,mBAAmB;YACnB,OAAO,EAAE,GAAG,IAAI,uBAAuB,QAAQ,GAAG;YAClD,QAAQ,EAAE;gBACR,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,IAAA,sCAAuB,EAAC,MAAM,EAAE,IAAI,CAAC;aAC9C;SACF,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAEnD,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC;IAEpG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;QAC9B,OAAO;YACL,EAAE,EAAE,KAAK;YACT,mBAAmB;YACnB,OAAO,EAAE,GAAG,QAAQ,WAAW,GAAG,CAAC,UAAU,+BAA+B,IAAI,sBAAsB;SACvG,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,KAAK,KAAK,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO;YACL,EAAE,EAAE,KAAK;YACT,mBAAmB;YACnB,OAAO,EAAE,WAAW,GAAG,CAAC,OAAO,OAAO,WAAW,GAAG;YACpD,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS;SAChH,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC;AAChF,CAAC,CAAC;AA5EW,QAAA,kBAAkB,sBA4E7B"}