check-workspace-constraints.ts 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. /**
  2. * Workspace package invariant checks for package-manager-independent quality
  3. * gates.
  4. *
  5. * Run: `tsx scripts/check-workspace-constraints.ts`.
  6. */
  7. import { existsSync, readdirSync, readFileSync } from 'node:fs'
  8. import { join, relative, resolve } from 'node:path'
  9. const root = resolve(import.meta.dirname, '..')
  10. // vendor/* is single-level; packages/<group>/<pkg> nests one level deeper
  11. // (the group dirs — core/llm/bash/… — are pure containers with no manifest).
  12. const workspaceGlobs = [
  13. { dir: 'vendor', depth: 1 },
  14. { dir: 'packages', depth: 2 },
  15. ] as const
  16. const vendoredPackages = new Set([
  17. 'cordis',
  18. 'cosmokit',
  19. 'schemastery',
  20. '@cordisjs/plugin-loader',
  21. '@cordisjs/plugin-include',
  22. '@cordisjs/plugin-group',
  23. '@cordisjs/plugin-timer',
  24. '@cordisjs/plugin-hmr',
  25. '@cordisjs/plugin-logger-console',
  26. ])
  27. /** The subset of package.json fields this constraint check cares about. */
  28. interface PackageManifest {
  29. name?: string
  30. version?: string
  31. private?: boolean
  32. type?: string
  33. peerDependencies?: Record<string, string>
  34. devDependencies?: Record<string, string>
  35. }
  36. /** One workspace manifest and its repo-relative path. */
  37. interface WorkspaceManifest {
  38. dir: string
  39. manifest: PackageManifest
  40. }
  41. function readJson(path: string): PackageManifest {
  42. return JSON.parse(readFileSync(path, 'utf8')) as PackageManifest
  43. }
  44. /** Repo-relative dirs holding a package.json, walked to the configured depth. */
  45. function packageDirs(base: string, depth: number): string[] {
  46. if (depth === 1) {
  47. return readdirSync(join(root, base), { withFileTypes: true })
  48. .filter(entry => entry.isDirectory())
  49. .map(entry => join(base, entry.name))
  50. }
  51. return readdirSync(join(root, base), { withFileTypes: true })
  52. .filter(entry => entry.isDirectory())
  53. .flatMap(group => packageDirs(join(base, group.name), depth - 1))
  54. }
  55. function workspaceManifests(): WorkspaceManifest[] {
  56. const manifests: WorkspaceManifest[] = [
  57. { dir: '.', manifest: readJson(join(root, 'package.json')) },
  58. ]
  59. for (const { dir: base, depth } of workspaceGlobs) {
  60. for (const dir of packageDirs(base, depth)) {
  61. manifests.push({ dir, manifest: readJson(join(root, dir, 'package.json')) })
  62. }
  63. }
  64. return manifests
  65. }
  66. function checkWorkspace({ dir, manifest }: WorkspaceManifest): string[] {
  67. const errors: string[] = []
  68. const label = manifest.name ?? dir
  69. if (manifest.private !== true) {
  70. errors.push(`${label}: package.json must set "private": true`)
  71. }
  72. if (manifest.name && vendoredPackages.has(manifest.name)) {
  73. return errors
  74. }
  75. if (manifest.name?.startsWith('@deepseek-ai/dsh-') && manifest.name !== '@deepseek-ai/dsh-root') {
  76. const peer = manifest.peerDependencies?.cordis
  77. const dev = manifest.devDependencies?.cordis
  78. if (!peer) errors.push(`${label}: cordis must be a peerDependency`)
  79. if (!dev) errors.push(`${label}: cordis must also be a devDependency`)
  80. if (peer && dev && peer !== dev) {
  81. errors.push(`${label}: cordis peer (${peer}) and dev (${dev}) ranges must match`)
  82. }
  83. if (manifest.version !== '0.0.1') {
  84. errors.push(`${label}: package.json must set "version": "0.0.1"`)
  85. }
  86. if (manifest.type !== 'module') {
  87. errors.push(`${label}: package.json must set "type": "module"`)
  88. }
  89. }
  90. return errors.map(error => `${relative(root, join(root, dir, 'package.json'))}: ${error}`)
  91. }
  92. /**
  93. * Enforce the packages/ hierarchy SHAPE: every package lives at exactly
  94. * `packages/<group>/<pkg>`. A group dir is a pure container — it holds packages,
  95. * never sources of its own — so it must NOT carry a package.json, and a package
  96. * must NOT sit directly at the `packages/` root (the old flat layout) nor nest a
  97. * level deeper. The group NAMES are open on purpose: a new group may be added
  98. * without touching this gate, but the depth-2 shape is fixed. This is what keeps
  99. * a stray flat package or an over-nested one from regressing the hierarchy.
  100. */
  101. function checkHierarchyShape(): string[] {
  102. const errors: string[] = []
  103. const packagesRoot = join(root, 'packages')
  104. for (const group of readdirSync(packagesRoot, { withFileTypes: true })) {
  105. if (!group.isDirectory()) continue
  106. const groupRel = join('packages', group.name)
  107. if (existsSync(join(packagesRoot, group.name, 'package.json'))) {
  108. errors.push(`${groupRel}: a group dir must not contain a package.json — packages live at packages/<group>/<pkg>, not directly under packages/`)
  109. continue
  110. }
  111. for (const pkg of readdirSync(join(packagesRoot, group.name), { withFileTypes: true })) {
  112. if (!pkg.isDirectory()) continue
  113. const pkgRel = join(groupRel, pkg.name)
  114. if (!existsSync(join(packagesRoot, group.name, pkg.name, 'package.json'))) {
  115. errors.push(`${pkgRel}: expected a package here (no package.json found) — the hierarchy is exactly packages/<group>/<pkg>, no deeper nesting`)
  116. }
  117. }
  118. }
  119. return errors
  120. }
  121. const errors = [...workspaceManifests().flatMap(checkWorkspace), ...checkHierarchyShape()]
  122. if (errors.length > 0) {
  123. console.error(errors.join('\n'))
  124. process.exitCode = 1
  125. }