@verekia/warden 0.0.1 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verekia/warden",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Linter that checks repositories share consistent configs and tool versions.",
   "bin": {
     "warden": "./src/index.ts"
@@ -37,71 +37,11 @@
       "../svg-to-tsl"
     ],
     "checks": {
-      "configFilesPresent": {
-        "enabled": true,
-        "files": [
-          ".oxfmtrc.json",
-          ".oxlintrc.json",
-          ".github/workflows/ci.yml"
-        ]
-      },
-      "matchingDependencyVersions": {
-        "enabled": true,
-        "packages": [
-          "oxfmt",
-          "oxlint"
-        ]
-      },
-      "exactDependencyVersions": {
-        "enabled": true,
-        "packages": {
-          "oxfmt": "0.48.0",
-          "oxlint": "1.63.0"
-        }
-      },
-      "requiredScripts": {
-        "enabled": true,
-        "scripts": {
-          "format": "oxfmt .",
-          "format:check": "oxfmt --check .",
-          "lint": "oxlint .",
-          "lint:fix": "oxlint --fix ."
-        }
-      },
       "typecheckScript": {
-        "enabled": true,
         "modes": {
+          "gputex": "bun-filter-all",
           "nanothree": "bun-filter-all"
         }
-      },
-      "testScriptConsistency": {
-        "enabled": true,
-        "testFilePattern": "**/*.test.{ts,tsx,js,jsx}",
-        "testScript": "bun test",
-        "allWithoutTests": "bun run format:check && bun run lint && bun run typecheck && bun run warden",
-        "allWithTests": "bun run format:check && bun run lint && bun run typecheck && bun run warden && bun run test"
-      },
-      "tailwindOxfmtConfig": {
-        "enabled": true
-      },
-      "portlessNextDev": {
-        "enabled": true,
-        "version": "0.13.0"
-      },
-      "nextConfig": {
-        "enabled": true,
-        "options": {
-          "reactStrictMode": true,
-          "reactCompiler": true,
-          "output": "export"
-        },
-        "devDependencies": {
-          "babel-plugin-react-compiler": "1.0.0"
-        }
-      },
-      "wardenScript": {
-        "enabled": true,
-        "package": "@verekia/warden"
       }
     }
   }

package/src/checks/ci-workflow.ts

@@ -0,0 +1,58 @@
+import type { CheckResult, Project, WardenConfig } from '../types.ts'
+
+type Step = { run?: unknown }
+type Job = { steps?: unknown }
+type Workflow = { jobs?: Record<string, unknown> }
+
+const DEFAULT_FILE = '.github/workflows/ci.yml'
+const DEFAULT_RUNS = 'bun run all'
+
+const collectRunCommands = (workflow: Workflow): string[] => {
+  const commands: string[] = []
+  for (const job of Object.values(workflow.jobs ?? {})) {
+    const steps = (job as Job)?.steps
+    if (!Array.isArray(steps)) continue
+    for (const step of steps as Step[]) {
+      if (typeof step?.run === 'string') commands.push(step.run)
+    }
+  }
+  return commands
+}
+
+export const ciWorkflow = async (
+  projects: Project[],
+  options: NonNullable<NonNullable<WardenConfig['checks']>['ciWorkflow']>,
+): Promise<CheckResult> => {
+  const messages: string[] = []
+  let passed = true
+
+  const file = options.file ?? DEFAULT_FILE
+  const runs = options.runs ?? DEFAULT_RUNS
+
+  for (const project of projects) {
+    const handle = Bun.file(`${project.path}/${file}`)
+    if (!(await handle.exists())) {
+      passed = false
+      messages.push(`${project.name}: missing ${file}`)
+      continue
+    }
+    if (!runs) continue
+
+    let workflow: Workflow
+    try {
+      workflow = Bun.YAML.parse(await handle.text()) as Workflow
+    } catch (err) {
+      passed = false
+      messages.push(`${project.name}: ${file} is not valid YAML (${(err as Error).message})`)
+      continue
+    }
+
+    const commands = collectRunCommands(workflow)
+    if (!commands.some(cmd => cmd.includes(runs))) {
+      passed = false
+      messages.push(`${project.name}: ${file} has no step running ${JSON.stringify(runs)}`)
+    }
+  }
+
+  return { name: 'ciWorkflow', passed, messages }
+}

package/src/checks/config-files-present.ts

@@ -1,5 +1,7 @@
 import type { CheckResult, Project, WardenConfig } from '../types.ts'
 
