deploy-vir 2.1.1 → 3.0.1

package/dist/cli/cli.js

@@ -1,11 +1,10 @@
 import { assertWrap } from '@augment-vir/assert';
-import { awaitedForEach, extractErrorMessage, log } from '@augment-vir/common';
+import { extractErrorMessage, log } from '@augment-vir/common';
 import { select } from '@inquirer/prompts';
 import { resolve } from 'node:path';
 import { simpleGit } from 'simple-git';
 import { getGitRemoteName, pushDeploy } from '../git.js';
 import { KnownError } from '../known.error.js';
-import { sendNotifications } from '../notifications/send-notifications.js';
 /**
  * Run the deploy-vir CLI.
  *
@@ -49,17 +48,7 @@ export async function runDeployVir(args, config) {
         const branchConfig = assertWrap.isDefined(repoConfig.deploys.find((deploy) => deploy.deployName === args.deployName, `Failed to find a deploy named '${args.deployName}' in repo '${args.repoName}'.`));
         const remoteName = await getGitRemoteName(git, repoConfig);
         log.faint(`Remote: ${remoteName}`);
-        const deployResults = await pushDeploy(git, branchConfig, remoteName, args.bypassConfirmation);
-        const notifications = config.notifications;
-        if (notifications?.length) {
-            await awaitedForEach(deployResults, async (deployResult) => {
-                await sendNotifications(notifications, {
-                    branchConfig,
-                    deployResult,
-                    repoConfig,
-                });
-            });
-        }
+        await pushDeploy(git, branchConfig, repoConfig, remoteName, config.notifications, args.bypassConfirmation);
     }
     catch (error) {
         if (error instanceof KnownError) {

package/dist/config.d.ts

@@ -82,6 +82,7 @@ export type DeployVirRepoConfig = {
      */
     commitBaseUrl?: string | undefined;
     deploys: DeployVirBranchConfig[];
+    enableNotifications?: boolean | undefined;
 };
 /**
  * A deploy configuration.
@@ -93,7 +94,9 @@ export type DeployVirBranchConfig = {
     branches: {
         fromBranch: string;
         toBranch: string;
+        enableNotifications?: boolean | undefined;
     }[];
+    enableNotifications?: boolean | undefined;
 };
 /**
  * Define a type safe deploy-vir config.

package/dist/git.d.ts

@@ -1,5 +1,5 @@
 import { type DefaultLogFields, type ListLogLine, type SimpleGit } from 'simple-git';
-import { type DeployVirBranchConfig, type DeployVirRepoConfig } from './config.js';
+import { type DeployVirBranchConfig, type DeployVirRepoConfig, type NotificationConfig } from './config.js';
 /**
  * Find the git remote's name, or create a new one.
  *
@@ -45,4 +45,4 @@ export type DeployResult = {
  *
  * @category Internal
  */
-export declare function pushDeploy(git: Readonly<SimpleGit>, { deployName, branches }: Readonly<DeployVirBranchConfig>, remoteName: string, bypassConfirmation?: boolean): Promise<DeployResult[]>;
+export declare function pushDeploy(git: Readonly<SimpleGit>, branchConfig: Readonly<DeployVirBranchConfig>, repoConfig: Readonly<DeployVirRepoConfig>, remoteName: string, notifications: ReadonlyArray<Readonly<NotificationConfig>> | undefined, bypassConfirmation?: boolean): Promise<DeployResult[]>;

package/dist/git.js

@@ -2,6 +2,7 @@ import { assert, assertWrap, check } from '@augment-vir/assert';
 import { awaitedBlockingMap, log, logColors } from '@augment-vir/common';
 import { confirm } from '@inquirer/prompts';
 import { KnownError } from './known.error.js';
+import { sendNotifications } from './notifications/send-notifications.js';
 /**
  * Find the git remote's name, or create a new one.
  *
@@ -30,8 +31,9 @@ export async function getGitRemoteName(git, repoConfig) {
  *
  * @category Internal
  */
