chore: import upstream snapshot with attribution

2026-07-13 11:55:53 +08:00
commit dde272c4b8
19405 changed files with 2730632 additions and 0 deletions
@@ -0,0 +1,128 @@
+const { findAll } = require('./utils/find-all');
+const { isMarker } = require('./utils/get-section');
+
+const VALID_MARKERS = [
+  // Level 1
+  '# --after-all--',
+  '# --after-each--',
+  '# --assignment--',
+  '# --before-all--',
+  '# --before-each--',
+  '# --description--',
+  '# --explanation--',
+  '# --fillInTheBlank--',
+  '# --hints--',
+  '# --instructions--',
+  '# --interactive--',
+  '# --notes--',
+  '# --questions--',
+  '# --quizzes--',
+  '# --scene--',
+  '# --seed--',
+  '# --solutions--',
+  '# --transcript--',
+
+  // Level 2
+  '## --answers--',
+  '## --blanks--',
+  '## --quiz--',
+  '## --seed-contents--',
+  '## --sentence--',
+  '## --text--',
+  '## --video-solution--',
+
+  // Level 3
+  '### --audio-id--',
+  '### --feedback--',
+  '### --question--',
+
+  // Level 4
+  '#### --answer--',
+  '#### --audio--',
+  '#### --distractors--',
+  '#### --text--'
+];
+
+// Special markers that should not be used as headings
+const NON_HEADING_MARKERS = ['--fcc-editable-region--'];
+
+function validateSections() {
+  function transformer(tree) {
+    const allMarkers = findAll(tree, isMarker);
+
+    const invalidMarkerNames = [];
+    const invalidHeadingLevels = [];
+    const nonHeadingMarkersAsHeadings = [];
+
+    const errors = [];
+
+    for (const markerNode of allMarkers) {
+      const markerValue = markerNode.children[0].value;
+      const headingLevel = markerNode.depth;
+      const fullMarker = '#'.repeat(headingLevel) + ' ' + markerValue;
+
+      if (NON_HEADING_MARKERS.includes(markerValue)) {
+        nonHeadingMarkersAsHeadings.push(fullMarker);
+        continue;
+      }
+
+      if (!VALID_MARKERS.includes(fullMarker)) {
+        const markerExistsAtAnyLevel = VALID_MARKERS.some(validMarker =>
+          validMarker.endsWith(markerValue)
+        );
+
+        if (markerExistsAtAnyLevel) {
+          const validLevels = VALID_MARKERS.filter(validMarker =>
+            validMarker.endsWith(markerValue)
+          ).map(validMarker => validMarker.split(' ')[0]); // Extract the # symbols
+
+          invalidHeadingLevels.push({
+            fullMarker,
+            markerValue,
+            validLevels
+          });
+        } else {
+          invalidMarkerNames.push(markerValue);
+        }
+      }
+    }
+
+    if (invalidMarkerNames.length > 0) {
+      errors.push(
+        `Invalid marker names: ${invalidMarkerNames.map(m => `"${m}"`).join(', ')}.`
+      );
+    }
+
+    if (nonHeadingMarkersAsHeadings.length > 0) {
+      errors.push(
+        `Non-heading markers should not be used as headings: ${nonHeadingMarkersAsHeadings.map(m => `"${m}"`).join(', ')}.`
+      );
+    }
+
+    if (invalidHeadingLevels.length > 0) {
+      const levelErrors = invalidHeadingLevels.map(
+        ({ fullMarker, markerValue, validLevels }) => {
+          const validText =
+            validLevels.length === 1
+              ? `${validLevels[0]} ${markerValue}`
+              : validLevels
+                  .map(level => `${level} ${markerValue}`)
+                  .join(' or ');
+          return `"${fullMarker}" should be "${validText}"`;
+        }
+      );
+
+      errors.push(`Invalid heading levels: ${levelErrors.join(', ')}.`);
+    }
+
+    if (errors.length > 0) {
+      throw new Error(errors.join('\n'));
+    }
+  }
+
+  return transformer;
+}
+
+module.exports = validateSections;
+module.exports.VALID_MARKERS = VALID_MARKERS;
+module.exports.NON_HEADING_MARKERS = NON_HEADING_MARKERS;