@nan0web/ui 1.10.0 → 1.11.0

package/src/domain/app/SnapshotAuditor.js

@@ -0,0 +1,401 @@
+import { NaN0 } from '@nan0web/types'
+import { AuditorModel } from '@nan0web/inspect'
+import { progress, result, show } from '../../core/Intent.js'
+
+/**
+ * SnapshotAuditor — Zero-Hallucination Snapshot Validation (Model-as-Schema v2).
+ * Parses snapshots without evaluating the app logic and detects artifacts.
+ *
+ * @extends {AuditorModel}
+ */
+export class SnapshotAuditor extends AuditorModel {
+	static alias = 'audit'
+
+	static dir = {
+		type: 'string',
+		help: 'Target directory to audit snapshots in',
+		positional: true,
+		default: 'snapshots/core',
+	}
+
+	static data = {
+		type: 'string',
+		help: 'Directory to scan for dictionaries',
+		default: 'data',
+	}
+
+	/** @type {Object<string, string>} Messages for UI */
+	static UI = {
+		title: 'Snapshot Auditor',
+		description: 'Validates UI snapshots against hallucinations and localization leaks.',
+		icon: '📸',
+		starting: 'Auditing snapshots in {dir}',
+		noSnapshots: 'No snapshots found to audit in {dir}',
+		doneSuccess: 'All snapshots passed the audit.',
+		doneErrors: 'Gallery audit failed with errors. Check above.',
+		auditPassed: 'Audit passed: {file}',
+		auditFailed: 'Audit failed for {file}: {errors}',
+
+		errorGlitch: 'Filename "{filename}" has multiple consecutive separators (glitch detected).',
+		errorShort: 'Filename "{filename}" is too short.',
+		errorSyntax: 'Syntax Error: Failed to parse NaN0 file. {msg}',
+		errorArtifact: 'Path {path}: Critical artifact "{artifact}" found.',
+		errorRouting: 'Path {path}: Routing error "Path not found".',
+		errorUntranslated: 'Path {path}: Possible untranslated key found: "{str}"',
+		errorEnglishLeak: 'Path {path}: English word "{word}" found in "{locale}" locale.',
+		errorEmptyRender:
+			'Path {path}.{key}: Snapshot is suspiciously empty (pure tag {compName} with NO properties or content).',
+		errorForeignLeak:
+			'Path {path}: Word "{word}" belongs to "{foreign}" but is missing in "{locale}".',
+	}
+
+	/** @type {string[]} Common UI components that can be empty in render */
+	static EXEMPT_EMPTY = ['ui-spinner', 'ui-themetoggle', 'ui-langselect', 'ui-sortable']
+
+	/** @type {string[]} Critical JS artifacts to detect in snapshots */
+	static ARTIFACTS = ['[object Object]', 'undefined', 'NaN']
+
+	/** @type {string[]} Words to ignore across all languages */
+	static EXEMPT_WORDS = ['true', 'false', 'value', 'max', 'min', 'step', 'open', 'first', 'what', 'how', 'start', 'code', 'successfully', 'enter', 'with', 'system']
+
+	/** @type {RegExp} Pattern for suspicious filenames */
+	static SUSPICIOUS_FILENAME = /__|--/
+
+	/** @type {number} Minimum filename length */
+	static MIN_FILENAME_LENGTH = 3
+
+	/** @type {import('../../index.js').ModelAsAppOptions} */
+	_
+
+	/**
+	 * @param {Partial<SnapshotAuditor> | Record<string, any>} [data={}]
+	 * @param {Partial<import('@nan0web/types').ModelOptions>} [options={}]
+	 */
+	constructor(data = {}, options = {}) {
+		super(data, options)
+		this._ = options
+		/** @type {string} Target directory to audit */ this.dir
+		/** @type {string} Directory to scan for dictionaries */ this.data
+	}
+
+	/**
+	 * Extracts all valid words from an object into a Set.
+	 * @param {any} obj Node to extract from.
+	 * @param {Set<string>} set Set to populate.
+	 */
+	static extractWords(obj, set) {
+		if (typeof obj === 'string') {
+			const words = obj.toLowerCase().split(/[\s,.:;!"'(){}\[\]\\/<>?=\-+_@&#*^|~`]+/)
+			for (const w of words) {
+				if (w.length > 2 && isNaN(Number(w))) set.add(w)
+			}
+		} else if (Array.isArray(obj)) {
+			for (const item of obj) SnapshotAuditor.extractWords(item, set)
+		} else if (obj && typeof obj === 'object') {
+			for (const val of Object.values(obj)) SnapshotAuditor.extractWords(val, set)
+		}
+	}
+
+	/**
+	 * Scans data directories to build a word set for each language.
+	 * @param {any} fsDb FileSystem DB.
+	 * @param {string} data
+	 * @returns {Promise<Record<string, Set<string>>>}
+	 */
+	static async buildDictionaries(fsDb, data = 'data') {
+		/** @type {Record<string, Set<string>>} */
+		const dicts = {}
+
+		let entries = []
+		try {
+			let entriesList;
+			try {
+				entriesList = await fsDb.listDir(data)
+			} catch (e) {
+				if (/** @type {any} */ (e).code === 'ENOENT' && !data.startsWith('../')) {
+					entriesList = await fsDb.listDir('../' + data)
+				} else {
+					throw e;
+				}
+			}
+			for (const e of entriesList) entries.push(e)
+		} catch (e) {
+			return dicts
+		}
+
+		for (const entry of entries) {
+			if (entry.stat.isDirectory && entry.name !== '_') {
+				const lang = entry.name
+				if (!dicts[lang]) dicts[lang] = new Set()
+
+				const scanLang = async (dirPath) => {
+					let files = []
+					try {
+						const entries = await fsDb.listDir(dirPath)
+						for (const f of entries) files.push(f)
+					} catch (e) {
+						return
+					}
+
+					for (const f of files) {
+						if (f.stat.isDirectory) {
+							await scanLang(f.path)
+						} else {
+							try {
+								const _fsDb = /** @type {any} */ (fsDb)
+								const raw = _fsDb.FS ? await _fsDb.FS.loadTXT(_fsDb.location(f.path), '', true) : await fsDb.fetch(f.path)
+								SnapshotAuditor.extractWords(raw, dicts[lang])
+							} catch (e) {}
+						}
+					}
+				}
+				await scanLang(entry.path)
+			}
+		}
+		return dicts
+	}
+
+	/**
+	 * Run the snapshot audit inside the target directory.
+	 * @returns {AsyncGenerator<import('@nan0web/ui').Intent, any, any>}
+	 */
+	async *run() {
+		const { t } = this._
+		const snapshotsDir = this.dir || '.'
+
+		yield show(t(SnapshotAuditor.UI.starting, { dir: snapshotsDir }))
+
+		const files = []
+
+		/** @type {import('@nan0web/db').DB} */
+		let fsDb = this._.db
+		if (fsDb && fsDb.mounts && fsDb.mounts.has('')) {
+			fsDb = /** @type {import('@nan0web/db').DB} */ (fsDb.mounts.get(''))
+		}
+
+		if (!fsDb) {
+			yield show('FS Database not provided to auditor', 'error')
+			return result({ success: false })
+		}
+
+		const findSnapshots = async (dir) => {
+			try {
+				let entries;
+				try {
+					entries = await fsDb.listDir(dir)
+				} catch (e) {
+					if (/** @type {any} */ (e).code === 'ENOENT' && !dir.startsWith('../')) {
+						entries = await fsDb.listDir('../' + dir)
+					} else {
+						throw e;
+					}
+				}
+				for (const entry of entries) {
+					if (entry.stat.isDirectory) {
+						await findSnapshots(entry.path)
+					} else if (entry.name.endsWith('.nan0') || entry.name.endsWith('.txt')) {
+						files.push(entry.path)
+					}
+				}
+			} catch (e) {
+				console.error('Error reading dir:', dir, e)
+			}
+		}
+
+		await findSnapshots(snapshotsDir)
+
+		if (files.length === 0) {
+			yield show(t(SnapshotAuditor.UI.noSnapshots, { dir: snapshotsDir }), 'error')
+			return result({ success: false })
+		}
+
+		// Preload all dictionaries into memory across all languages
+		const dictionaries = await SnapshotAuditor.buildDictionaries(fsDb, this.data || 'data')
+
+		// Process all files in parallel for hyper-speed
+		const auditPromises = files.map(async (file) => {
+			const segments = file.split('/')
+			const locale = segments[segments.indexOf('core') + 1] || 'uk'
+			const componentName = segments.pop() || ''
+
+			const _fsDb = /** @type {any} */ (fsDb)
+			const content = _fsDb.FS ? await _fsDb.FS.loadTXT(_fsDb.location(file), '', true) : await fsDb.fetch(file)
+			const textContent = typeof content === 'string' ? content : JSON.stringify(content)
+
+			return {
+				file,
+				audit: SnapshotAuditor.inspectText(textContent, locale, componentName, t, dictionaries),
+			}
+		})
+
+		const results = await Promise.all(auditPromises)
+		const allErrors = []
+		let hasErrors = false
+
+		for (const { file, audit } of results) {
+			const displayFile = file.startsWith('../') ? file.slice(3) : file
+			if (audit.score < 100) {
+				const errorMessages = audit.errors.join('; ')
+				yield show(t(SnapshotAuditor.UI.auditFailed, { file: displayFile, errors: errorMessages }), 'error')
+				allErrors.push(...audit.errors.map((e) => ({ file: displayFile, error: e })))
+				hasErrors = true
+			} else {
+				yield show(t(SnapshotAuditor.UI.auditPassed, { file: displayFile }), 'success')
+			}
+		}
+
+		if (hasErrors) {
+			yield show(t(SnapshotAuditor.UI.doneErrors, {}), 'error')
+			return result({ success: false, errors: allErrors })
+		}
+
+		yield show(t(SnapshotAuditor.UI.doneSuccess, {}), 'success')
+		return result({ success: true })
+	}
+
+	/**
+	 * Inspects a single snapshot text.
+	 * @param {string} content Content of the file.
+	 * @param {string} locale Locale (uk, en).
+	 * @param {string} filename Name of the file.
+	 * @param {import('@nan0web/i18n').TFunction} t Translate function.
+	 * @param {Record<string, Set<string>>} [dictionaries=undefined] Loaded dictionaries for mutual exclusion check.
+	 * @returns {{ score: number, errors: string[] }}
+	 */
+	static inspectText(content, locale, filename, t, dictionaries = undefined) {
+		const errors = []
+
+		if (filename) {
+			if (SnapshotAuditor.SUSPICIOUS_FILENAME.test(filename)) {
+				errors.push(t(SnapshotAuditor.UI.errorGlitch, { filename }))
+			}
+			if (filename.length < SnapshotAuditor.MIN_FILENAME_LENGTH) {
+				errors.push(t(SnapshotAuditor.UI.errorShort, { filename }))
+			}
+		}
+
+		let parsed
+		try {
+			parsed = NaN0.parse(content)
+		} catch (e) {
+			const msg = e instanceof Error ? e.message : String(e)
+			errors.push(t(SnapshotAuditor.UI.errorSyntax, { msg }))
+			return { score: 0, errors }
+		}
+
+		const context = { locale, errors, t, dictionaries }
+		SnapshotAuditor.checkNode(parsed, '$', context)
+
+		return {
+			score: errors.length === 0 ? 100 : Math.max(0, 100 - errors.length * 10),
+			errors,
+		}
+	}
+
+	/**
+	 * Recursively checks a parsed node.
+	 * @param {any} node Node.
+	 * @param {string} path JSON path.
+	 * @param {{ locale: string, errors: string[], t: import('@nan0web/i18n').TFunction, dictionaries?: Record<string, Set<string>> }} context Context.
+	 */
+	static checkNode(node, path, context) {
+		if (typeof node === 'string') {
+			SnapshotAuditor.checkString(node, path, context)
+		} else if (Array.isArray(node)) {
+			node.forEach((item, i) => SnapshotAuditor.checkNode(item, `${path}[${i}]`, context))
+		} else if (node && typeof node === 'object') {
+			for (const [key, value] of Object.entries(node)) {
+				SnapshotAuditor.checkString(key, `${path}.key(${key})`, context)
+				SnapshotAuditor.checkNode(value, `${path}.${key}`, context)
+
+				if (key === 'render' && value && typeof value === 'object') {
+					for (const [compName, compProps] of Object.entries(value)) {
+						if (compProps && typeof compProps === 'object' && Object.keys(compProps).length === 0) {
+							if (!SnapshotAuditor.EXEMPT_EMPTY.includes(compName)) {
+								context.errors.push(
+									context.t(SnapshotAuditor.UI.errorEmptyRender, {
+										path,
+										key,
+										compName,
+									}),
+								)
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * Checks a string node.
+	 * @param {string} str String.
+	 * @param {string} path Path.
+	 * @param {{ locale: string, errors: string[], t: import('@nan0web/i18n').TFunction, dictionaries?: Record<string, Set<string>> }} context Context.
+	 */
+	static checkString(str, path, context) {
+		const { t, locale, errors } = context
+
+		for (const artifact of SnapshotAuditor.ARTIFACTS) {
+			if (str.includes(artifact)) {
+				// Special check for NaN to avoid false positives with NaN0 or NaN•
+				if (artifact === 'NaN' && (str.includes('NaN0') || str.includes('NaN•'))) continue
+				errors.push(t(SnapshotAuditor.UI.errorArtifact, { path, artifact }))
+			}
+		}
+
+		if (str.includes('Path not found')) errors.push(t(SnapshotAuditor.UI.errorRouting, { path }))
+
+		const isSystemProp =
+			path.includes('.variant') || path.includes('.key(') || path.includes('.ask')
+		if (!isSystemProp) {
+			const isDotNumber = /^-?\d+\.\d+$/.test(str)
+			const hasParens = str.includes('(') || str.includes(')')
+			const isEmail = str.includes('@')
+
+			if (
+				/\w+\.\w+/.test(str) &&
+				!str.includes('ui-') &&
+				!str.includes('http') &&
+				!isDotNumber &&
+				!hasParens &&
+				!isEmail
+			) {
+				errors.push(t(SnapshotAuditor.UI.errorUntranslated, { path, str }))
+			}
+
+			if (context.dictionaries && context.dictionaries[locale]) {
+				const myWords = context.dictionaries[locale]
+				const words = str.toLowerCase().split(/[\s,.:;!"'(){}\[\]\\/<>?=\-+_@&#*^|~`]+/)
+
+				for (const word of words) {
+					if (word.length <= 2 || !isNaN(Number(word))) continue
+					if (SnapshotAuditor.EXEMPT_WORDS.includes(word)) continue
+					if (myWords.has(word)) continue
+
+					/** @type {string | false} */
+					let foundInForeign = false
+					for (const [otherLoc, otherSet] of Object.entries(context.dictionaries)) {
+						if (otherLoc !== locale && otherSet.has(word)) {
+							foundInForeign = otherLoc
+							break
+						}
+					}
+
+					if (foundInForeign) {
+						errors.push(
+							t(SnapshotAuditor.UI.errorForeignLeak, {
+								path,
+								word,
+								foreign: foundInForeign,
+								locale,
+							}),
+						)
+					}
+				}
+			}
+		}
+	}
+}
+
+export default SnapshotAuditor

package/src/domain/app/SnapshotRunner.js

@@ -0,0 +1,264 @@
+import { Model } from '@nan0web/types'
+import { LogicInspector } from '../../testing/LogicInspector.js'
+import { VisualAdapter } from '../../testing/VisualAdapter.js'
+import { result, show, render } from '../../core/Intent.js'
+import SnapshotAuditor from './SnapshotAuditor.js'
+
+/**
+ * SnapshotRunner — Zero-Hallucination Snapshot Generation & Audit (Model-as-Schema v2).
+ * Operates entirely through DB-FS abstraction without raw FS/Path hardcodes.
+ */
+export class SnapshotRunner extends Model {
+	static UI = {
+		generating: '📸 Generating snapshots for {lang}/{comp}',
+		saved: '📸 Saved {file}',
+		auditFailed: '🚨 Audit failed for {file}: {errors}',
+		rootGallery:
+			'# 📸 Core Snapshots Gallery\n\n**Total Snapshots:** {count} | **Total Errors:** {errors}\n\n## Locales\n\n',
+		localeTitle: '🌍 Locale: {title}',
+		categoryTitle: '📂 Category: {title}',
+		backText: 'Back',
+		backLink: '[⬅ {text}](../index.md)',
+		galleryDescription: 'This gallery contains automatically generated interaction snapshots (Zero-Hallucination UI Core).',
+	}
+
+	static data = {
+		type: 'string',
+		help: 'Root directory containing locale folders with data.',
+		default: 'docs',
+	}
+
+	static snapshotsDir = {
+		type: 'string',
+		help: 'Directory where output text snapshots will be stored.',
+		default: 'snapshots/core',
+	}
+
+	/**
+	 * @param {Partial<SnapshotRunner> | Record<string, any>} [data={}]
+	 * @param {import('@nan0web/types').ModelOptions} [options={}]
+	 */
+	constructor(data = {}, options = {}) {
+		super(data, options)
+		/** @type {string} Directory containing snapshots */ this.snapshotsDir
+		/** @type {string} Root data directory */ this.data
+		/** @type {(compName: string) => string} */ this.getCategory = (comp) => 'Components'
+		/** @type {(compName: string, varData: any) => AsyncGenerator<any>} */ this.createModelStream
+	}
+
+	get db() {
+		return /** @type {import('@nan0web/db').DB} */ (this._.db)
+	}
+
+	/**
+	 * Recursive drop for directories via DB-FS.
+	 * @param {string} uri
+	 */
+	async dropRecursive(uri) {
+		let entries = []
+		try {
+			for await (const entry of this.db.readDir(uri)) entries.push(entry)
+		} catch (e) {
+			return // Dir doesn't exist
+		}
+		for (const entry of entries) {
+			if (entry.stat.isDirectory) {
+				await this.dropRecursive(entry.path)
+			} else {
+				await this.db.dropDocument(entry.path)
+			}
+		}
+		await this.db.dropDocument(uri)
+	}
+
+	async *run() {
+		const db = this.db
+		const t = this._.t || ((k) => k)
+
+		// Clean before generation
+		await this.dropRecursive(this.snapshotsDir)
+
+		const doc = (await this.db.fetch('index')) ?? {}
+
+		// Fetch languages
+		const langsData = (await this.db.fetch(`${this.data}/_/langs`)) || []
+		const langsIndex = {}
+		if (Array.isArray(langsData)) {
+			langsData.forEach((l) => {
+				if (l && l.locale) langsIndex[l.locale] = l.title || l.locale
+			})
+		}
+
+		const langs = []
+		for await (const entry of this.db.readDir(this.data)) {
+			if (entry.stat.isDirectory && entry.name !== '_' && entry.name !== 'site') langs.push(entry.name)
+		}
+
+		const galleryTree = {}
+		let globalErrors = 0
+		let globalCount = 0
+
+		for (const lang of langs) {
+			galleryTree[lang] = {}
+			const componentsBase = `${this.data}/${lang}/components`
+			const components = []
+			try {
+				for await (const entry of this.db.readDir(componentsBase)) {
+					if (!entry.isDirectory) components.push(entry.name)
+				}
+			} catch (e) {}
+
+			for (const file of components) {
+				const compName = file.replace(/\.[^/.]+$/, "")
+				const data = (await this.db.fetch(`${componentsBase}/${compName}`)) || {}
+
+				// Extract variations
+				const variations = data.content || []
+				const variationsData = []
+
+				for (let i = 0; i < variations.length; i++) {
+					const rawVar = variations[i]
+					let varData = rawVar[compName] !== undefined ? rawVar[compName] : rawVar
+
+					// Extract schema defaults
+					const schema = data['$' + compName] || {}
+					const defaultProps = {}
+					for (const [k, v] of Object.entries(schema)) {
+						if (v && v.default !== undefined) {
+							defaultProps[k] = v.default
+						}
+					}
+
+					// Merge defaults
+					if (typeof varData === 'object' && varData !== null) {
+						varData = { ...defaultProps, ...varData }
+					} else if (varData === true) {
+						varData = { ...defaultProps }
+					} else if (typeof varData === 'string' || typeof varData === 'number') {
+						varData = { ...defaultProps, content: String(varData) }
+					}
+
+					let varName = rawVar.content || rawVar.title || rawVar.message || `var${i + 1}`
+					if (typeof varName !== 'string') {
+						if (typeof varData.title === 'string') varName = varData.title
+						else if (typeof varData.content === 'string') varName = varData.content
+						else varName = `var${i + 1}`
+					}
+
+					const safeVarName = varName
+						.trim()
+						.toLowerCase()
+						.replace(/[./\\:]/g, '_')
+						.replace(/\s+/g, '_')
+						.replace(/_{2,}/g, '_')
+						.slice(0, 50)
+
+					// Build model stream
+					let intents
+					if (this.createModelStream) {
+						intents = await LogicInspector.capture(this.createModelStream(compName, varData))
+					} else {
+						const defaultModelStream = async function* () {
+							yield render(`ui-${compName.toLowerCase()}`, varData)
+							return result({})
+						}
+						intents = await LogicInspector.capture(defaultModelStream())
+					}
+
+					const snapshot = intents.map((it) => VisualAdapter.render(it)).join('\n')
+
+					const categoryPath = this.getCategory ? this.getCategory(compName) : 'Components'
+					const outPath = `${this.snapshotsDir}/${lang}/${categoryPath}/${compName}`
+
+					if (!galleryTree[lang][categoryPath]) galleryTree[lang][categoryPath] = {}
+					if (!galleryTree[lang][categoryPath][compName])
+						galleryTree[lang][categoryPath][compName] = { score: 100, errors: [] }
+
+					const filePath = `${outPath}/${safeVarName}.nan0`
+					await this.db.saveDocument(filePath, snapshot)
+
+					yield show(t(SnapshotRunner.UI.generating, { lang, comp: `${compName}/${safeVarName}` }))
+					variationsData.push({ safeVarName, snapshot })
+
+					// Instant Audit
+					const audit = SnapshotAuditor.inspectText(snapshot, lang, filePath, t)
+					if (audit.score < 100) {
+						galleryTree[lang][categoryPath][compName].score = Math.min(
+							galleryTree[lang][categoryPath][compName].score,
+							audit.score,
+						)
+						galleryTree[lang][categoryPath][compName].errors.push(...audit.errors)
+						globalErrors += audit.errors.length
+						yield show(
+							t(SnapshotRunner.UI.auditFailed, {
+								file: filePath,
+								errors: audit.errors.join('; '),
+							}),
+							'error',
+						)
+					}
+					globalCount++
+				}
+
+				// Generate index.md for component
+				if (variationsData.length > 0) {
+					const categoryPath = this.getCategory ? this.getCategory(compName) : 'Components'
+					const outPath = `${this.snapshotsDir}/${lang}/${categoryPath}/${compName}`
+					const desc = t(SnapshotRunner.UI.galleryDescription, undefined)
+
+					const backPrefix = t(SnapshotRunner.UI.backLink, { text: t(SnapshotRunner.UI.backText, undefined) })
+					let markdown = `${backPrefix}\n\n# ${compName}\n\n> ${desc}\n\n`
+					for (const { safeVarName, snapshot } of variationsData) {
+						markdown += `## ${safeVarName}\n\n\`\`\`yaml\n${snapshot}\n\`\`\`\n\n`
+					}
+					await this.db.saveDocument(`${outPath}/index.md`, markdown)
+				}
+			}
+		}
+
+		// Generate top-level indexes
+		let rootMd = t(SnapshotRunner.UI.rootGallery, { count: globalCount, errors: globalErrors })
+
+		for (const lang of Object.keys(galleryTree)) {
+			const langTitle = langsIndex[lang] || lang
+			rootMd += `- [${langTitle}](./${lang}/index.md) — ${t(SnapshotRunner.UI.galleryDescription, undefined)}\n`
+
+			const backPrefix = t(SnapshotRunner.UI.backLink, { text: t(SnapshotRunner.UI.backText, undefined) })
+			let langMd = `${backPrefix}\n\n# ${t(SnapshotRunner.UI.localeTitle, {
+				title: langTitle,
+			})}\n\n`
+
+			for (const category of Object.keys(galleryTree[lang])) {
+				langMd += `## [${category}](./${category}/index.md)\n\n`
+
+				const backPrefix = t(SnapshotRunner.UI.backLink, { text: t(SnapshotRunner.UI.backText, undefined) })
+				let catMd = `${backPrefix}\n\n# ${t(SnapshotRunner.UI.categoryTitle, {
+					title: category,
+				})}\n\n`
+
+				for (const compName of Object.keys(galleryTree[lang][category])) {
+					const compData = galleryTree[lang][category][compName]
+					const status = compData.score === 100 ? '✅' : '❌'
+
+					langMd += `- [${compName}](./${category}/${compName}/index.md) ${status}\n`
+					catMd += `- [${compName}](./${compName}/index.md) ${status}\n`
+					if (compData.errors.length) {
+						catMd += `  - ${compData.errors.join('\\n  - ')}\n`
+					}
+				}
+				langMd += '\n'
+
+				const catDir = `${this.snapshotsDir}/${lang}/${category}`
+				await this.db.saveDocument(`${catDir}/index.md`, catMd)
+			}
+
+			const langDir = `${this.snapshotsDir}/${lang}`
+			await this.db.saveDocument(`${langDir}/index.md`, langMd)
+		}
+
+		await this.db.saveDocument(`${this.snapshotsDir}/index.md`, rootMd)
+		return result({ success: globalErrors === 0, count: globalCount, errors: globalErrors })
+	}
+}
+
+export default SnapshotRunner