proschi 0.7.0 → 0.8.0

package/README.md

@@ -1,7 +1,7 @@
 # proschi
 
 Command-line checker and language server for
-[Proschi](https://gvart.github.io/proschi/), a small text language for
+[Proschi](https://proschi.app/), a small text language for
 microservice architectures and the request flows that run through them.
 
 ```sh

package/dist/cli.cjs

@@ -2237,8 +2237,8 @@ var require_resolve = __commonJS({
       }
       return count;
     }
-    function getFullPath(resolver, id = "", normalize) {
-      if (normalize !== false)
+    function getFullPath(resolver, id = "", normalize2) {
+      if (normalize2 !== false)
         id = normalizeId(id);
       const p = resolver.parse(id);
       return _getFullPath(resolver, p);
@@ -3833,7 +3833,7 @@ var require_fast_uri = __commonJS({
       }
       return decodedScheme;
     }
-    function normalize(uri, options) {
+    function normalize2(uri, options) {
       if (typeof uri === "string") {
         uri = /** @type {T} */
         normalizeString(uri, options);
@@ -4211,7 +4211,7 @@ var require_fast_uri = __commonJS({
     }
     var fastUri = {
       SCHEMES,
-      normalize,
+      normalize: normalize2,
       resolve: resolve4,
       resolveComponent,
       equal,
@@ -19285,9 +19285,12 @@ var PROBLEM_MD = "problem.md";
 var GIVEN = "given.proschi";
 var STARTER = "starter.proschi";
 var SOLUTION = "solution.proschi";
+var LESSON_MD = "lesson.md";
 var WRONG_DIR = "wrong";
 var REQUIRED = [PROBLEM_MD, GIVEN, STARTER, SOLUTION];
+var OPTIONAL = [LESSON_MD];
 var ID = /^[a-z0-9]+(-[a-z0-9]+)*$/;
+var RESERVED_IDS = ["problem", "roadmap", "approach"];
 var EXPECT_FAIL = /^#\s*expect-fail:\s*(.*?)\s*$/;
 var ProblemFolderError = class extends Error {
   folder;
@@ -19313,7 +19316,7 @@ function expectFailLines(source2) {
   }
   return names;
 }
-var FIELDS = ["title", "summary", "difficulty", "tags", "order", "hints"];
+var FIELDS = ["title", "summary", "difficulty", "tags", "company", "order", "hints", "version"];
 function readProblemMd(id, text) {
   const fail2 = (message, line) => {
     throw new ProblemFolderError(id, message, PROBLEM_MD, line);
@@ -19339,17 +19342,22 @@ function readProblemMd(id, text) {
   };
   const difficulty = str("difficulty");
   if (!DIFFICULTIES.includes(difficulty)) fail2(`'difficulty' must be one of ${DIFFICULTIES.join(", ")}`);
+  const company = data.company === void 0 ? void 0 : str("company");
   const order = data.order;
   if (order !== void 0 && typeof order !== "number") fail2("'order' must be a number");
+  const version = data.version;
+  if (version !== void 0 && !(typeof version === "number" && Number.isInteger(version) && version >= 1)) fail2("'version' must be a whole number from 1");
   if (body === "") fail2("The statement (the Markdown after the front matter) is empty");
   return {
     title: str("title"),
     summary: str("summary"),
     difficulty,
     tags: list("tags"),
+    ...company !== void 0 ? { company } : {},
     ...typeof order === "number" ? { order } : {},
     statement: body,
-    hints: list("hints")
+    hints: list("hints"),
+    ...typeof version === "number" ? { version } : {}
   };
 }
 function problemFromFiles(id, files) {
@@ -19357,11 +19365,12 @@ function problemFromFiles(id, files) {
     throw new ProblemFolderError(id, message);
   };
   if (!ID.test(id)) fail2('The folder name is the problem id and must be lowercase words joined by "-", e.g. url-shortener');
+  if (RESERVED_IDS.includes(id)) fail2(`"${id}" is taken by a practice page; reserved ids: ${RESERVED_IDS.join(", ")}`);
   for (const name of REQUIRED) if (files[name] === void 0) fail2(`Missing ${name}`);
   for (const name of Object.keys(files)) {
     const wrong2 = name.startsWith(`${WRONG_DIR}/`) ? name.slice(WRONG_DIR.length + 1) : void 0;
-    if (!REQUIRED.includes(name) && !(wrong2 && /^[a-z0-9][a-z0-9-]*\.proschi$/.test(wrong2))) {
-      fail2(`Unexpected file ${name}: a problem folder holds ${REQUIRED.join(", ")} and ${WRONG_DIR}/<name>.proschi (lowercase, digits and "-")`);
+    if (!REQUIRED.includes(name) && !OPTIONAL.includes(name) && !(wrong2 && /^[a-z0-9][a-z0-9-]*\.proschi$/.test(wrong2))) {
+      fail2(`Unexpected file ${name}: a problem folder holds ${REQUIRED.join(", ")}, optionally ${OPTIONAL.join(", ")}, and ${WRONG_DIR}/<name>.proschi (lowercase, digits and "-")`);
     }
   }
   const meta = readProblemMd(id, files[PROBLEM_MD]);
@@ -19372,10 +19381,63 @@ function problemFromFiles(id, files) {
     given: files[GIVEN],
     starter: files[STARTER],
     solution: files[SOLUTION],
+    ...files[LESSON_MD] !== void 0 ? { lesson: files[LESSON_MD] } : {},
     ...wrong.length ? { wrong } : {}
   };
 }
 
+// ../frontend/src/practice/lesson.ts
+var LESSON_HEADINGS = [
+  "What you'll learn",
+  "The problem, explained",
+  "Back-of-the-envelope",
+  "Concepts",
+  "Designing it step by step",
+  "Common mistakes",
+  "In the interview",
+  "Further reading"
+];
+var normalize = (heading) => heading.replace(/[‘’]/g, "'").trim();
+function proseLines(source2) {
+  const out = [];
+  let fence = false;
+  source2.replace(/\r\n?/g, "\n").split("\n").forEach((text, i) => {
+    if (/^\s*```/.test(text)) fence = !fence;
+    else if (!fence) out.push({ text, line: i + 1 });
+  });
+  return out;
+}
+function h2Headings(source2) {
+  return proseLines(source2).map(({ text, line }) => ({ m: /^##\s+(.*?)\s*#*\s*$/.exec(text), line })).filter((h) => h.m !== null).map(({ m, line }) => ({ text: m[1], line }));
+}
+function lessonIssues(source2) {
+  const issues = [];
+  if (!source2.trim()) return [{ message: "The lesson is empty" }];
+  const headings = h2Headings(source2);
+  let last = -1;
+  let lastName = "";
+  for (const required of LESSON_HEADINGS) {
+    const found = headings.find((h) => normalize(h.text) === required);
+    if (!found) {
+      issues.push({ message: `The lesson needs a "## ${required}" section (the sections are: ${LESSON_HEADINGS.join(", ")})` });
+      continue;
+    }
+    const index = headings.indexOf(found);
+    if (index < last) issues.push({ message: `"## ${required}" must come after "## ${lastName}"`, line: found.line });
+    else {
+      last = index;
+      lastName = required;
+    }
+  }
+  for (const { text, line } of proseLines(source2)) {
+    const prose = text.replace(/`[^`]*`/g, "");
+    for (const m of prose.matchAll(/\]\(([^)\s]*)[^)]*\)/g)) {
+      if (!/^https?:\/\/\S+$/i.test(m[1])) issues.push({ message: `Links in a lesson must go to an http(s) address, not "${m[1]}"`, line });
+    }
+  }
+  return issues;
+}
+
 // ../frontend/src/dsl/imports.ts
 function joinImportPath(fromPath, importPath) {
   const parts = importPath.startsWith("/") || !fromPath ? [] : fromPath.split("/").slice(0, -1);
@@ -19470,6 +19532,7 @@ function validateProblem(problem, engine = defaultEngine) {
     if (!problem.statement.includes(`**${name}**`)) add(PROBLEM_MD, `The statement must name the use case **${name}** in bold`);
     if (!problem.solution.includes(`usecase "${name}"`)) add(SOLUTION, `The solution must define usecase "${name}" from the traffic`);
   }
+  if (problem.lesson !== void 0) for (const issue of lessonIssues(problem.lesson)) add(LESSON_MD, issue.message, issue.line);
   const importLine = problem.given.split("\n").findIndex((l) => /^\s*import /.test(l));
   if (importLine >= 0) add(GIVEN, "The given must not import anything", importLine + 1);
   report(GIVEN, parse(problem.given).diagnostics.filter((d) => d.severity === "error"));
@@ -19845,7 +19908,7 @@ ${PROBLEM_USAGE}`);
 }
 
 // src/cli.ts
-var VERSION2 = true ? "0.7.0" : "dev";
+var VERSION2 = true ? "0.8.0" : "dev";
 var USAGE = `Usage:
   proschi check [--strict] [--format text|github|json] [--openapi <node>=<spec>]... <file|dir>...
   proschi parse <file>