mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-08 10:56:15 -08:00
- Added a new script `build:test` to generate test cases from documentation code examples. - Enhanced documentation files by ensuring proper code block formatting and adding missing closing backticks. - Updated various markdown files to include new code blocks and fixed formatting issues.
133 lines
4.1 KiB
JavaScript
133 lines
4.1 KiB
JavaScript
import fs from 'node:fs'
|
|
import path from 'node:path'
|
|
|
|
const docsDir = path.resolve('packages/artplayer-vitepress/docs/en')
|
|
const outputFile = path.resolve('docs/test/test.js')
|
|
|
|
// Regex to match code blocks after "Run Code" markers
|
|
// Match until we find a closing ``` that's on its own line
|
|
const runCodePattern = /<div className="run-code">.*?<\/div>\s*\n\s*```js[^\n]*\n([\s\S]*?)\n```(?=\s*\n|$)/g
|
|
|
|
function extractCodeBlocks(content, filePath) {
|
|
const blocks = []
|
|
let match
|
|
|
|
while ((match = runCodePattern.exec(content)) !== null) {
|
|
let code = match[1].trim()
|
|
|
|
// Skip if code contains markdown syntax (unclosed code block issue)
|
|
if (code.includes('\n## ') || code.includes('\n:::') || code.includes('<div className="run-code">')) {
|
|
console.warn(`⚠️ Skipping malformed code block in ${filePath}`)
|
|
continue
|
|
}
|
|
|
|
blocks.push({
|
|
code,
|
|
file: filePath,
|
|
})
|
|
}
|
|
|
|
return blocks
|
|
}
|
|
|
|
function processMarkdownFiles(dir, relativePath = '') {
|
|
const results = []
|
|
const items = fs.readdirSync(dir)
|
|
|
|
for (const item of items) {
|
|
const fullPath = path.join(dir, item)
|
|
const relPath = path.join(relativePath, item)
|
|
const stat = fs.statSync(fullPath)
|
|
|
|
if (stat.isDirectory()) {
|
|
results.push(...processMarkdownFiles(fullPath, relPath))
|
|
}
|
|
else if (item.endsWith('.md')) {
|
|
const content = fs.readFileSync(fullPath, 'utf-8')
|
|
const blocks = extractCodeBlocks(content, relPath)
|
|
if (blocks.length > 0) {
|
|
results.push({
|
|
file: relPath,
|
|
blocks,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
return results
|
|
}
|
|
|
|
function generateTestCode(fileResults) {
|
|
const lines = []
|
|
|
|
lines.push(`// Auto-generated smoke tests from documentation code blocks`)
|
|
lines.push(`// Generated at: ${new Date().toISOString()}`)
|
|
lines.push(`// Do not edit manually - run 'node scripts/build-test.js' to regenerate`)
|
|
lines.push(``)
|
|
lines.push(`describe('Documentation Code Examples', function () {`)
|
|
lines.push(` this.timeout(5000);`)
|
|
lines.push(``)
|
|
lines.push(` beforeEach(function () {`)
|
|
lines.push(` // Destroy any existing instances`)
|
|
lines.push(` [...Artplayer.instances].forEach((art) => art.destroy());`)
|
|
lines.push(` // Reset container`)
|
|
lines.push(` const container = document.querySelector('.artplayer-app');`)
|
|
lines.push(` if (container) {`)
|
|
lines.push(` container.innerHTML = '';`)
|
|
lines.push(` }`)
|
|
lines.push(` });`)
|
|
lines.push(``)
|
|
lines.push(` afterEach(function () {`)
|
|
lines.push(` [...Artplayer.instances].forEach((art) => art.destroy());`)
|
|
lines.push(` });`)
|
|
lines.push(``)
|
|
|
|
for (const { file, blocks } of fileResults) {
|
|
const suiteName = file.replace(/\.md$/, '').replace(/\//g, ' > ')
|
|
|
|
lines.push(` describe('${suiteName}', function () {`)
|
|
|
|
blocks.forEach((block, index) => {
|
|
const testName = `Example ${index + 1}`
|
|
// Escape the code for embedding in a string
|
|
const escapedCode = block.code
|
|
.replace(/\\/g, '\\\\')
|
|
.replace(/`/g, '\\`')
|
|
.replace(/\$/g, '\\$')
|
|
|
|
lines.push(` it('${testName}', function (done) {`)
|
|
lines.push(` try {`)
|
|
lines.push(` ${block.code.split('\n').join('\n ')}`)
|
|
lines.push(` // Wait a bit for async initialization`)
|
|
lines.push(` setTimeout(() => done(), 100);`)
|
|
lines.push(` } catch (err) {`)
|
|
lines.push(` done(err);`)
|
|
lines.push(` }`)
|
|
lines.push(` });`)
|
|
lines.push(``)
|
|
})
|
|
|
|
lines.push(` });`)
|
|
lines.push(``)
|
|
}
|
|
|
|
lines.push(`});`)
|
|
|
|
return lines.join('\n')
|
|
}
|
|
|
|
// Main execution
|
|
const fileResults = processMarkdownFiles(docsDir)
|
|
|
|
let totalBlocks = 0
|
|
for (const { file, blocks } of fileResults) {
|
|
console.log(`📄 ${file}: ${blocks.length} code blocks`)
|
|
totalBlocks += blocks.length
|
|
}
|
|
|
|
const testCode = generateTestCode(fileResults)
|
|
fs.writeFileSync(outputFile, testCode)
|
|
|
|
console.log(`\n✅ Generated ${totalBlocks} test cases from ${fileResults.length} files`)
|
|
console.log(`📝 Output: ${outputFile}`)
|