|
| 1 | +import { readFile } from 'node:fs/promises'; |
| 2 | + |
| 3 | +import { parse } from 'acorn'; |
| 4 | +import { glob } from 'glob'; |
| 5 | +import remarkParse from 'remark-parse'; |
| 6 | +import { unified } from 'unified'; |
| 7 | +import { visit } from 'unist-util-visit'; |
| 8 | + |
| 9 | +const SUPPORTED_LANGUAGES = ['js', 'mjs', 'cjs']; |
| 10 | + |
| 11 | +// Initialize the markdown parser |
| 12 | +const markdownParser = unified().use(remarkParse); |
| 13 | + |
| 14 | +/** |
| 15 | + * Parse JavaScript code using Acorn |
| 16 | + * |
| 17 | + * @param {string} code - The code to parse |
| 18 | + * @param {string} language - The language identifier |
| 19 | + * @returns {void} |
| 20 | + * @throws {Error} If parsing fails |
| 21 | + */ |
| 22 | +function parseJavaScript(code, language) { |
| 23 | + parse(code, { |
| 24 | + ecmaVersion: 'latest', |
| 25 | + sourceType: language === 'cjs' ? 'script' : 'module', |
| 26 | + allowReturnOutsideFunction: true, |
| 27 | + }); |
| 28 | +} |
| 29 | + |
| 30 | +/** |
| 31 | + * Validate code blocks in a markdown file |
| 32 | + * |
| 33 | + * @param {string} filePath - Path to the markdown file |
| 34 | + * @returns {Array<{path: string, position: number, message: string}>} Array of errors |
| 35 | + */ |
| 36 | +async function validateFile(filePath) { |
| 37 | + const errors = []; |
| 38 | + |
| 39 | + const content = await readFile(filePath, 'utf-8'); |
| 40 | + const tree = markdownParser.parse(content); |
| 41 | + |
| 42 | + visit(tree, 'code', node => { |
| 43 | + // TODO: Add TypeScript support |
| 44 | + if (!SUPPORTED_LANGUAGES.includes(node.lang)) { |
| 45 | + return; |
| 46 | + } |
| 47 | + |
| 48 | + try { |
| 49 | + parseJavaScript(node.value, node.lang); |
| 50 | + } catch (err) { |
| 51 | + errors.push({ |
| 52 | + path: filePath, |
| 53 | + position: node.position.start.line, |
| 54 | + message: err.message, |
| 55 | + }); |
| 56 | + } |
| 57 | + }); |
| 58 | + |
| 59 | + return errors; |
| 60 | +} |
| 61 | + |
| 62 | +/** |
| 63 | + * Print validation errors to console |
| 64 | + * |
| 65 | + * @param {Array<{path: string, position: number, message: string}>} errors |
| 66 | + * @returns {void} |
| 67 | + */ |
| 68 | +function reportErrors(errors) { |
| 69 | + if (errors.length === 0) { |
| 70 | + return; |
| 71 | + } |
| 72 | + |
| 73 | + console.error('Errors found in the following files:'); |
| 74 | + errors.forEach(({ path, position, message }) => { |
| 75 | + console.error(`- ${path}:${position}: ${message}`); |
| 76 | + }); |
| 77 | +} |
| 78 | + |
| 79 | +// Get all markdown files |
| 80 | +const filePaths = await glob('**/*.md', { |
| 81 | + root: process.cwd(), |
| 82 | + cwd: 'apps/site/pages/en/learn/', |
| 83 | + absolute: true, |
| 84 | +}); |
| 85 | + |
| 86 | +// Validate all files and collect errors |
| 87 | +const allErrors = await Promise.all(filePaths.map(validateFile)); |
| 88 | + |
| 89 | +// Flatten the array of errors |
| 90 | +const flattenedErrors = allErrors.flat(); |
| 91 | + |
| 92 | +// Report errors if any |
| 93 | +reportErrors(flattenedErrors); |
| 94 | + |
| 95 | +// Exit with appropriate code |
| 96 | +process.exit(flattenedErrors.length > 0 ? 1 : 0); |
0 commit comments