@empline/preflight 1.0.20

package/templates/new-check.ts.template

@@ -0,0 +1,205 @@
+#!/usr/bin/env tsx
+/**
+ * Preflight: [CHECK_NAME]
+ *
+ * [DESCRIPTION]
+ *
+ * How it works:
+ * - [STEP 1]
+ * - [STEP 2]
+ * - [STEP 3]
+ */
+
+import fs from "node:fs";
+import path from "node:path";
+import { glob } from "glob";
+import {
+  PreflightCheckResult,
+  PreflightFinding,
+  STANDARD_EXCLUDES,
+  emoji,
+  writeFindings,
+  createFinding,
+} from "@empline/preflight";
+
+// ============================================================================
+// CHECK METADATA
+// ============================================================================
+
+/** Unique identifier for this check */
+export const id = "[CATEGORY]/[CHECK_ID]";
+
+/** Display name for this check */
+export const name = "[CHECK_NAME]";
+
+/** Category for filtering */
+export const category = "[CATEGORY]";
+
+/** Whether failures block deployment */
+export const blocking = true;
+
+/** Description of what this check validates */
+export const description = "[DESCRIPTION]";
+
+/** Tags for additional filtering */
+export const tags = ["[TAG1]", "[TAG2]"];
+
+/** Whether this check should only run in CI */
+export const ciOnly = false;
+
+// ============================================================================
+// CONFIGURATION
+// ============================================================================
+
+const CONFIG = {
+  /** File pattern to scan */
+  pattern: "**/*.{ts,tsx}",
+
+  /** Files to exclude */
+  exclude: [
+    ...STANDARD_EXCLUDES,
+    // Add check-specific exclusions here
+  ],
+
+  /** Example: patterns to detect */
+  // badPatterns: [
+  //   /somePattern/,
+  // ],
+};
+
+// ============================================================================
+// DETECTION LOGIC
+// ============================================================================
+
+interface Finding {
+  file: string;
+  line: number;
+  column?: number;
+  message: string;
+  severity: "error" | "warning";
+}
+
+function scanFile(filePath: string): Finding[] {
+  const findings: Finding[] = [];
+  const content = fs.readFileSync(filePath, "utf8");
+  const lines = content.split("\n");
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+
+    // TODO: Implement your detection logic here
+    // Example:
+    // if (line.includes("somePattern")) {
+    //   findings.push({
+    //     file: filePath,
+    //     line: i + 1,
+    //     message: "Found problematic pattern",
+    //     severity: "error",
+    //   });
+    // }
+  }
+
+  return findings;
+}
+
+// ============================================================================
+// MAIN RUN FUNCTION
+// ============================================================================
+
+export async function run(): Promise<PreflightCheckResult> {
+  const startTime = Date.now();
+  const findings: PreflightFinding[] = [];
+  let filesScanned = 0;
+
+  console.log(`${emoji.search} ${name}`);
+  console.log(`  Scanning for issues...`);
+
+  // Get files to scan
+  const files = await glob(CONFIG.pattern, {
+    nodir: true,
+    ignore: CONFIG.exclude,
+    windowsPathsNoEscape: true,
+  });
+
+  filesScanned = files.length;
+
+  // Scan each file
+  for (const file of files) {
+    try {
+      const fileFindings = scanFile(file);
+
+      for (const f of fileFindings) {
+        findings.push({
+          message: f.message,
+          level: f.severity,
+          file: f.file.replace(/\\/g, "/"),
+          startLine: f.line,
+          startColumn: f.column,
+          code: id,
+        });
+      }
+    } catch (error) {
+      // Log but don't fail on unreadable files
+      console.warn(`  Warning: Could not read ${file}`);
+    }
+  }
+
+  // Write findings for report aggregation
+  writeFindings(
+    findings.map((f) => ({
+      message: f.message,
+      severity: f.level === "error" ? "error" : "warning",
+      file: f.file,
+      range: f.startLine
+        ? {
+            startLine: f.startLine,
+            startColumn: f.startColumn,
+          }
+        : undefined,
+      code: id,
+    })),
+  );
+
+  const duration = Date.now() - startTime;
+  const errors = findings.filter((f) => f.level === "error");
+  const warnings = findings.filter((f) => f.level === "warning");
+
+  // Print summary
+  if (findings.length === 0) {
+    console.log(`${emoji.success} ${name}: No issues found`);
+  } else {
+    console.log(`${emoji.warning} ${name}: Found ${findings.length} issues`);
+
+    if (errors.length > 0) {
+      console.log(`  ${emoji.error} Errors: ${errors.length}`);
+      for (const f of errors.slice(0, 5)) {
+        console.log(`    - ${f.file}:${f.startLine}: ${f.message}`);
+      }
+    }
+
+    if (warnings.length > 0) {
+      console.log(`  ${emoji.warning} Warnings: ${warnings.length}`);
+    }
+  }
+
+  return {
+    passed: errors.length === 0,
+    findings,
+    duration,
+    metadata: {
+      filesScanned,
+      errorsFound: errors.length,
+      warningsFound: warnings.length,
+    },
+  };
+}
+
+// ============================================================================
+// DIRECT EXECUTION
+// ============================================================================
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  run().then((result) => {
+    process.exit(result.passed ? 0 : 1);
+  });
+}

