deploy-vir 2.0.0 → 2.1.1

package/dist/cli/cli.js

@@ -1,7 +1,8 @@
 import { assertWrap } from '@augment-vir/assert';
 import { awaitedForEach, extractErrorMessage, log } from '@augment-vir/common';
+import { select } from '@inquirer/prompts';
 import { resolve } from 'node:path';
-import simpleGit from 'simple-git';
+import { simpleGit } from 'simple-git';
 import { getGitRemoteName, pushDeploy } from '../git.js';
 import { KnownError } from '../known.error.js';
 import { sendNotifications } from '../notifications/send-notifications.js';
@@ -12,9 +13,23 @@ import { sendNotifications } from '../notifications/send-notifications.js';
  */
 export async function runDeployVirCli({ args, y, }, cwd = process.cwd()) {
     const configPath = assertWrap.isTruthy(args[0], 'Missing config path.');
-    const repoName = assertWrap.isTruthy(args[1], 'Missing repo name.');
-    const deployName = assertWrap.isTruthy(args[2], 'Missing deploy name.');
     const config = (await import(resolve(cwd, configPath))).default;
+    const repoName = assertWrap.isTruthy(args[1] ||
+        (await select({
+            message: 'Choose a repo to deploy:',
+            choices: config.repos.map((repo) => {
+                return repo.name;
+            }),
+        })), 'Missing repo name.');
+    const deployName = assertWrap.isTruthy(args[2] ||
+        (await select({
+            message: 'Choose a deploy to trigger:',
+            choices: assertWrap
+                .isDefined(config.repos.find((repo) => repo.name === repoName), `Invalid repo name: '${repoName}'`)
+                .deploys.map((deploy) => {
+                return deploy.deployName;
+            }),
+        })), 'Missing deploy name.');
     await runDeployVir({
         cwd,
         deployName,

package/dist/git.d.ts

@@ -38,6 +38,7 @@ export type DeployBranchStatus = {
 export type DeployResult = {
     deployCommits: DeployCommits;
     branchStatus: DeployBranchStatus;
+    toBranchName: string;
 };
 /**
  * Push the deploy via git.

package/dist/git.js

@@ -88,6 +88,7 @@ export async function pushDeploy(git, { deployName, branches }, remoteName, bypa
             await git.push(remoteName, pushString);
         }
         return {
+            toBranchName: toBranch,
             deployCommits: {
                 deployedCommits: commitsAhead,
                 overwrittenCommits: commitsBehind,

package/dist/notifications/slack.d.ts

@@ -5,4 +5,4 @@ export { type ChatPostMessageArguments } from '@slack/web-api';
  *
  * @category Internal
  */
-export declare function sendNotificationToSlack({ branchConfig, deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, }, notification, repoConfig, }: Readonly<NotificationParams>): Promise<void>;
+export declare function sendNotificationToSlack({ deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, toBranchName, }, notification, repoConfig, }: Readonly<NotificationParams>): Promise<void>;

package/dist/notifications/slack.js

@@ -38,7 +38,7 @@ function chunkSectionLines(lines) {
  *
  * @category Internal
  */
-export async function sendNotificationToSlack({ branchConfig, deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, }, notification, repoConfig, }) {
+export async function sendNotificationToSlack({ deployResult: { deployCommits: { deployedCommits, overwrittenCommits }, branchStatus: { after, before }, toBranchName, }, notification, repoConfig, }) {
     const deployedCommitBullets = deployedCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
     const overwrittenCommitBullets = overwrittenCommits.map((commit) => formatCommit(repoConfig.commitBaseUrl, commit));
     const deployedCommitBulletLines = deployedCommitBullets.map((bullet) => `- ${bullet}`);
@@ -56,7 +56,7 @@ export async function sendNotificationToSlack({ branchConfig, deployResult: { de
             type: 'section',
             text: {
                 type: 'mrkdwn',
-                text: `*${setFirstLetterCasing(repoConfig.name, StringCase.Upper)} ${setFirstLetterCasing(branchConfig.deployName, StringCase.Upper)}* Pushed`,
+                text: `*${setFirstLetterCasing(repoConfig.name, StringCase.Upper)} ${setFirstLetterCasing(toBranchName, StringCase.Upper)}* Pushed`,
             },
         },
         {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-vir",
-    "version": "2.0.0",
+    "version": "2.1.1",
     "description": "Deploy a branch to another branch with notifications.",
     "keywords": [
         "deploy",
@@ -41,9 +41,9 @@
         "test:update": "npm run test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.57.1",
-        "@augment-vir/common": "^31.57.1",
-        "@augment-vir/node": "^31.57.1",
+        "@augment-vir/assert": "^31.57.5",
+        "@augment-vir/common": "^31.57.5",
+        "@augment-vir/node": "^31.57.5",
         "@inquirer/prompts": "^8.1.0",
         "@slack/web-api": "^7.13.0",
         "cli-vir": "^1.0.3",
@@ -57,9 +57,9 @@
         "@stylistic/eslint-plugin": "^5.6.1",
         "@stylistic/eslint-plugin-ts": "^4.4.1",
         "@types/node": "^25.0.3",
-        "@typescript-eslint/eslint-plugin": "^8.50.1",
+        "@typescript-eslint/eslint-plugin": "^8.52.0",
         "cspell": "^9.4.0",
-        "dependency-cruiser": "^17.3.5",
+        "dependency-cruiser": "^17.3.6",
         "esbuild": "^0.27.2",
         "eslint": "^9.39.2",
         "eslint-config-prettier": "^10.1.8",
@@ -72,7 +72,7 @@
         "eslint-plugin-unicorn": "^62.0.0",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "npm-check-updates": "^19.2.0",
+        "npm-check-updates": "^19.3.1",
         "prettier": "~3.3.3",
         "prettier-plugin-interpolated-html-tags": "^2.0.1",
         "prettier-plugin-jsdoc": "^1.8.0",
@@ -84,8 +84,8 @@
         "runstorm": "^1.0.0",
         "typedoc": "^0.28.15",
         "typescript": "^5.9.3",
-        "typescript-eslint": "^8.50.1",
-        "virmator": "^14.4.0"
+        "typescript-eslint": "^8.52.0",
+        "virmator": "^14.4.2"
     },
     "engines": {
         "node": ">=22"

package/src/cli/cli.ts

@@ -1,7 +1,8 @@
 import {assertWrap} from '@augment-vir/assert';
 import {awaitedForEach, extractErrorMessage, log} from '@augment-vir/common';
+import {select} from '@inquirer/prompts';
 import {resolve} from 'node:path';
-import simpleGit from 'simple-git';
+import {simpleGit} from 'simple-git';
 import {type DeployVirConfig} from '../config.js';
 import {getGitRemoteName, pushDeploy} from '../git.js';
 import {KnownError} from '../known.error.js';
@@ -23,10 +24,34 @@ export async function runDeployVirCli(
     cwd = process.cwd(),
 ) {
     const configPath = assertWrap.isTruthy(args[0], 'Missing config path.');
-    const repoName = assertWrap.isTruthy(args[1], 'Missing repo name.');
-    const deployName = assertWrap.isTruthy(args[2], 'Missing deploy name.');
 
-    const config = (await import(resolve(cwd, configPath))).default;
+    const config = (await import(resolve(cwd, configPath))).default as DeployVirConfig;
+
+    const repoName = assertWrap.isTruthy(
+        args[1] ||
+            (await select({
+                message: 'Choose a repo to deploy:',
+                choices: config.repos.map((repo) => {
+                    return repo.name;
+                }),
+            })),
+        'Missing repo name.',
+    );
+    const deployName = assertWrap.isTruthy(
+        args[2] ||
+            (await select({
+                message: 'Choose a deploy to trigger:',
+                choices: assertWrap
+                    .isDefined(
+                        config.repos.find((repo) => repo.name === repoName),
+                        `Invalid repo name: '${repoName}'`,
+                    )
+                    .deploys.map((deploy) => {
+                        return deploy.deployName;
+                    }),
+            })),
+        'Missing deploy name.',
+    );
 
     await runDeployVir(
         {

package/src/git.ts

@@ -79,6 +79,7 @@ export type DeployBranchStatus = {
 export type DeployResult = {
     deployCommits: DeployCommits;
     branchStatus: DeployBranchStatus;
+    toBranchName: string;
 };
 
 /**
@@ -92,108 +93,112 @@ export async function pushDeploy(
     remoteName: string,
     bypassConfirmation = false,
 ): Promise<DeployResult[]> {
-    return await awaitedBlockingMap(branches, async ({fromBranch, toBranch}) => {
-        assert.isTruthy(fromBranch, `Deploy '${deployName}' fromBranch cannot be empty.`);
-        assert.isTruthy(toBranch, `Deploy '${deployName}' toBranch cannot be empty.`);
-        assert.isTruthy(remoteName, 'Remote name cannot be empty.');
-
-        log.faint(`Pushing ${remoteName}/${fromBranch} to ${toBranch}`);
-
-        await git.fetch(remoteName, fromBranch);
-        await git.fetch(remoteName, toBranch);
+    return await awaitedBlockingMap(
+        branches,
+        async ({fromBranch, toBranch}): Promise<DeployResult> => {
+            assert.isTruthy(fromBranch, `Deploy '${deployName}' fromBranch cannot be empty.`);
+            assert.isTruthy(toBranch, `Deploy '${deployName}' toBranch cannot be empty.`);
+            assert.isTruthy(remoteName, 'Remote name cannot be empty.');
+
+            log.faint(`Pushing ${remoteName}/${fromBranch} to ${toBranch}`);
+
+            await git.fetch(remoteName, fromBranch);
+            await git.fetch(remoteName, toBranch);
+
+            const pushString = `${remoteName}/${fromBranch}:${toBranch}`;
+
+            // Get the current commit on the target branch before pushing
+            const beforeCommit = assertWrap.isDefined(
+                (
+                    await git.log([
+                        `${remoteName}/${toBranch}`,
+                        '-1',
+                    ])
+                ).latest,
+                `Failed to get current commit for ${remoteName}/${toBranch}`,
+            );
 
-        const pushString = `${remoteName}/${fromBranch}:${toBranch}`;
+            const afterCommit = assertWrap.isDefined(
+                (
+                    await git.log([
+                        `${remoteName}/${fromBranch}`,
+                        '-1',
+                    ])
+                ).latest,
+                `Failed to get current commit for ${remoteName}/${fromBranch}`,
+            );
 
-        // Get the current commit on the target branch before pushing
-        const beforeCommit = assertWrap.isDefined(
-            (
+            /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
+            const commitsAhead = (
                 await git.log([
-                    `${remoteName}/${toBranch}`,
-                    '-1',
+                    `${remoteName}/${toBranch}..${remoteName}/${fromBranch}`,
                 ])
-            ).latest,
-            `Failed to get current commit for ${remoteName}/${toBranch}`,
-        );
+            ).all;
+
+            if (!commitsAhead.length) {
+                throw new KnownError('No commit diff: nothing to deploy!');
+            }
 
-        const afterCommit = assertWrap.isDefined(
-            (
+            /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
+            const commitsBehind = (
                 await git.log([
-                    `${remoteName}/${fromBranch}`,
-                    '-1',
+                    `${remoteName}/${fromBranch}..${remoteName}/${toBranch}`,
                 ])
-            ).latest,
-            `Failed to get current commit for ${remoteName}/${fromBranch}`,
-        );
-
-        /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
-        const commitsAhead = (
-            await git.log([
-                `${remoteName}/${toBranch}..${remoteName}/${fromBranch}`,
-            ])
-        ).all;
-
-        if (!commitsAhead.length) {
-            throw new KnownError('No commit diff: nothing to deploy!');
-        }
-
-        /** Get commits that are on {@link toBranch} but not on {@link fromBranch}. */
-        const commitsBehind = (
-            await git.log([
-                `${remoteName}/${fromBranch}..${remoteName}/${toBranch}`,
-            ])
-        ).all;
-
-        const requiresForcePush = commitsBehind.length > 0;
-
-        log.info(
-            `\n${requiresForcePush ? 'Only on' : 'Releasing from'} ${logColors.bold}${fromBranch}${logColors.reset}:`,
-        );
-        commitsAhead.forEach((commit, index) => {
-            log.faint(
-                `    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`,
-            );
-        });
+            ).all;
 
-        if (requiresForcePush) {
-            log.info(`\nOnly on ${logColors.bold}${toBranch}${logColors.reset}:`);
-            commitsBehind.forEach((commit, index) => {
+            const requiresForcePush = commitsBehind.length > 0;
+
+            log.info(
+                `\n${requiresForcePush ? 'Only on' : 'Releasing from'} ${logColors.bold}${fromBranch}${logColors.reset}:`,
+            );
+            commitsAhead.forEach((commit, index) => {
                 log.faint(
                     `    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`,
                 );
             });
-        }
-
-        const shouldPush =
-            bypassConfirmation ||
-            (await confirm({
-                message: requiresForcePush
-                    ? `\n${logColors.warning}Do you want to force push ${logColors.bold}${fromBranch}${logColors.normalWeight} to ${logColors.bold}${toBranch}${logColors.normalWeight}?\n\nThis will overwrite the commits only on ${logColors.bold}${toBranch}${logColors.normalWeight}.${logColors.reset}?`
-                    : 'Ready to deploy?',
-                default: false,
-            }));
-
-        if (!shouldPush) {
-            throw new KnownError(`Deploy aborted.`);
-        }
-
-        if (requiresForcePush) {
-            await git.push(remoteName, pushString, ['--force']);
-            log.warning(
-                `Force pushed ${logColors.bold}${fromBranch}${logColors.normalWeight} to ${logColors.bold}${toBranch}${logColors.reset}.`,
-            );
-        } else {
-            await git.push(remoteName, pushString);
-        }
-
-        return {
-            deployCommits: {
-                deployedCommits: commitsAhead,
-                overwrittenCommits: commitsBehind,
-            },
-            branchStatus: {
-                before: beforeCommit,
-                after: afterCommit,
-            },
-        };
-    });
+
+            if (requiresForcePush) {
+                log.info(`\nOnly on ${logColors.bold}${toBranch}${logColors.reset}:`);
+                commitsBehind.forEach((commit, index) => {
+                    log.faint(
+                        `    ${index + 1}. ${commit.hash.slice(0, 7)} (${commit.author_name}) - ${commit.message}`,
+                    );
+                });
+            }
+
+            const shouldPush =
+                bypassConfirmation ||
+                (await confirm({
+                    message: requiresForcePush
+                        ? `\n${logColors.warning}Do you want to force push ${logColors.bold}${fromBranch}${logColors.normalWeight} to ${logColors.bold}${toBranch}${logColors.normalWeight}?\n\nThis will overwrite the commits only on ${logColors.bold}${toBranch}${logColors.normalWeight}.${logColors.reset}?`
+                        : 'Ready to deploy?',
+                    default: false,
+                }));
+
+            if (!shouldPush) {
+                throw new KnownError(`Deploy aborted.`);
+            }
+
+            if (requiresForcePush) {
+                await git.push(remoteName, pushString, ['--force']);
+                log.warning(
+                    `Force pushed ${logColors.bold}${fromBranch}${logColors.normalWeight} to ${logColors.bold}${toBranch}${logColors.reset}.`,
+                );
+            } else {
+                await git.push(remoteName, pushString);
+            }
+
+            return {
+                toBranchName: toBranch,
+                deployCommits: {
+                    deployedCommits: commitsAhead,
+                    overwrittenCommits: commitsBehind,
+                },
+                branchStatus: {
+                    before: beforeCommit,
+                    after: afterCommit,
+                },
+            };
+        },
+    );
 }

package/src/notifications/slack.ts

@@ -53,10 +53,10 @@ function chunkSectionLines(lines: ReadonlyArray<string>): string[][] {
  * @category Internal
  */
 export async function sendNotificationToSlack({
-    branchConfig,
     deployResult: {
         deployCommits: {deployedCommits, overwrittenCommits},
         branchStatus: {after, before},
+        toBranchName,
     },
     notification,
     repoConfig,
@@ -86,7 +86,7 @@ export async function sendNotificationToSlack({
             type: 'section',
             text: {
                 type: 'mrkdwn',
-                text: `*${setFirstLetterCasing(repoConfig.name, StringCase.Upper)} ${setFirstLetterCasing(branchConfig.deployName, StringCase.Upper)}* Pushed`,
+                text: `*${setFirstLetterCasing(repoConfig.name, StringCase.Upper)} ${setFirstLetterCasing(toBranchName, StringCase.Upper)}* Pushed`,
             },
         },
         {