| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207 |
- /**
- * Validate Cordis Loader entry metadata and example package resolution.
- *
- * The Loader interpolates only a plugin entry's `config`; expression objects in
- * fields such as `disabled` remain truthy data and silently change composition.
- * Example configs run from built packages, so every named package must resolve
- * from the examples workspace and every local package must be in the root
- * TypeScript project graph.
- */
- import { globSync, readFileSync } from 'node:fs'
- import { dirname, relative, resolve } from 'node:path'
- import * as yaml from 'js-yaml'
- import ts from 'typescript'
- interface JsExpr {
- __jsExpr: string
- }
- interface PackageManifest {
- name?: string
- dependencies?: Record<string, string>
- }
- interface PluginReference {
- file: string
- name: string
- }
- const root = resolve(import.meta.dirname, '..')
- const metadataFields = ['id', 'name', 'group', 'disabled', 'inject', 'intercept', 'isolate'] as const
- const jsExprType = new yaml.Type('tag:yaml.org,2002:js', {
- kind: 'scalar',
- resolve: data => typeof data === 'string',
- construct: (data: unknown): JsExpr => {
- if (typeof data !== 'string') throw new TypeError('!!js requires a scalar string')
- return { __jsExpr: data }
- },
- })
- const schema = yaml.JSON_SCHEMA.extend(jsExprType)
- const files = globSync(['**/*cordis*.yml', '**/*cordis*.yaml'], {
- cwd: root,
- exclude: ['.claude/**', 'node_modules/**', 'vendor/**'],
- }).sort()
- const errors: string[] = []
- const examplePluginReferences: PluginReference[] = []
- for (const file of files) {
- const document: unknown = yaml.load(readFileSync(resolve(root, file), 'utf8'), { schema })
- if (!isUnknownArray(document)) {
- errors.push(`${file}: root must be a Loader entry array`)
- continue
- }
- for (let index = 0; index < document.length; index++) {
- validateEntry(document[index], file, `[${index}]`)
- }
- }
- errors.push(...validateExampleResolution())
- if (errors.length > 0) {
- console.error('verify-cordis-config: invalid Loader metadata or example package resolution:')
- for (const error of errors) console.error(`- ${error}`)
- process.exitCode = 1
- } else {
- console.log(`verify-cordis-config: ${files.length} config files passed.`)
- }
- function validateEntry(value: unknown, file: string, path: string): void {
- if (!isRecord(value)) {
- errors.push(`${file}${path}: entry must be an object`)
- return
- }
- recordExamplePlugin(value, file)
- validateMetadata(value, file, path)
- if ((value.group === true || value.name === '@cordisjs/plugin-group') && isUnknownArray(value.config)) {
- for (let index = 0; index < value.config.length; index++) {
- validateEntry(value.config[index], file, `${path}.config[${index}]`)
- }
- }
- if (value.name !== '@cordisjs/plugin-include') return
- const config = value.config
- if (!isRecord(config) || !isUnknownArray(config.patches)) return
- for (let index = 0; index < config.patches.length; index++) {
- const patch = config.patches[index]
- const patchPath = `${path}.config.patches[${index}]`
- if (!isRecord(patch)) continue
- recordExamplePlugin(patch, file)
- validateMetadata(patch, file, patchPath)
- if (!isUnknownArray(patch.insert)) continue
- for (let insertIndex = 0; insertIndex < patch.insert.length; insertIndex++) {
- validateEntry(patch.insert[insertIndex], file, `${patchPath}.insert[${insertIndex}]`)
- }
- }
- }
- function recordExamplePlugin(entry: Record<string, unknown>, file: string): void {
- if (file.startsWith('examples/') && typeof entry.name === 'string') {
- examplePluginReferences.push({ file, name: entry.name })
- }
- }
- function validateExampleResolution(): string[] {
- const violations: string[] = []
- const exampleManifest = readManifest('examples/package.json')
- const dependencies = exampleManifest.dependencies ?? {}
- const localPackages = localPackageDirectories()
- const rootReferences = rootProjectReferences()
- const requiredPackages = new Map<string, Set<string>>()
- for (const reference of examplePluginReferences) {
- const packageName = packageNameFromSpecifier(reference.name)
- if (packageName === undefined) continue
- const locations = requiredPackages.get(packageName) ?? new Set<string>()
- locations.add(reference.file)
- requiredPackages.set(packageName, locations)
- }
- for (const [packageName, locations] of requiredPackages) {
- if (!(packageName in dependencies)) {
- violations.push(`${[...locations].join(', ')}: ${packageName} must be declared in examples/package.json dependencies`)
- }
- }
- const localExamplePackages = new Set([
- ...Object.keys(dependencies),
- ...requiredPackages.keys(),
- ])
- for (const packageName of localExamplePackages) {
- const packageDirectory = localPackages.get(packageName)
- if (packageDirectory === undefined || rootReferences.has(packageDirectory)) continue
- const repoPath = relative(root, packageDirectory).replaceAll('\\', '/')
- violations.push(`tsconfig.json: missing project reference for ${packageName} (${repoPath})`)
- }
- return violations
- }
- function readManifest(path: string): PackageManifest {
- return JSON.parse(readFileSync(resolve(root, path), 'utf8')) as PackageManifest
- }
- function localPackageDirectories(): Map<string, string> {
- const manifests = globSync(['packages/*/*/package.json', 'vendor/*/package.json'], { cwd: root })
- const packages = new Map<string, string>()
- for (const manifestPath of manifests) {
- const manifest = readManifest(manifestPath)
- if (manifest.name !== undefined) packages.set(manifest.name, resolve(root, dirname(manifestPath)))
- }
- return packages
- }
- function rootProjectReferences(): Set<string> {
- const config = ts.readConfigFile(resolve(root, 'tsconfig.json'), path => ts.sys.readFile(path))
- if (config.error !== undefined) {
- throw new Error(ts.flattenDiagnosticMessageText(config.error.messageText, '\n'))
- }
- const references = (config.config as { references?: Array<{ path?: unknown }> }).references ?? []
- return new Set(references.flatMap((reference) => {
- if (typeof reference.path !== 'string') return []
- return [resolve(root, reference.path)]
- }))
- }
- function packageNameFromSpecifier(specifier: string): string | undefined {
- if (specifier.startsWith('.') || specifier.startsWith('/') || specifier.startsWith('file:')) return undefined
- const segments = specifier.split('/')
- if (specifier.startsWith('@')) {
- return segments.length >= 2 ? `${segments[0]}/${segments[1]}` : undefined
- }
- return segments[0] || undefined
- }
- function validateMetadata(entry: Record<string, unknown>, file: string, path: string): void {
- for (const field of metadataFields) {
- if (!(field in entry)) continue
- const expressionPaths: string[] = []
- collectExpressionPaths(entry[field], `${path}.${field}`, expressionPaths)
- for (const expressionPath of expressionPaths) errors.push(`${file}${expressionPath}: !!js is not interpolated here`)
- }
- }
- function collectExpressionPaths(value: unknown, path: string, output: string[]): void {
- if (isJsExpr(value)) {
- output.push(path)
- return
- }
- if (isUnknownArray(value)) {
- for (let index = 0; index < value.length; index++) collectExpressionPaths(value[index], `${path}[${index}]`, output)
- return
- }
- if (!isRecord(value)) return
- for (const [key, child] of Object.entries(value)) collectExpressionPaths(child, `${path}.${key}`, output)
- }
- function isJsExpr(value: unknown): value is JsExpr {
- return isRecord(value) && typeof value.__jsExpr === 'string'
- }
- function isRecord(value: unknown): value is Record<string, unknown> {
- return value !== null && typeof value === 'object'
- }
- function isUnknownArray(value: unknown): value is unknown[] {
- return Array.isArray(value)
- }
|