@storm-software/git-tools 2.125.5 → 2.127.0

package/bin/git.js

@@ -26,16 +26,17 @@ import chalkTemplate from 'chalk-template';
 import fs, { readFile as readFile$1, writeFile } from 'node:fs/promises';
 import createBasePreset from 'conventional-changelog-conventionalcommits';
 import { readCachedProjectGraph, createProjectGraphAsync as createProjectGraphAsync$1, readProjectsConfigurationFromProjectGraph as readProjectsConfigurationFromProjectGraph$1 } from 'nx/src/project-graph/project-graph';
-import { existsSync } from 'fs';
+import { existsSync as existsSync$1 } from 'fs';
 import { readFile } from 'fs/promises';
 import childProcess, { execSync } from 'node:child_process';
 import defaultRules from '@commitlint/rules';
 import 'stream';
 import util from 'node:util';
-import { existsSync as existsSync$1, rmSync, readdirSync, readFileSync, writeFileSync, statSync, promises } from 'node:fs';
+import { existsSync, readFileSync, rmSync, readdirSync, writeFileSync, statSync, promises } from 'node:fs';
 import wrap from 'word-wrap';
 import Path, { join as join$1, extname } from 'node:path';
 import { createProjectGraphAsync, readProjectsConfigurationFromProjectGraph } from 'nx/src/project-graph/project-graph.js';
+import { resolveConfig, format } from 'prettier';
 import { parse as parse$1, Syntax } from '@textlint/markdown-to-ast';
 import anchor from 'anchor-markdown-header';
 import { Parser } from 'htmlparser2';
@@ -50,7 +51,6 @@ import chalk from 'chalk';
 import { printAndFlushChanges } from 'nx/src/command-line/release/utils/print-changes';
 import { createGitTagValues, handleDuplicateGitTags, createCommitMessageValues, isPrerelease, shouldPreferDockerVersionForReleaseGroup, ReleaseVersion, noDiffInChangelogMessage } from 'nx/src/command-line/release/utils/shared';
 import { interpolate } from 'nx/src/tasks-runner/utils';
-import { resolveConfig, format } from 'prettier';
 import { execCommand } from 'nx/src/command-line/release/utils/exec-command.js';
 import { getCommitHash, getLatestGitTagForPattern, getFirstGitCommit, gitPush, getGitDiff, parseCommits, gitAdd } from 'nx/src/command-line/release/utils/git';
 import { prerelease, major } from 'semver';
@@ -979,7 +979,7 @@ async function runCommitLint(workspaceConfig, options) {
       workspaceConfig.workspaceRoot,
       options.file || options.message || COMMIT_EDITMSG_PATH
     );
-    if (existsSync(commitFile)) {
+    if (existsSync$1(commitFile)) {
       commitMessage = (await readFile(commitFile, "utf8"))?.trim();
     }
   }