package/templates/preflight.config.ts.template

@@ -0,0 +1,103 @@
+/**
+ * Preflight Configuration
+ *
+ * This file configures which preflight checks run for your application.
+ * Place this file in your app root (next to package.json).
+ *
+ * The preflight system will:
+ * 1. Load this configuration
+ * 2. Run core checks from @empline/preflight
+ * 3. Discover and run app-specific checks from scripts/active/preflights/
+ */
+
+import type { AppConfig } from "@empline/preflight";
+
+const config: AppConfig = {
+  /**
+   * App identifier (optional - inferred from directory name if not set)
+   */
+  appName: "my-app",
+
+  /**
+   * Categories to run (empty = run all)
+   *
+   * Available categories:
+   * - typescript: TypeScript compilation and syntax validation
+   * - runtime: Runtime safety, env usage, hydration, error handling
+   * - security: Security checks: auth, XSS, injection, secrets
+   * - database: Database schema, Prisma, migrations
+   * - ui: UI components, spacing, accessibility, responsiveness
+   * - quality: Code quality, imports, dead code detection
+   * - performance: Bundle size, images, lazy loading, Core Web Vitals
+   * - testing: E2E tests, coverage, regression testing
+   * - organization: File organization, naming conventions, route structure
+   * - business: Business logic: pricing, inventory, orders
+   * - hardened: Iron-clad rules: DRAFT status, secrets, hooks
+   * - framework: Framework compatibility: Next.js, React, Prisma
+   */
+  categories: [],
+
+  /**
+   * Categories to always skip
+   */
+  excludeCategories: [],
+
+  /**
+   * Specific check IDs to skip
+   * Use this to disable checks that don't apply to your app
+   */
+  excludeChecks: [
+    // "security/env-value-leakage",
+    // "business/price-calculation-validation",
+  ],
+
+  /**
+   * Specific check IDs to always include (even if category is excluded)
+   */
+  includeChecks: [],
+
+  /**
+   * Directory containing app-specific preflights (relative to this file)
+   * Default: "scripts/active/preflights"
+   */
+  pluginDir: "scripts/active/preflights",
+
+  /**
+   * Custom category definitions for this app
+   * These extend the built-in categories
+   */
+  customCategories: {
+    // Example: Add a custom category for trading cards
+    // "trading-cards": {
+    //   pattern: "Card|TCG|Grading|Catalog",
+    //   description: "Trading card specific validations",
+    // },
+  },
+
+  /**
+   * Respect ciOnly flag on checks
+   * When true, checks marked ciOnly won't run locally
+   */
+  respectCiOnly: true,
+
+  /**
+   * Default timeout for checks in milliseconds
+   */
+  defaultTimeout: 30000,
+
+  /**
+   * Maximum concurrent checks when running in parallel
+   */
+  concurrency: 4,
+
+  /**
+   * Output paths for reports
+   */
+  output: {
+    json: ".preflight/report.json",
+    sarif: ".preflight/report.sarif",
+    // junit: ".preflight/report.xml",
+  },
+};
+
+export default config;