@verekia/warden 0.0.1 → 0.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verekia/warden",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Linter that checks repositories share consistent configs and tool versions.",
   "bin": {
     "warden": "./src/index.ts"
@@ -41,8 +41,7 @@
         "enabled": true,
         "files": [
           ".oxfmtrc.json",
-          ".oxlintrc.json",
-          ".github/workflows/ci.yml"
+          ".oxlintrc.json"
         ]
       },
       "matchingDependencyVersions": {
@@ -102,6 +101,11 @@
       "wardenScript": {
         "enabled": true,
         "package": "@verekia/warden"
+      },
+      "ciWorkflow": {
+        "enabled": true,
+        "file": ".github/workflows/ci.yml",
+        "runs": "bun run all"
       }
     }
   }

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/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 }
   }
 }