+const DEFAULT_FILES = ['.oxfmtrc.json', '.oxlintrc.json']
+
 export const configFilesPresent = async (
   projects: Project[],
   options: NonNullable<NonNullable<WardenConfig['checks']>['configFilesPresent']>,
@@ -7,7 +9,7 @@ export const configFilesPresent = async (
   const messages: string[] = []
   let passed = true
 
-  const files = options.files ?? []
+  const files = options.files ?? DEFAULT_FILES
   for (const project of projects) {
     for (const file of files) {
       const exists = await Bun.file(`${project.path}/${file}`).exists()

package/src/checks/exact-dependency-versions.ts

@@ -5,6 +5,11 @@ const findVersion = (pkg: PackageJson, name: string): string | undefined =>
 
 const EXACT_SEMVER = /^\d+\.\d+\.\d+(?:-[\w.-]+)?(?:\+[\w.-]+)?$/
 
+const DEFAULT_PACKAGES: Record<string, string> = {
+  oxfmt: '0.48.0',
+  oxlint: '1.63.0',
+}
+
 export const exactDependencyVersions = (
   projects: Project[],
   options: NonNullable<NonNullable<WardenConfig['checks']>['exactDependencyVersions']>,
@@ -12,7 +17,7 @@ export const exactDependencyVersions = (
   const messages: string[] = []
   let passed = true
 
-  const packages = Object.entries(options.packages ?? {})
+  const packages = Object.entries(options.packages ?? DEFAULT_PACKAGES)
   if (packages.length === 0) {
     return { name: 'exactDependencyVersions', passed, messages }
   }

package/src/checks/matching-dependency-versions.ts

@@ -3,6 +3,8 @@ import type { CheckResult, PackageJson, Project, WardenConfig } from '../types.t
 const findVersion = (pkg: PackageJson, name: string): string | undefined =>
   pkg.dependencies?.[name] ?? pkg.devDependencies?.[name] ?? pkg.peerDependencies?.[name]
 
+const DEFAULT_PACKAGES = ['oxfmt', 'oxlint']
+
 export const matchingDependencyVersions = (
   projects: Project[],
   options: NonNullable<NonNullable<WardenConfig['checks']>['matchingDependencyVersions']>,
@@ -10,7 +12,7 @@ export const matchingDependencyVersions = (
   const messages: string[] = []
   let passed = true
 
-  for (const packageName of options.packages ?? []) {
+  for (const packageName of options.packages ?? DEFAULT_PACKAGES) {
     const versionToProjects = new Map<string, string[]>()
     const missing: string[] = []
 

package/src/checks/next-config.ts

@@ -6,6 +6,15 @@ import type { CheckResult, PackageJson, Project, WardenConfig } from '../types.t
 const NEXT = 'next'
 const CONFIG_VARIANTS = ['next.config.js', 'next.config.mjs', 'next.config.ts', 'next.config.cjs'] as const
 
+const DEFAULT_OPTIONS: Record<string, unknown> = {
+  reactStrictMode: true,
+  reactCompiler: true,
+  output: 'export',
+}
+const DEFAULT_DEV_DEPENDENCIES: Record<string, string> = {
+  'babel-plugin-react-compiler': '1.0.0',
+}
+
 type WorkspaceField = string[] | { packages?: string[] } | undefined
 
 const dependsOnNext = (pkg: PackageJson): boolean =>
@@ -106,7 +115,7 @@ export const nextConfig = async (
         }
 
         if (cfg) {
-          for (const [key, expected] of Object.entries(options.options ?? {})) {
+          for (const [key, expected] of Object.entries(options.options ?? DEFAULT_OPTIONS)) {
             if (!equal(cfg[key], expected)) {
               passed = false
               const actual = key in cfg ? JSON.stringify(cfg[key]) : 'missing'
@@ -118,7 +127,7 @@ export const nextConfig = async (
         }
       }
 
-      for (const [name, expected] of Object.entries(options.devDependencies ?? {})) {
+      for (const [name, expected] of Object.entries(options.devDependencies ?? DEFAULT_DEV_DEPENDENCIES)) {
         const declared = pkg.devDependencies?.[name]
         if (declared !== expected) {
           const actual = declared === undefined ? 'missing' : JSON.stringify(declared)

package/src/checks/portless-next-dev.ts

@@ -5,6 +5,7 @@ import type { CheckResult, PackageJson, Project, WardenConfig } from '../types.t
 
 const NEXT_DEV_RE = /\bnext dev\b/
 const PORTLESS_WRAP_RE = /\bportless\s+\S+\s+next dev\b/
+const DEFAULT_VERSION = '0.13.0'
 
 type WorkspaceField = string[] | { packages?: string[] } | undefined
 
@@ -66,13 +67,14 @@ export const portlessNextDev = async (
         }
       }
 
-      if (usesNextDev && options.version !== undefined) {
+      if (usesNextDev) {
+        const expectedVersion = options.version ?? DEFAULT_VERSION
         const declared = pkg.devDependencies?.portless
-        if (declared !== options.version) {
+        if (declared !== expectedVersion) {
           const actual = declared === undefined ? 'missing' : JSON.stringify(declared)
           passed = false
           messages.push(
-            `${project.name}/${relPath}: uses "next dev" but devDependencies.portless is ${actual} — expected exact "${options.version}" (must be declared in this package.json)`,
+            `${project.name}/${relPath}: uses "next dev" but devDependencies.portless is ${actual} — expected exact "${expectedVersion}" (must be declared in this package.json)`,
           )
         }
       }

package/src/checks/required-scripts.ts

@@ -1,5 +1,12 @@
 import type { CheckResult, Project, WardenConfig } from '../types.ts'
 
+const DEFAULT_SCRIPTS: Record<string, string> = {
+  format: 'oxfmt .',
+  'format:check': 'oxfmt --check .',
+  lint: 'oxlint .',
+  'lint:fix': 'oxlint --fix .',
+}
+
 export const requiredScripts = (
   projects: Project[],
   options: NonNullable<NonNullable<WardenConfig['checks']>['requiredScripts']>,
@@ -7,7 +14,7 @@ export const requiredScripts = (
   const messages: string[] = []
   let passed = true
 
-  const required = Object.entries(options.scripts ?? {})
+  const required = Object.entries(options.scripts ?? DEFAULT_SCRIPTS)
   if (required.length === 0) {
     return { name: 'requiredScripts', passed, messages }
   }

package/src/checks/test-script-consistency.ts

@@ -13,6 +13,9 @@ const projectHasTests = async (projectPath: string, pattern: string): Promise<bo
 
 const DEFAULT_TEST_FILE_PATTERN = '**/*.test.{ts,tsx,js,jsx}'
 const DEFAULT_TEST_SCRIPT = 'bun test'
+const DEFAULT_ALL_WITHOUT_TESTS = 'bun run format:check && bun run lint && bun run typecheck && bun run warden'
+const DEFAULT_ALL_WITH_TESTS =
+  'bun run format:check && bun run lint && bun run typecheck && bun run warden && bun run test'
 
 export const testScriptConsistency = async (
   projects: Project[],
@@ -23,6 +26,8 @@ export const testScriptConsistency = async (
 
   const testFilePattern = options.testFilePattern ?? DEFAULT_TEST_FILE_PATTERN
   const testScript = options.testScript ?? DEFAULT_TEST_SCRIPT
+  const allWithTests = options.allWithTests ?? DEFAULT_ALL_WITH_TESTS
+  const allWithoutTests = options.allWithoutTests ?? DEFAULT_ALL_WITHOUT_TESTS
 
   for (const project of projects) {
     const scripts = project.packageJson?.scripts ?? {}
@@ -35,17 +40,17 @@ export const testScriptConsistency = async (
           `${project.name}: has test files but "test" script is ${JSON.stringify(scripts.test)}, expected ${JSON.stringify(testScript)}`,
         )
       }
-      if (options.allWithTests !== undefined && scripts.all !== options.allWithTests) {
+      if (scripts.all !== allWithTests) {
         passed = false
         messages.push(
-          `${project.name}: "all" is ${JSON.stringify(scripts.all)}, expected ${JSON.stringify(options.allWithTests)} (project has tests)`,
+          `${project.name}: "all" is ${JSON.stringify(scripts.all)}, expected ${JSON.stringify(allWithTests)} (project has tests)`,
         )
       }
     } else {
-      if (options.allWithoutTests !== undefined && scripts.all !== options.allWithoutTests) {
+      if (scripts.all !== allWithoutTests) {
         passed = false
         messages.push(
-          `${project.name}: "all" is ${JSON.stringify(scripts.all)}, expected ${JSON.stringify(options.allWithoutTests)} (no tests detected)`,
+          `${project.name}: "all" is ${JSON.stringify(scripts.all)}, expected ${JSON.stringify(allWithoutTests)} (no tests detected)`,
         )
       }
     }

package/src/index.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env bun
 import { existsSync } from 'node:fs'
 
+import { ciWorkflow } from './checks/ci-workflow.ts'
 import { configFilesPresent } from './checks/config-files-present.ts'
 import { exactDependencyVersions } from './checks/exact-dependency-versions.ts'
 import { matchingDependencyVersions } from './checks/matching-dependency-versions.ts'
@@ -79,6 +80,9 @@ if (enabled(checks.nextConfig)) {
 if (enabled(checks.wardenScript)) {
   results.push(wardenScript(projects, checks.wardenScript ?? {}))
 }
+if (enabled(checks.ciWorkflow)) {
+  results.push(await ciWorkflow(projects, checks.ciWorkflow ?? {}))
+}
 
 for (const result of results) {
   const tag = result.passed ? '[PASS]' : '[FAIL]'

package/src/types.ts

@@ -21,6 +21,7 @@ export type WardenConfig = {
       devDependencies?: Record<string, string>
     }
     wardenScript?: { enabled?: boolean; package?: string }
+    ciWorkflow?: { enabled?: boolean; file?: string; runs?: string }
   }
 }