-export async function pushDeploy(git, { deployName, branches }, remoteName, bypassConfirmation = false) {
-    return await awaitedBlockingMap(branches, async ({ fromBranch, toBranch }) => {
+export async function pushDeploy(git, branchConfig, repoConfig, remoteName, notifications, bypassConfirmation = false) {
+    const { deployName, branches } = branchConfig;
+    return await awaitedBlockingMap(branches, async ({ fromBranch, toBranch, enableNotifications }) => {
         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.');
@@ -87,7 +89,7 @@ export async function pushDeploy(git, { deployName, branches }, remoteName, bypa
         else {
             await git.push(remoteName, pushString);
         }
-        return {
+        const deployResult = {
             toBranchName: toBranch,
             deployCommits: {
                 deployedCommits: commitsAhead,
@@ -98,5 +100,16 @@ export async function pushDeploy(git, { deployName, branches }, remoteName, bypa
                 after: afterCommit,
             },
         };
+        if (notifications?.length &&
+            (repoConfig.enableNotifications ||
+                enableNotifications ||
+                branchConfig.enableNotifications)) {
+            await sendNotifications(notifications, {
+                branchConfig,
+                deployResult,
+                repoConfig,
+            });
+        }
+        return deployResult;
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-vir",
-    "version": "2.1.1",
+    "version": "3.0.1",
     "description": "Deploy a branch to another branch with notifications.",
     "keywords": [
         "deploy",
@@ -41,51 +41,51 @@
         "test:update": "npm run test update"
     },
     "dependencies": {
-        "@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",
+        "@augment-vir/assert": "^31.61.0",
+        "@augment-vir/common": "^31.61.0",
+        "@augment-vir/node": "^31.61.0",
+        "@inquirer/prompts": "^8.2.1",
+        "@slack/web-api": "^7.14.1",
         "cli-vir": "^1.0.3",
-        "simple-git": "^3.30.0",
+        "simple-git": "^3.31.1",
         "tsx": "^4.21.0",
         "url-vir": "^2.1.7"
     },
     "devDependencies": {
         "@eslint/eslintrc": "^3.3.3",
         "@eslint/js": "^9.39.2",
-        "@stylistic/eslint-plugin": "^5.6.1",
+        "@stylistic/eslint-plugin": "^5.8.0",
         "@stylistic/eslint-plugin-ts": "^4.4.1",
-        "@types/node": "^25.0.3",
-        "@typescript-eslint/eslint-plugin": "^8.52.0",
-        "cspell": "^9.4.0",
-        "dependency-cruiser": "^17.3.6",
-        "esbuild": "^0.27.2",
+        "@types/node": "^25.2.3",
+        "@typescript-eslint/eslint-plugin": "^8.56.0",
+        "cspell": "^9.6.4",
+        "dependency-cruiser": "^17.3.8",
+        "esbuild": "^0.27.3",
         "eslint": "^9.39.2",
         "eslint-config-prettier": "^10.1.8",
-        "eslint-plugin-jsdoc": "^61.5.0",
+        "eslint-plugin-jsdoc": "^62.5.0",
         "eslint-plugin-monorepo-cop": "^1.0.2",
-        "eslint-plugin-playwright": "^2.4.0",
-        "eslint-plugin-prettier": "^5.5.4",
+        "eslint-plugin-playwright": "^2.5.1",
+        "eslint-plugin-prettier": "^5.5.5",
         "eslint-plugin-require-extensions": "^0.1.3",
-        "eslint-plugin-sonarjs": "^3.0.5",
-        "eslint-plugin-unicorn": "^62.0.0",
+        "eslint-plugin-sonarjs": "^3.0.6",
+        "eslint-plugin-unicorn": "^63.0.0",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "npm-check-updates": "^19.3.1",
+        "npm-check-updates": "^19.3.2",
         "prettier": "~3.3.3",
         "prettier-plugin-interpolated-html-tags": "^2.0.1",
         "prettier-plugin-jsdoc": "^1.8.0",
-        "prettier-plugin-multiline-arrays": "^4.1.3",
+        "prettier-plugin-multiline-arrays": "^4.1.4",
         "prettier-plugin-organize-imports": "^4.3.0",
-        "prettier-plugin-packagejson": "^2.5.20",
-        "prettier-plugin-sort-json": "^4.1.1",
+        "prettier-plugin-packagejson": "^3.0.0",
+        "prettier-plugin-sort-json": "^4.2.0",
         "prettier-plugin-toml": "^2.0.6",
         "runstorm": "^1.0.0",
-        "typedoc": "^0.28.15",
+        "typedoc": "^0.28.17",
         "typescript": "^5.9.3",
-        "typescript-eslint": "^8.52.0",
-        "virmator": "^14.4.2"
+        "typescript-eslint": "^8.56.0",
+        "virmator": "^14.5.2"
     },
     "engines": {
         "node": ">=22"

package/src/cli/cli.ts

@@ -1,12 +1,11 @@
 import {assertWrap} from '@augment-vir/assert';
-import {awaitedForEach, extractErrorMessage, log} from '@augment-vir/common';
+import {extractErrorMessage, log} from '@augment-vir/common';
 import {select} from '@inquirer/prompts';
 import {resolve} from 'node:path';
 import {simpleGit} from 'simple-git';
 import {type DeployVirConfig} from '../config.js';
 import {getGitRemoteName, pushDeploy} from '../git.js';
 import {KnownError} from '../known.error.js';
-import {sendNotifications} from '../notifications/send-notifications.js';
 
 /**
  * Run the deploy-vir CLI.
@@ -106,24 +105,14 @@ export async function runDeployVir(
         const remoteName = await getGitRemoteName(git, repoConfig);
         log.faint(`Remote: ${remoteName}`);
 
-        const deployResults = await pushDeploy(
+        await pushDeploy(
             git,
             branchConfig,
+            repoConfig,
             remoteName,
+            config.notifications,
             args.bypassConfirmation,
         );
-
-        const notifications = config.notifications;
-
-        if (notifications?.length) {
-            await awaitedForEach(deployResults, async (deployResult) => {
-                await sendNotifications(notifications, {
-                    branchConfig,
-                    deployResult,
-                    repoConfig,
-                });
-            });
-        }
     } catch (error) {
         if (error instanceof KnownError) {
             /** If its a known error, don't log the whole stack trace. */

package/src/config.ts

@@ -87,6 +87,7 @@ export type DeployVirRepoConfig = {
      */
     commitBaseUrl?: string | undefined;
     deploys: DeployVirBranchConfig[];
+    enableNotifications?: boolean | undefined;
 };
 
 /**
@@ -99,7 +100,9 @@ export type DeployVirBranchConfig = {
     branches: {
         fromBranch: string;
         toBranch: string;
+        enableNotifications?: boolean | undefined;
     }[];
+    enableNotifications?: boolean | undefined;
 };
 
 /**

package/src/git.ts

@@ -2,8 +2,13 @@ import {assert, assertWrap, check} from '@augment-vir/assert';
 import {awaitedBlockingMap, log, logColors} from '@augment-vir/common';
 import {confirm} from '@inquirer/prompts';
 import {type DefaultLogFields, type ListLogLine, type SimpleGit} from 'simple-git';
-import {type DeployVirBranchConfig, type DeployVirRepoConfig} from './config.js';
+import {
+    type DeployVirBranchConfig,
+    type DeployVirRepoConfig,
+    type NotificationConfig,
+} from './config.js';
 import {KnownError} from './known.error.js';
+import {sendNotifications} from './notifications/send-notifications.js';
 
 /**
  * Find the git remote's name, or create a new one.
@@ -89,13 +94,16 @@ export type DeployResult = {
  */
 export async function pushDeploy(
     git: Readonly<SimpleGit>,
-    {deployName, branches}: Readonly<DeployVirBranchConfig>,
+    branchConfig: Readonly<DeployVirBranchConfig>,
+    repoConfig: Readonly<DeployVirRepoConfig>,
     remoteName: string,
+    notifications: ReadonlyArray<Readonly<NotificationConfig>> | undefined,
     bypassConfirmation = false,
 ): Promise<DeployResult[]> {
+    const {deployName, branches} = branchConfig;
     return await awaitedBlockingMap(
         branches,
-        async ({fromBranch, toBranch}): Promise<DeployResult> => {
+        async ({fromBranch, toBranch, enableNotifications}): 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.');
@@ -188,7 +196,7 @@ export async function pushDeploy(
                 await git.push(remoteName, pushString);
             }
 
-            return {
+            const deployResult: DeployResult = {
                 toBranchName: toBranch,
                 deployCommits: {
                     deployedCommits: commitsAhead,
@@ -199,6 +207,21 @@ export async function pushDeploy(
                     after: afterCommit,
                 },
             };
+
+            if (
+                notifications?.length &&
+                (repoConfig.enableNotifications ||
+                    enableNotifications ||
+                    branchConfig.enableNotifications)
+            ) {
+                await sendNotifications(notifications, {
+                    branchConfig,
+                    deployResult,
+                    repoConfig,
+                });
+            }
+
+            return deployResult;
         },
     );
 }