@storm-software/git-tools 2.106.1 → 2.107.1

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-2.106.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-2.106.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/bin/git.ts

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  writeSuccess
+} from "@storm-software/config-tools";
+import { createProgram } from "../src/cli";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    const program = createProgram(config);
+    await program.parseAsync(process.argv);
+
+    writeSuccess(
+      `🎉  Git ${process.argv && process.argv.length >= 3 && process.argv[2] ? process.argv[2] : "tool"} processing completed successfully!`,
+      config
+    );
+    exitWithSuccess(config);
+  } catch (error) {
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/post-checkout.ts

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  run,
+  writeError,
+  writeFatal,
+  writeInfo,
+} from "@storm-software/config-tools";
+import { checkPackageVersion } from "../src/utilities/check-package-version";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running post-checkout hook...", config);
+    checkPackageVersion(process.argv?.slice(1));
+
+    try {
+      run(config, "git-lfs version");
+    } catch (error) {
+      writeError(
+        `This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/post-checkout.\nError: ${
+          (error as Error)?.message
+        }`,
+        config,
+      );
+      exitWithError(config);
+    }
+
+    run(config, "git lfs post-checkout");
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/post-commit.ts

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  run,
+  writeError,
+  writeFatal,
+  writeInfo,
+} from "@storm-software/config-tools";
+import { checkPackageVersion } from "../src/utilities/check-package-version";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running post-commit hook...", config);
+    checkPackageVersion(process.argv?.slice(1));
+
+    try {
+      run(config, "git-lfs version");
+    } catch (error) {
+      writeError(
+        `This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/post-commit.\nError: ${
+          (error as Error)?.message
+        }`,
+        config,
+      );
+      exitWithError(config);
+    }
+
+    run(config, "git lfs post-commit");
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/post-merge.ts

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  run,
+  writeError,
+  writeFatal,
+  writeInfo,
+} from "@storm-software/config-tools";
+import { checkPackageVersion } from "../src/utilities/check-package-version";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running post-merge hook...", config);
+    checkPackageVersion(process.argv?.slice(1));
+
+    try {
+      run(config, "git-lfs version");
+    } catch (error) {
+      writeError(
+        `This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/post-merge.\nError: ${
+          (error as Error)?.message
+        }`,
+        config,
+      );
+      exitWithError(config);
+    }
+
+    run(config, "git lfs post-merge");
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/pre-commit.ts

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  writeError,
+  writeFatal,
+  writeInfo,
+} from "@storm-software/config-tools";
+import {
+  checkPackageVersion,
+  isPackageVersionChanged,
+} from "../src/utilities/check-package-version";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running pre-commit hook...", config);
+
+    checkPackageVersion(process.argv.slice(1));
+    if (isPackageVersionChanged(process.argv?.slice(1))) {
+      writeError(
+        "Please regenerate the package lock file before committing...",
+        config,
+      );
+      exitWithError(config);
+    }
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/pre-install.ts

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  run,
+  writeFatal,
+  writeInfo,
+} from "@storm-software/config-tools";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running pre-install hook...", config);
+
+    if (Boolean(process.env.CI) || Boolean(process.env.STORM_CI)) {
+      writeInfo("Skipping pre-install for CI process...", config);
+      exitWithSuccess(config);
+    }
+
+    run(config, "npx -y only-allow pnpm");
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/pre-push.ts

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  run,
+  writeError,
+  writeFatal,
+  writeInfo,
+  writeSuccess,
+} from "@storm-software/config-tools";
+import fs from "node:fs";
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { checkPackageVersion } from "../src/utilities/check-package-version";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running pre-push hook...", config);
+    checkPackageVersion(process.argv?.slice(1));
+
+    writeInfo("🔒🔒🔒 Validating lock files 🔒🔒🔒\n", config);
+
+    const errors = [] as string[];
+
+    if (
+      fs.existsSync(
+        path.join(config.workspaceRoot ?? "./", "package-lock.json"),
+      )
+    ) {
+      errors.push(
+        'Invalid occurrence of "package-lock.json" file. Please remove it and use only "pnpm-lock.yaml"',
+      );
+    }
+    if (fs.existsSync(path.join(config.workspaceRoot ?? "./", "yarn.lock"))) {
+      errors.push(
+        'Invalid occurrence of "yarn.lock" file. Please remove it and use only "pnpm-lock.yaml"',
+      );
+    }
+
+    try {
+      const content = await readFile(
+        path.join(config.workspaceRoot ?? "./", "pnpm-lock.yaml"),
+        {
+          encoding: "utf8",
+        },
+      );
+      if (content.match(/localhost:487/)) {
+        errors.push(
+          'The "pnpm-lock.yaml" has reference to local repository ("localhost:4873"). Please use ensure you disable local registry before running "pnpm i"',
+        );
+      }
+      if (content.match(/resolution: \{tarball/)) {
+        errors.push(
+          'The "pnpm-lock.yaml" has reference to tarball package. Please use npm registry only',
+        );
+      }
+    } catch {
+      errors.push('The "pnpm-lock.yaml" does not exist or cannot be read');
+    }
+
+    if (errors.length > 0) {
+      writeError("❌ Lock file validation failed", config);
+      for (const error of errors) {
+        console.error(error);
+      }
+
+      exitWithError(config);
+    }
+
+    writeSuccess("Lock file is valid ✅", config);
+    run(config, "git lfs pre-push origin");
+
+    try {
+      run(config, "git-lfs version");
+    } catch (error) {
+      writeError(
+        `This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting .git/hooks/pre-push.\nError: ${
+          (error as Error)?.message
+        }`,
+        config,
+      );
+      exitWithError(config);
+    }
+
+    run(config, "git lfs pre-push origin");
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/prepare.ts

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  exitWithSuccess,
+  getConfig,
+  handleProcess,
+  run,
+  writeFatal,
+  writeInfo,
+} from "@storm-software/config-tools";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    writeInfo("Running prepare hook...", config);
+
+    if (!process.env.CI && !process.env.STORM_CI) {
+      run(config, "lefthook install");
+    }
+
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/bin/version-warning.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+import {
+  exitWithError,
+  getConfig,
+  handleProcess,
+  writeFatal,
+} from "@storm-software/config-tools";
+import { checkPackageVersion } from "../src/utilities/check-package-version";
+
+void (async () => {
+  const config = await getConfig();
+  try {
+    handleProcess(config);
+
+    checkPackageVersion(process.argv.slice(1));
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${error.message}`,
+      config,
+    );
+    exitWithError(config);
+    process.exit(1);
+  }
+})();