@storm-software/git-tools 2.125.5 → 2.126.0

package/bin/git.cjs

@@ -1999,14 +1999,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 +3924,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