feat: have 'generate:learning-goals' update the target file

Author: rvedotrc

courses/foundation/README.md

@@ -22,7 +22,9 @@ Total: 16 weeks
 
 ## Learning goals overview
 
-<!-- This summary can be automatically generated by running "npm run generate:learning-goals and pasted here -->
+<!-- To update this section, use "npm run generate:learning-goals Foundation" -->
+<!-- prettier-ignore-start -->
+<!-- BEGIN generate:learning-goals -->
 
 ### [HTML & CSS](/courses/foundation/html-and-css)
 
@@ -155,3 +157,6 @@ Total: 16 weeks
 - [ ] Managing your own tasks within a tight deadline
 - [ ] Understanding how and when to ask for help at the right time
 - [ ] Taking a project from idea to completion, including deploying it to the web
+
+<!-- END generate:learning-goals -->
+<!-- prettier-ignore-end -->

support/src/documentationHelpers/generateLearningGoals.ts

@@ -11,26 +11,28 @@
  *   npm run generate:learning-goals <course-name>
  */
 
-import { readFile, writeFile, stat } from "fs/promises";
+import { readFile, stat } from "fs/promises";
 import { join, dirname } from "path";
 import { fileURLToPath } from "url";
 import process from "process";
+import updateFileSection from "./updateFileSection.js";
 
 const scriptDir = dirname(fileURLToPath(import.meta.url));
 
-type ProgramStructure = {
-  readonly courses: readonly {
+type Course = {
+  readonly name: string;
+  readonly location: string;
+  readonly modules: readonly {
     readonly name: string;
     readonly location: string;
-    readonly modules: readonly {
-      readonly name: string;
-      readonly location: string;
-    }[];
   }[];
 };
 
+type ProgramStructure = {
+  readonly courses: readonly Course[];
+};
+
 const jsonPath = "programStructure.json";
-const outputLines: string[] = [];
 
 function extractLearningGoals(content: string): {
   readonly found: boolean;
@@ -51,16 +53,8 @@ function extractLearningGoals(content: string): {
   };
 }
 
-async function processCourse(courseName: string): Promise<void> {
-  const data = JSON.parse(
-    await readFile(jsonPath, "utf-8"),
-  ) as ProgramStructure;
-  const course = data.courses.find((c) => c.name === courseName);
-
-  if (!course) {
-    console.log("Course not found in json. Please provide a valid one.");
-    process.exit(1);
-  }
+async function processCourse(course: Course): Promise<string> {
+  const outputLines: string[] = [];
 
   for (const module of course.modules) {
     outputLines.push(`### [${module.name}](/${module.location})\n`);
@@ -111,7 +105,7 @@ async function processCourse(courseName: string): Promise<void> {
     outputLines.push("");
   }
 
-  console.log(outputLines.join("\n"));
+  return outputLines.join("\n");
 }
 
 const courseName = process.argv.slice(2)[0];
@@ -121,11 +115,30 @@ if (!courseName) {
   );
   process.exit(1);
 }
-console.log(
-  "Here's a summary of the learning goals for the course:",
-  courseName,
+
+const data = JSON.parse(await readFile(jsonPath, "utf-8")) as ProgramStructure;
+const course = data.courses.find((c) => c.name === courseName);
+
+if (!course) {
+  console.log(
+    "Course not found in json. Please provide one of:",
+    data.courses.map((c) => c.name).join(", "),
+  );
+  process.exit(1);
+}
+
+const markdown = await processCourse(course);
+
+const patt = /❌|⚠️/;
+const errorsAndWarnings = markdown.split(/\n/).filter((t) => patt.exec(t));
+if (errorsAndWarnings.length > 0) {
+  console.log(errorsAndWarnings.join("\n"));
+}
+
+await updateFileSection(
+  markdown,
+  `${course.location}/README.md`,
+  "generate:learning-goals",
 );
-console.log("You can copy and paste these into the course Readme.md :-)");
-console.log("---------------------------------------------------\n");
 
-processCourse(courseName);
+if (errorsAndWarnings.length > 0) process.exit(1);