@learnpack/learnpack 5.0.335 → 5.0.340

package/lib/managers/config/exercise.js

@@ -6,6 +6,7 @@ const p = require("path");
 const fs = require("fs");
 const console_1 = require("../../utils/console");
 const allowed_files_1 = require("./allowed_files");
+const exerciseFileOrder_1 = require("../../utils/exerciseFileOrder");
 // function processQuestions(markdown: string): {
 //   updatedMarkdown: string
 //   questions: { id: string; examples: string[] }[]
@@ -272,20 +273,7 @@ const filterFiles = (files, basePath = ".") => files
         path: basePath + "/" + ex,
     }),
 }))
-    .sort((f1, f2) => {
-    const score = {
-        // sorting priority
-        "index.html": 1,
-        "styles.css": 2,
-        "styles.scss": 2,
-        "style.css": 2,
-        "style.scss": 2,
-        "index.css": 2,
-        "index.scss": 2,
-        "index.js": 3,
-    };
-    return score[f1.name] < score[f2.name] ? -1 : 1;
-});
+    .sort((f1, f2) => (0, exerciseFileOrder_1.compareExerciseFileNames)(f1.name, f2.name));
 exports.filterFiles = filterFiles;
 exports.default = {
     exercise: exports.exercise,

package/lib/managers/readmeHistoryService.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadmeHistoryService = void 0;
+const readmeSanitizer_1 = require("../utils/readmeSanitizer");
 /**
  * Service to handle README file updates with automatic history tracking
  * Encapsulates the logic of saving state to history before updating files
@@ -169,9 +170,10 @@ class ReadmeHistoryService {
      * @returns void
      */
     async saveToGCS(courseSlug, exerciseSlug, fileName, content) {
+        const sanitizedContent = (0, readmeSanitizer_1.sanitizeReadmeNewlines)(content);
         const filePath = `courses/${courseSlug}/exercises/${exerciseSlug}/${fileName}`;
         const file = this.bucket.file(filePath);
-        await file.save(content, {
+        await file.save(sanitizedContent, {
             resumable: false,
         });
     }

package/lib/managers/server/routes.js

@@ -13,6 +13,7 @@ const session_1 = require("../../managers/session");
 const telemetry_1 = require("../telemetry");
 const creatorUtilities_1 = require("../../utils/creatorUtilities");
 const rigoActions_1 = require("../../utils/rigoActions");
+const readmeSanitizer_1 = require("../../utils/readmeSanitizer");
 const sidebarGenerator_1 = require("../../utils/sidebarGenerator");
 const path = require("path");
 // import { eventManager } from "../../utils/osOperations"
@@ -303,7 +304,7 @@ async function default_1(app, configObject, configManager) {
                     const readme = exercise.getReadme(null);
                     await Promise.all(languagesToTranslate.map(async (language) => {
                         const response = await (0, rigoActions_1.translateExercise)(rigoToken, {
-                            text_to_translate: readme.body,
+                            text_to_translate: (0, readmeSanitizer_1.sanitizeReadmeNewlines)(readme.body),
                             output_language: language,
                         }, `${process.env.HOST}/webhooks/translate-exercise`);
                         await (0, creatorUtilities_1.saveTranslatedReadme)(slug, response.parsed.output_language_code, response.parsed.translation);

package/lib/utils/configBuilder.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildConfig = buildConfig;
+const exerciseFileOrder_1 = require("./exerciseFileOrder");
 function naturalCompare(a, b) {
     // Split by dots and hyphens, compare numbers as numbers
     const regex = /(\d+|\D+)/g;
@@ -64,7 +65,7 @@ async function buildConfig(bucket, courseSlug) {
     }
     const exercises = Object.values(map)
         .sort((a, b) => naturalCompare(a.slug, b.slug))
-        .map((ex, i) => (Object.assign(Object.assign({}, ex), { position: i })));
+        .map((ex, i) => (Object.assign(Object.assign({}, ex), { files: (0, exerciseFileOrder_1.sortExerciseFiles)(ex.files), position: i })));
     return {
         config: Object.assign({}, learnJson),
         exercises,

package/lib/utils/creatorUtilities.js

@@ -334,13 +334,13 @@ function countSentences(text) {
 function howManyDifficultParagraphs(paragraphs, maxFKGL) {
     return paragraphs.filter(paragraph => paragraph.fkgl > maxFKGL).length;
 }
-const example_content = `Write or paste your table of content below this line, each topic should be defined on a new line, here is an example:
-
-Introduction to AI: Explain what is AI and its applications
-Introduction to Machine Learning: Explain what is machine learning and its applications
-What is an AI Model: Explain what is an AI model and its applications
-How to use an AI Model: Different APIs, local models, etc.
-How to build an AI Model: Fine-tuning, data collection, cleaning and more.
+const example_content = `Write or paste your table of content below this line, each topic should be defined on a new line, here is an example:
+
+Introduction to AI: Explain what is AI and its applications
+Introduction to Machine Learning: Explain what is machine learning and its applications
+What is an AI Model: Explain what is an AI model and its applications
+How to use an AI Model: Different APIs, local models, etc.
+How to build an AI Model: Fine-tuning, data collection, cleaning and more.
 `;
 const appendContentIndex = async () => {
     const choices = await prompts([
@@ -370,13 +370,13 @@ const appendContentIndex = async () => {
     return null;
 };
 exports.appendContentIndex = appendContentIndex;
-const example_airules = `
-Write with an engaging tone, use simple words and avoid complex sentences.
-Write in first person, as if you are talking to the reader.
-Add mental maps to help the reader understand the content.
-Add diagrams to help the reader understand the content.
-No code exercises required
-
+const example_airules = `
+Write with an engaging tone, use simple words and avoid complex sentences.
+Write in first person, as if you are talking to the reader.
+Add mental maps to help the reader understand the content.
+Add diagrams to help the reader understand the content.
+No code exercises required
+
 `;
 const appendAIRules = async () => {
     const choices = await prompts([

package/lib/utils/exerciseFileOrder.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Shared ordering logic for exercise file lists (e.g. editor tabs).
+ * Ensures solution files (*.solution.hide.*) always appear after their base file.
+ */
+/**
+ * Comparator for two file names. Use with Array.prototype.sort.
+ * Solution files are ordered after their base file; then by priority; then alphabetically.
+ * @param nameA - First file name.
+ * @param nameB - Second file name.
+ * @returns Negative if nameA < nameB, 0 if equal, positive if nameA > nameB.
+ */
+export declare function compareExerciseFileNames(nameA: string, nameB: string): number;
+/**
+ * Sorts an array of file-like objects by name using exercise file ordering rules.
+ * @param files - Array of objects with a `name` property.
+ * @returns A new sorted array (original is not mutated).
+ */
+export declare function sortExerciseFiles<T extends {
+    name: string;
+}>(files: T[]): T[];

package/lib/utils/exerciseFileOrder.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * Shared ordering logic for exercise file lists (e.g. editor tabs).
+ * Ensures solution files (*.solution.hide.*) always appear after their base file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareExerciseFileNames = compareExerciseFileNames;
+exports.sortExerciseFiles = sortExerciseFiles;
+const SOLUTION_HIDE = ".solution.hide";
+const isSolutionFile = (name) => name.includes(SOLUTION_HIDE);
+const getBaseFileName = (name) => name.replace(SOLUTION_HIDE, "");
+const FILE_PRIORITY = {
+    "index.html": 1,
+    "styles.css": 2,
+    "styles.scss": 2,
+    "style.css": 2,
+    "style.scss": 2,
+    "index.css": 2,
+    "index.scss": 2,
+    "index.js": 3,
+};
+const DEFAULT_PRIORITY = Infinity;
+/**
+ * Comparator for two file names. Use with Array.prototype.sort.
+ * Solution files are ordered after their base file; then by priority; then alphabetically.
+ * @param nameA - First file name.
+ * @param nameB - Second file name.
+ * @returns Negative if nameA < nameB, 0 if equal, positive if nameA > nameB.
+ */
+function compareExerciseFileNames(nameA, nameB) {
+    var _a, _b;
+    if (isSolutionFile(nameA) && getBaseFileName(nameA) === nameB)
+        return 1;
+    if (isSolutionFile(nameB) && getBaseFileName(nameB) === nameA)
+        return -1;
+    const s1 = (_a = FILE_PRIORITY[nameA]) !== null && _a !== void 0 ? _a : DEFAULT_PRIORITY;
+    const s2 = (_b = FILE_PRIORITY[nameB]) !== null && _b !== void 0 ? _b : DEFAULT_PRIORITY;
+    if (s1 !== s2)
+        return s1 - s2;
+    return nameA.localeCompare(nameB);
+}
+/**
+ * Sorts an array of file-like objects by name using exercise file ordering rules.
+ * @param files - Array of objects with a `name` property.
+ * @returns A new sorted array (original is not mutated).
+ */
+function sortExerciseFiles(files) {
+    return [...files].sort((a, b) => compareExerciseFileNames(a.name, b.name));
+}

package/lib/utils/export/epub.js

@@ -75,14 +75,14 @@ async function generateEpub(markdownFiles, outputPath, metadata, epubMetadata, c
                 return "";
             return str.replace(/"/g, '\\"').replace(/\n/g, "\\n");
         };
-        const yamlContent = `---
-title: "${epubMetadata.title}"
-creator: "${epubMetadata.creator}"
-publisher: "${epubMetadata.publisher}"
-rights: "${epubMetadata.rights}"
-lang: "${epubMetadata.lang}"
-description: "${escapeYaml(metadata.description || "")}"
-subject: "${((_a = metadata.technologies) === null || _a === void 0 ? void 0 : _a.join(", ")) || "Programming"}"
+        const yamlContent = `---
+title: "${epubMetadata.title}"
+creator: "${epubMetadata.creator}"
+publisher: "${epubMetadata.publisher}"
+rights: "${epubMetadata.rights}"
+lang: "${epubMetadata.lang}"
+description: "${escapeYaml(metadata.description || "")}"
+subject: "${((_a = metadata.technologies) === null || _a === void 0 ? void 0 : _a.join(", ")) || "Programming"}"
 ---`;
         fs.writeFileSync(yamlPath, yamlContent, "utf-8");
         // Include all markdown files in the EPUB
@@ -348,20 +348,20 @@ async function exportToEpub(options, epubMetadata) {
     const sidebarData = readSidebarData(path.join(epubOutDir, "learn"));
     console.log("📋 Sidebar data loaded:", sidebarData ? "Success" : "Not found");
     // 7. Create main content file as markdown
-    const mainContent = `# ${metadata.title}
-
-${metadata.description || ""}
-
-**Technologies:** ${((_c = metadata.technologies) === null || _c === void 0 ? void 0 : _c.join(", ")) || "Programming"}
-
-**Difficulty:** ${metadata.difficulty}
-
-**Language:** ${language}
-
----
-
-## Table of Contents
-
+    const mainContent = `# ${metadata.title}
+
+${metadata.description || ""}
+
+**Technologies:** ${((_c = metadata.technologies) === null || _c === void 0 ? void 0 : _c.join(", ")) || "Programming"}
+
+**Difficulty:** ${metadata.difficulty}
+
+**Language:** ${language}
+
+---
+
+## Table of Contents
+
 ${processedMarkdownFiles
         .map((file, index) => {
         const fileName = path.basename(file, ".processed.md");
@@ -379,10 +379,10 @@ ${processedMarkdownFiles
         }
         return `${index + 1}. ${displayName}`;
     })
-        .join("\n")}
-
----
-
+        .join("\n")}
+
+---
+
 `;
     const mainContentPath = path.join(epubOutDir, "processed", "main.md");
     mkdirp.sync(path.dirname(mainContentPath));

package/lib/utils/readmeSanitizer.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Replaces sequences of 3+ newlines (with optional spaces in between)
+ * with a single double newline. Prevents excessive whitespace that can
+ * cause translation API token limit issues.
+ * @param content - Raw README string
+ * @returns Sanitized string
+ */
+export declare function sanitizeReadmeNewlines(content: string): string;

package/lib/utils/readmeSanitizer.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeReadmeNewlines = sanitizeReadmeNewlines;
+/**
+ * Replaces sequences of 3+ newlines (with optional spaces in between)
+ * with a single double newline. Prevents excessive whitespace that can
+ * cause translation API token limit issues.
+ * @param content - Raw README string
+ * @returns Sanitized string
+ */
+function sanitizeReadmeNewlines(content) {
+    return content.replace(/(\n\s*){3,}/g, "\n\n");
+}

package/lib/utils/templates/epub/epub.css

@@ -1,146 +1,146 @@
-/* Basic EPUB styling */
-body {
-  font-family: "Georgia", serif;
-  line-height: 1.6;
-  margin: 2em;
-  color: #333;
-}
-
-h1,
-h2,
-h3,
-h4,
-h5,
-h6 {
-  color: #2c3e50;
-  margin-top: 1.5em;
-  margin-bottom: 0.5em;
-}
-
-h1 {
-  font-size: 2em;
-  border-bottom: 2px solid #3498db;
-  padding-bottom: 0.3em;
-}
-
-h2 {
-  font-size: 1.5em;
-  border-bottom: 1px solid #bdc3c7;
-  padding-bottom: 0.2em;
-}
-
-p {
-  margin-bottom: 1em;
-  text-align: justify;
-}
-
-code {
-  background-color: #f8f9fa;
-  padding: 0.2em 0.4em;
-  border-radius: 3px;
-  font-family: "Courier New", monospace;
-  font-size: 0.9em;
-}
-
-pre {
-  background-color: #f8f9fa;
-  padding: 1em;
-  border-radius: 5px;
-  overflow-x: auto;
-  border-left: 4px solid #3498db;
-}
-
-pre code {
-  background-color: transparent;
-  padding: 0;
-}
-
-blockquote {
-  border-left: 4px solid #bdc3c7;
-  margin: 1em 0;
-  padding-left: 1em;
-  font-style: italic;
-  color: #7f8c8d;
-}
-
-ul,
-ol {
-  margin-bottom: 1em;
-  padding-left: 2em;
-}
-
-li {
-  margin-bottom: 0.5em;
-}
-
-a {
-  color: #3498db;
-  text-decoration: none;
-}
-
-a:hover {
-  text-decoration: underline;
-}
-
-img {
-  max-width: 100%;
-  height: auto;
-  display: block;
-  margin: 1em auto;
-}
-
-table {
-  border-collapse: collapse;
-  width: 100%;
-  margin: 1em 0;
-}
-
-th,
-td {
-  border: 1px solid #ddd;
-  padding: 8px;
-  text-align: left;
-}
-
-th {
-  background-color: #f2f2f2;
-  font-weight: bold;
-}
-
-#toc {
-  background-color: #f8f9fa;
-  padding: 1em;
-  border-radius: 5px;
-  margin-bottom: 2em;
-}
-
-#toc h2 {
-  border-bottom: none;
-  margin-top: 0;
-}
-
-#toc ol {
-  padding-left: 1em;
-}
-
-#toc li {
-  margin-bottom: 0.3em;
-}
-
-#toc a {
-  color: #2c3e50;
-  font-weight: 500;
-}
-
-/* Open question styles */
-.open-question {
-  border: 1px solid #c2c2c2;
-  padding: 1em;
-  background-color: #fafafa;
-  margin: 1em 0;
-  width: 100%;
-  height: 150px;
-  color: #c2c2c2;
-  border-radius: 5px;
-  font-style: italic;
-}
+/* Basic EPUB styling */
+body {
+  font-family: "Georgia", serif;
+  line-height: 1.6;
+  margin: 2em;
+  color: #333;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  color: #2c3e50;
+  margin-top: 1.5em;
+  margin-bottom: 0.5em;
+}
+
+h1 {
+  font-size: 2em;
+  border-bottom: 2px solid #3498db;
+  padding-bottom: 0.3em;
+}
+
+h2 {
+  font-size: 1.5em;
+  border-bottom: 1px solid #bdc3c7;
+  padding-bottom: 0.2em;
+}
+
+p {
+  margin-bottom: 1em;
+  text-align: justify;
+}
+
+code {
+  background-color: #f8f9fa;
+  padding: 0.2em 0.4em;
+  border-radius: 3px;
+  font-family: "Courier New", monospace;
+  font-size: 0.9em;
+}
+
+pre {
+  background-color: #f8f9fa;
+  padding: 1em;
+  border-radius: 5px;
+  overflow-x: auto;
+  border-left: 4px solid #3498db;
+}
+
+pre code {
+  background-color: transparent;
+  padding: 0;
+}
+
+blockquote {
+  border-left: 4px solid #bdc3c7;
+  margin: 1em 0;
+  padding-left: 1em;
+  font-style: italic;
+  color: #7f8c8d;
+}
+
+ul,
+ol {
+  margin-bottom: 1em;
+  padding-left: 2em;
+}
+
+li {
+  margin-bottom: 0.5em;
+}
+
+a {
+  color: #3498db;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+img {
+  max-width: 100%;
+  height: auto;
+  display: block;
+  margin: 1em auto;
+}
+
+table {
+  border-collapse: collapse;
+  width: 100%;
+  margin: 1em 0;
+}
+
+th,
+td {
+  border: 1px solid #ddd;
+  padding: 8px;
+  text-align: left;
+}
+
+th {
+  background-color: #f2f2f2;
+  font-weight: bold;
+}
+
+#toc {
+  background-color: #f8f9fa;
+  padding: 1em;
+  border-radius: 5px;
+  margin-bottom: 2em;
+}
+
+#toc h2 {
+  border-bottom: none;
+  margin-top: 0;
+}
+
+#toc ol {
+  padding-left: 1em;
+}
+
+#toc li {
+  margin-bottom: 0.3em;
+}
+
+#toc a {
+  color: #2c3e50;
+  font-weight: 500;
+}
+
+/* Open question styles */
+.open-question {
+  border: 1px solid #c2c2c2;
+  padding: 1em;
+  background-color: #fafafa;
+  margin: 1em 0;
+  width: 100%;
+  height: 150px;
+  color: #c2c2c2;
+  border-radius: 5px;
+  font-style: italic;
+}