@reddoorla/maintenance 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { S as Site, a as AuditResult, A as AuditName, b as RecipeResult, R as RecipeName, I as InventoryProvider } from './sync-configs-7XIzzN_L.js';
-export { C as ConfigName, c as SyncConfigsOptions, s as syncConfigs } from './sync-configs-7XIzzN_L.js';
+import { S as Site, a as AuditResult, A as AuditName, b as RecipeResult, R as RecipeName, I as InventoryProvider } from './sync-configs-D_Dm-68_.js';
+export { C as ConfigName, c as SyncConfigsOptions, s as syncConfigs } from './sync-configs-D_Dm-68_.js';
 
 type SpawnResult = {
     code: number;
@@ -56,6 +56,17 @@ type ConvertToPnpmOptions = {
 };
 declare function convertToPnpm(site: Site, opts?: ConvertToPnpmOptions): Promise<RecipeResult>;
 
+type OnboardAudit = "lighthouse" | "a11y";
+type OnboardOptions = {
+    spawn?: SpawnFn;
+    /** Which audit-related deps to ensure. Defaults to all known audits. */
+    audits?: OnboardAudit[];
+    /** Version range to pin for @reddoorla/maintenance. Defaults to the
+     *  current minor range. Update on each minor bump. */
+    packageVersion?: string;
+};
+declare function onboard(site: Site, opts?: OnboardOptions): Promise<RecipeResult>;
+
 declare const ALL_RECIPE_NAMES: RecipeName[];
 declare function isRecipeName(value: string): value is RecipeName;
 
@@ -66,4 +77,4 @@ declare function localPath(path: string, opts?: LocalPathOptions): InventoryProv
 
 declare function fromJsonFile(path: string): InventoryProvider;
 
-export { ALL_AUDIT_NAMES, ALL_RECIPE_NAMES, AuditName, AuditResult, type BumpDepsOptions, type ConvertToPnpmOptions, InventoryProvider, type LocalPathOptions, RecipeName, RecipeResult, Site, type UpgradeSvelte4to5Options, a11yAudit, bumpDeps, convertToPnpm, depsAudit, fromJsonFile, isRecipeName, lighthouseAudit, lintAudit, localPath, runAudits, runAuditsAcross, securityAudit, upgradeSvelte4to5 };
+export { ALL_AUDIT_NAMES, ALL_RECIPE_NAMES, AuditName, AuditResult, type BumpDepsOptions, type ConvertToPnpmOptions, InventoryProvider, type LocalPathOptions, type OnboardAudit, type OnboardOptions, RecipeName, RecipeResult, Site, type UpgradeSvelte4to5Options, a11yAudit, bumpDeps, convertToPnpm, depsAudit, fromJsonFile, isRecipeName, lighthouseAudit, lintAudit, localPath, onboard, runAudits, runAuditsAcross, securityAudit, upgradeSvelte4to5 };

package/dist/index.js

@@ -1358,12 +1358,110 @@ async function convertToPnpm(site, opts = {}) {
   };
 }
 
+// src/recipes/onboard.ts
+import { stat as stat2 } from "fs/promises";
+import { join as join13 } from "path";
+var PACKAGE_NAME = "@reddoorla/maintenance";
+var DEFAULT_PACKAGE_VERSION = "^0.2.0";
+var AUDIT_DEPS = {
+  lighthouse: [{ name: "@lhci/cli", version: "^0.15.1" }],
+  a11y: [
+    { name: "@playwright/test", version: "^1.59.1" },
+    { name: "@axe-core/playwright", version: "^4.11.3" }
+  ]
+};
+async function exists2(path) {
+  try {
+    await stat2(path);
+    return true;
+  } catch {
+    return false;
+  }
+}
+function siteLabel10(site) {
+  return site.name ?? site.path;
+}
+function isDeclared(pkg, name) {
+  return Boolean(pkg.dependencies?.[name] ?? pkg.devDependencies?.[name]);
+}
+async function onboard(site, opts = {}) {
+  const label = siteLabel10(site);
+  const spawn2 = opts.spawn ?? defaultSpawn;
+  const audits = opts.audits ?? ["lighthouse", "a11y"];
+  const packageVersion = opts.packageVersion ?? DEFAULT_PACKAGE_VERSION;
+  if (!await exists2(join13(site.path, "pnpm-lock.yaml"))) {
+    return {
+      recipe: "onboard",
+      site: label,
+      status: "failed",
+      commits: [],
+      notes: "no pnpm-lock.yaml at site root \u2014 run convert-to-pnpm first"
+    };
+  }
+  const pkgPath = join13(site.path, "package.json");
+  const pkg = await readPackageJson(pkgPath);
+  const toAdd = [];
+  if (!isDeclared(pkg, PACKAGE_NAME)) {
+    toAdd.push({ name: PACKAGE_NAME, version: packageVersion });
+  }
+  for (const audit of audits) {
+    for (const dep of AUDIT_DEPS[audit]) {
+      if (!isDeclared(pkg, dep.name)) toAdd.push(dep);
+    }
+  }
+  if (toAdd.length === 0) {
+    return {
+      recipe: "onboard",
+      site: label,
+      status: "noop",
+      commits: [],
+      notes: `site already has ${PACKAGE_NAME} and audit deps (${audits.join("+")})`
+    };
+  }
+  if (!await isWorkingTreeClean(site.path)) {
+    throw new Error(`refusing to run: working tree is not clean at ${site.path}`);
+  }
+  const branch = branchName("onboard");
+  await createBranch(site.path, branch);
+  let next = pkg;
+  for (const dep of toAdd) {
+    next = bumpDep(next, dep.name, dep.version);
+  }
+  await writePackageJson(pkgPath, next);
+  const installResult = await spawn2("pnpm", ["install"], {
+    cwd: site.path,
+    streaming: true
+  });
+  if (installResult.code !== 0) {
+    return {
+      recipe: "onboard",
+      site: label,
+      status: "failed",
+      commits: [],
+      notes: `pnpm install failed (exit ${installResult.code}). branch ${branch} left for inspection.`
+    };
+  }
+  const sha = await commit(
+    site.path,
+    `chore(reddoor): onboard with ${PACKAGE_NAME} ${packageVersion}`
+  );
+  const shas = sha ? [sha] : [];
+  return {
+    recipe: "onboard",
+    site: label,
+    status: "applied",
+    commits: shas,
+    notes: `branch: ${branch}. Added ${toAdd.length} dep(s): ${toAdd.map((d) => d.name).join(", ")}`
+  };
+}
+
 // src/recipes/index.ts
 var ALL_RECIPE_NAMES = [
   "sync-configs",
   "bump-deps",
   "svelte-4-to-5",
-  "convert-to-pnpm"
+  "convert-to-pnpm",
+  "onboard"
 ];
 function isRecipeName(value) {
   return ALL_RECIPE_NAMES.includes(value);
@@ -1423,6 +1521,7 @@ export {
   lighthouseAudit,
   lintAudit,
   localPath,
+  onboard,
   runAudits,
   runAuditsAcross,
   securityAudit,