@@ -1233,7 +1233,7 @@ async function createState(workspaceConfig, configPath) {
         if (project) {
           let description = `${project.name} - ${project.root}`;
           const packageJsonPath = joinPaths(project.root, "package.json");
-          if (existsSync$1(packageJsonPath)) {
+          if (existsSync(packageJsonPath)) {
             const packageJsonFile = await readFile$1(packageJsonPath, "utf8");
             const packageJson = JSON.parse(packageJsonFile);
             description = packageJson.description || description;
@@ -1278,11 +1278,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(answers.body || "", wrapOptions) : "";
   const breaking = answers.breakingBody && typeof answers.breakingBody === "string" ? wrap(answers.breakingBody || "", wrapOptions) : "";
   const issues = answers.issuesBody && typeof answers.issuesBody === "string" ? wrap(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 += `
@@ -1595,45 +1595,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(
-      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);
-    writeFileSync(x.path, x.data, "utf8");
-  }
+  return Promise.all(
+    files.map((x) => {
+      const result = transform(
+        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 resolveConfig(file.path, {
+        useCache: true,
+        editorconfig: true
+      });
+      return writeFile(
+        file.path,
+        await 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 = 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(
@@ -1646,7 +1654,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"];
@@ -1707,7 +1718,7 @@ var getExecutorMarkdown = (_packageName, executorsJsonFile, executorsJson) => {
         findFilePath(executorsJsonFile),
         executor.schema
       );
-      if (existsSync$1(schemaJsonPath)) {
+      if (existsSync(schemaJsonPath)) {
         const schemaJson = JSON.parse(
           readFileSync(schemaJsonPath, "utf8") ?? "{}"
         );
@@ -1805,7 +1816,7 @@ var getGeneratorMarkdown = (packageName, generatorsJsonFile, generatorsJson) =>
         findFilePath(generatorsJsonFile),
         generator.schema
       );
-      if (existsSync$1(schemaJsonPath)) {
+      if (existsSync(schemaJsonPath)) {
         const schemaJson = JSON.parse(
           readFileSync(schemaJsonPath, "utf8") ?? "{}"
         );
@@ -1977,14 +1988,38 @@ var runReadme = async ({
   project,
   output: output3,
   clean = true,
-  prettier = true
+  prettier = true,
+  workspace = false
 }) => {
   const projectGraph = await createProjectGraphAsync({
     exitOnError: true
   });
   const projectConfigs = readProjectsConfigurationFromProjectGraph(projectGraph);
-  if (project) {
-    await runProjectReadme(project, {
+  const workspaceRoot = 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 (!existsSync(join$1(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(
+      readFileSync(join$1(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,
@@ -2008,10 +2043,10 @@ var runProjectReadme = async (projectName, { templates, output: output3, clean =
   const projectConfigs = readProjectsConfigurationFromProjectGraph(projectGraph);
   const project = projectConfigs.projects[projectName];
   const inputFile = join$1(project?.root ?? "./", "README.md");
-  if (existsSync$1(inputFile)) {
+  if (existsSync(inputFile)) {
     console.info(`Formatting ${projectName}'s README file at "${inputFile}"`);
     const outputFilePath = output3 ? output3.includes("README.md") ? output3 : join$1(findFilePath(output3), "README.md") : inputFile;
-    if (clean && existsSync$1(outputFilePath)) {
+    if (clean && existsSync(outputFilePath)) {
       if (outputFilePath === inputFile) {
         console.warn(
           "Skipping cleaning since output directory + file name is the same as input directory + file name."
@@ -2035,7 +2070,7 @@ var runProjectReadme = async (projectName, { templates, output: output3, clean =
     );
     let packageName = projectName;
     const packageJsonPath = join$1(findFilePath(inputFile), "package.json");
-    if (existsSync$1(packageJsonPath)) {
+    if (existsSync(packageJsonPath)) {
       const packageJson = JSON.parse(
         readFileSync(packageJsonPath, "utf8") ?? "{}"
       );
@@ -2052,7 +2087,7 @@ var runProjectReadme = async (projectName, { templates, output: output3, clean =
     }
     if (newContent.includes("<!-- START executors -->")) {
       const executorsJsonPath = join$1(findFilePath(inputFile), "executors.json");
-      if (existsSync$1(executorsJsonPath)) {
+      if (existsSync(executorsJsonPath)) {
         const executorsJson = JSON.parse(
           readFileSync(executorsJsonPath, "utf8") ?? "{}"
         );
@@ -2071,7 +2106,7 @@ var runProjectReadme = async (projectName, { templates, output: output3, clean =
         findFilePath(inputFile),
         "generators.json"
       );
-      if (existsSync$1(generatorsJsonPath)) {
+      if (existsSync(generatorsJsonPath)) {
         const generatorsJson = JSON.parse(
           readFileSync(generatorsJsonPath, "utf8") ?? "{}"
         );
@@ -2563,7 +2598,7 @@ async function generateChangelogForProjects({
         "CHANGELOG.md"
       );
       let currentContent;
-      if (existsSync$1(filePath)) {
+      if (existsSync(filePath)) {
         currentContent = await readFile$1(filePath, "utf8");
       }
       writeDebug(
@@ -2900,7 +2935,7 @@ async function resolveTokenData(hostname) {
     "gh",
     "hosts.yml"
   );
-  if (existsSync$1(ghCLIPath)) {
+  if (existsSync(ghCLIPath)) {
     const yamlContents = await promises.readFile(ghCLIPath, "utf8");
     const ghCLIConfig = parse(yamlContents);
     if (ghCLIConfig[hostname]) {
@@ -3343,7 +3378,7 @@ var StormReleaseClient = class _StormReleaseClient extends ReleaseClient {
    */
   constructor(projectGraph, releaseConfig, ignoreNxJsonConfig, workspaceConfig) {
     let nxJson;
-    if (!ignoreNxJsonConfig && existsSync$1(joinPaths(workspaceConfig.workspaceRoot, "nx.json"))) {
+    if (!ignoreNxJsonConfig && existsSync(joinPaths(workspaceConfig.workspaceRoot, "nx.json"))) {
       nxJson = readNxJson();
     }
     const config5 = defu(
@@ -3834,12 +3869,12 @@ async function updatePackageManifests(projectsVersionData, config5) {
           );
           const packageJsonPath = joinPaths(projectRoot, "package.json");
           const cargoTomlPath = joinPaths(projectRoot, "Cargo.toml");
-          if (existsSync$1(packageJsonPath)) {
+          if (existsSync(packageJsonPath)) {
             const packageJsonContent = await readFile$1(packageJsonPath, "utf8");
             const packageJson = JSON.parse(packageJsonContent);
             packageJson.version = versionData.newVersion;
             await writeFile(packageJsonPath, JSON.stringify(packageJson));
-          } else if (existsSync$1(cargoTomlPath)) {
+          } else if (existsSync(cargoTomlPath)) {
             const cargoToml = parseCargoToml(
               await readFile$1(cargoTomlPath, "utf8")
             );
@@ -3878,8 +3913,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