@storm-software/git-tools 2.125.5 → 2.127.0

package/README.md

@@ -27,7 +27,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.124.86-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.125.5-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 -->
@@ -46,6 +46,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
 ## Table of Contents
 
 - [Storm Git Tools](#storm-git-tools)

package/bin/git.cjs

@@ -36,6 +36,7 @@ var util = require('util');
 var wrap = require('word-wrap');
 var Path = require('path');
 var projectGraph_js = require('nx/src/project-graph/project-graph.js');
+var prettier = require('prettier');
 var markdownToAst = require('@textlint/markdown-to-ast');
 var anchor = require('anchor-markdown-header');
 var htmlparser2 = require('htmlparser2');
@@ -50,7 +51,6 @@ var chalk = require('chalk');
 var printChanges = require('nx/src/command-line/release/utils/print-changes');
 var shared = require('nx/src/command-line/release/utils/shared');
 var utils = require('nx/src/tasks-runner/utils');
-var prettier = require('prettier');
 var execCommand_js = require('nx/src/command-line/release/utils/exec-command.js');
 var git = require('nx/src/command-line/release/utils/git');
 var semver = require('semver');
@@ -1300,11 +1300,11 @@ var formatCommitMessage = (state, workspaceConfig) => {
   const scope = workspaceConfig.variant !== "minimal" && typeof answers.scope === "string" && answers.scope ? answers.scope.trim() : "";
   const subject = answers.subject?.trim();
   const type = answers.type;
-  const format2 = config5.settings.format || (workspaceConfig.variant !== "minimal" ? "{type}({scope}): {emoji}{subject}" : "{type}: {emoji}{subject}");
+  const format3 = config5.settings.format || (workspaceConfig.variant !== "minimal" ? "{type}({scope}): {emoji}{subject}" : "{type}: {emoji}{subject}");
   const body = answers.body && typeof answers.body === "string" ? wrap__default.default(answers.body || "", wrapOptions) : "";
   const breaking = answers.breakingBody && typeof answers.breakingBody === "string" ? wrap__default.default(answers.breakingBody || "", wrapOptions) : "";
   const issues = answers.issuesBody && typeof answers.issuesBody === "string" ? wrap__default.default(answers.issuesBody || "", wrapOptions) : "";
-  const head = format2.replace(/\{emoji\}/g, config5.settings.disableEmoji ? "" : `${emoji} `).replace(/\{scope\}/g, scope).replace(/\{subject\}/g, subject || "").replace(/\{type\}/g, type || "");
+  const head = format3.replace(/\{emoji\}/g, config5.settings.disableEmoji ? "" : `${emoji} `).replace(/\{scope\}/g, scope).replace(/\{subject\}/g, subject || "").replace(/\{type\}/g, type || "");
   let msg = head;
   if (body) {
     msg += `
@@ -1617,45 +1617,53 @@ async function transformAndSave(files, mode = "github.com", maxHeaderLevel = 3,
       "--update-only flag is enabled. Only updating files that already have a TOC."
     );
   }
-  console.log("\n==================\n");
-  const transformed = files.map((x) => {
-    const result = transform(
-      fs$1.readFileSync(x.path, "utf8"),
-      mode,
-      maxHeaderLevel,
-      title,
-      noTitle,
-      entryPrefix,
-      processAll,
-      updateOnly
-    );
-    result.path = x.path;
-    return result;
-  });
-  const changed = transformed.filter((x) => x.transformed);
-  const unchanged = transformed.filter((x) => {
-    return !x.transformed;
-  });
-  for (const x of unchanged) {
-    console.log('"%s" is up to date', x.path);
-  }
-  for (const x of changed) {
-    console.log('"%s" will be updated', x.path);
-    fs$1.writeFileSync(x.path, x.data, "utf8");
-  }
+  return Promise.all(
+    files.map((x) => {
+      const result = transform(
+        fs$1.readFileSync(x.path, "utf8"),
+        mode,
+        maxHeaderLevel,
+        title,
+        noTitle,
+        entryPrefix,
+        processAll,
+        updateOnly
+      );
+      result.path = x.path;
+      return result;
+    }).filter((file) => file.transformed).map(async (file) => {
+      console.log('Writting changes to "%s"', file.path);
+      const prettierConfig = await prettier.resolveConfig(file.path, {
+        useCache: true,
+        editorconfig: true
+      });
+      return fs.writeFile(
+        file.path,
+        await prettier.format(
+          file.data,
+          prettierConfig ? { ...prettierConfig, parser: "markdown" } : { parser: "markdown" }
+        ),
+        "utf8"
+      );
+    })
+  );
 }
 var doctoc = (directory, mode = "github.com", maxHeaderLevel = 3, title = "## Table of Contents", noTitle = false, entryPrefix = void 0, processAll = false, updateOnly = false) => {
   let files = [];
   const stat = fs$1.statSync(directory);
   if (stat.isDirectory()) {
     console.log(
-      '\nDocToccing "%s" and its sub directories for %s.',
+      '\nCreating Table of Contents for "%s" and its sub directories for %s.',
       directory,
       mode
     );
     files = findMarkdownFiles(directory);
   } else {
-    console.log('\nDocToccing single file "%s" for %s.', directory, mode);
+    console.log(
+      '\nCreating Table of Contents for single file "%s" for %s.',
+      directory,
+      mode
+    );
     files = [{ path: directory }];
   }
   transformAndSave(
@@ -1668,7 +1676,10 @@ var doctoc = (directory, mode = "github.com", maxHeaderLevel = 3, title = "## Ta
     processAll,
     updateOnly
   );
-  console.log("\nEverything is OK.");
+  console.log(
+    "\nCompleted generating Table of Contents for %s file(s).",
+    files.length
+  );
 };
 var markdownExts = [".md", ".markdown"];
 var ignoredDirs = [".", "..", ".git", "node_modules"];
@@ -1999,14 +2010,38 @@ var runReadme = async ({
   project,
   output: output3,
   clean = true,
-  prettier = true
+  prettier = true,
+  workspace = false
 }) => {
   const projectGraph = await projectGraph_js.createProjectGraphAsync({
     exitOnError: true
   });
   const projectConfigs = projectGraph_js.readProjectsConfigurationFromProjectGraph(projectGraph);
-  if (project) {
-    await runProjectReadme(project, {
+  const workspaceRoot = chunkDFXXNV3C_cjs.findWorkspaceRootSafe(process.cwd());
+  if (!workspaceRoot) {
+    throw new Error(
+      "Unable to find the workspace root. Please ensure you are running this command from within a workspace."
+    );
+  }
+  let resolvedProject = project;
+  if (workspace) {
+    if (!fs$1.existsSync(Path.join(workspaceRoot, "project.json"))) {
+      throw new Error(
+        `The \`workspace\` flag was provided to the \`storm-git readme\` command-line interface, but a project.json file could not be found at the workspace root (${workspaceRoot}). Please ensure you are running this command from the root of your workspace.`
+      );
+    }
+    const projectJson = JSON.parse(
+      fs$1.readFileSync(Path.join(workspaceRoot, "project.json"), "utf8") ?? "{}"
+    );
+    if (!projectJson?.name) {
+      throw new Error(
+        `The \`workspace\` flag was provided to the \`storm-git readme\` command-line interface, but a name field could not be found in the project.json file at the workspace root (${workspaceRoot}). Please ensure the project.json file at the workspace root contains a name field.`
+      );
+    }
+    resolvedProject = projectJson.name;
+  }
+  if (resolvedProject) {
+    await runProjectReadme(resolvedProject, {
       templates,
       output: output3,
       clean,
@@ -3900,8 +3935,8 @@ function createProgram(config5) {
     "./tools/readme-templates"
   ).option(
     "--project <project>",
-    "The specific project to generate a README.md file for"
-  ).option("--output <path>", "Where to output the generated README.md file").option(
+    "The specific project to generate a README.md file for. Defaults to the workspace root README.md if not provided."
+  ).option("--workspace", "Run for the workspace root's README.md file").option("--output <path>", "Where to output the generated README.md file").option(
     "--clean",
     "Should the output README.md file be cleaned before generation",
     true