infra-kit 0.1.97 → 0.1.99

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "infra-kit",
   "type": "module",
-  "version": "0.1.97",
+  "version": "0.1.99",
   "description": "infra-kit",
   "main": "dist/cli.js",
   "module": "dist/cli.js",

package/src/commands/config/config.ts

@@ -0,0 +1,125 @@
+import fs from 'node:fs/promises'
+import os from 'node:os'
+import path from 'node:path'
+import process from 'node:process'
+import { $ } from 'zx'
+
+import { getInfraKitConfigPaths, resetInfraKitConfigCache } from 'src/lib/infra-kit-config'
+import { logger } from 'src/lib/logger'
+import type { ToolsExecutionResult } from 'src/types'
+
+/**
+ * Resolve whether a file is reachable, suppressing ENOENT into a boolean.
+ *
+ * @example
+ * await fileExists('/etc/hosts')   // => true
+ * await fileExists('/nope.txt')    // => false
+ */
+const fileExists = async (filePath: string): Promise<boolean> => {
+  try {
+    await fs.access(filePath)
+
+    return true
+  } catch {
+    return false
+  }
+}
+
+/**
+ * Replace the user's home prefix with `~` so logged paths stay short and
+ * portable across machines. Leaves non-home paths untouched.
+ *
+ * @example
+ * // os.homedir() === '/Users/arthur'
+ * tildify('/Users/arthur/.infra-kit/config.yml') // => '~/.infra-kit/config.yml'
+ * tildify('/etc/hosts')                          // => '/etc/hosts'
+ */
+const tildify = (filePath: string): string => {
+  const home = os.homedir()
+
+  return filePath.startsWith(home) ? `~${filePath.slice(home.length)}` : filePath
+}
+
+/**
+ * Print the file paths that participate in the config merge chain along with
+ * existence markers, so the user can see at a glance which override layers
+ * are active.
+ *
+ * @example
+ * // CLI: `infra-kit config path`
+ * // INFO: Project name: api
+ * // INFO: Config merge chain (later overrides earlier):
+ * // INFO:   [✓] project (committed)    ~/projects/api/infra-kit.yml
+ * // INFO:   [ ] user global            ~/.infra-kit/config.yml
+ * // INFO:   [✓] user project           ~/.infra-kit/projects/api/infra-kit.yml
+ */
+export const configPath = async (): Promise<ToolsExecutionResult> => {
+  const paths = await getInfraKitConfigPaths()
+
+  const rows: { label: string; path: string; exists: boolean }[] = await Promise.all(
+    [
+      { label: 'project (committed)', path: paths.main },
+      { label: 'user global', path: paths.userGlobal },
+      { label: 'user project', path: paths.userProject },
+    ].map(async (row) => {
+      return { ...row, exists: await fileExists(row.path) }
+    }),
+  )
+
+  logger.info(`Project name: ${paths.projectName}\n`)
+  logger.info('Config merge chain (later overrides earlier):\n')
+
+  for (const row of rows) {
+    const marker = row.exists ? '  [✓]' : '  [ ]'
+
+    logger.info(`${marker} ${row.label.padEnd(22)} ${tildify(row.path)}`)
+  }
+
+  const structuredContent = {
+    projectName: paths.projectName,
+    layers: rows.map((r) => {
+      return { label: r.label, path: r.path, exists: r.exists }
+    }),
+  }
+
+  return {
+    content: [{ type: 'text', text: JSON.stringify(structuredContent, null, 2) }],
+    structuredContent,
+  }
+}
+
+/**
+ * Open the user-scope per-project override file in $EDITOR, creating the
+ * parent directory and a stub file on first use. Resets the config cache
+ * after the editor exits so subsequent reads pick up edits without a restart.
+ *
+ * @example
+ * // CLI: `infra-kit config edit`
+ * // first run — creates ~/.infra-kit/projects/api/infra-kit.yml from a stub, then $EDITOR opens it
+ * // subsequent runs — opens the existing file as-is
+ */
+export const configEdit = async (): Promise<ToolsExecutionResult> => {
+  const paths = await getInfraKitConfigPaths()
+  const editor = process.env.EDITOR || process.env.VISUAL || 'vi'
+
+  await fs.mkdir(path.dirname(paths.userProject), { recursive: true })
+
+  if (!(await fileExists(paths.userProject))) {
+    const stub = `# infra-kit user override for ${paths.projectName} — ~/.infra-kit/projects/${paths.projectName}/infra-kit.yml\n#\n# Layer 3 (highest precedence) of the config merge chain. Shallow-merged on\n# top of <repo>/infra-kit.yml and ~/.infra-kit/config.yml — top-level keys\n# (environments, envManagement, ide, taskManager, worktrees) replace wholesale.\n`
+
+    await fs.writeFile(paths.userProject, stub, 'utf-8')
+  }
+
+  logger.info(`Opening ${tildify(paths.userProject)} in ${editor}`)
+
+  await $({ stdio: 'inherit' })`${editor} ${paths.userProject}`
+
+  resetInfraKitConfigCache()
+
+  const structuredContent = { path: paths.userProject, editor }
+
+  return {
+    content: [{ type: 'text', text: JSON.stringify(structuredContent, null, 2) }],
+    structuredContent,
+  }
+}

package/src/commands/config/index.ts

@@ -0,0 +1 @@
+export { configEdit, configPath } from './config'

package/src/commands/doctor/doctor.ts

@@ -6,12 +6,10 @@ import { $ } from 'zx'
 
 import { MARKER_END, MARKER_START, buildShellBlock } from 'src/commands/init/init'
 import { getProjectRoot } from 'src/lib/git-utils/git-utils'
-import { getInfraKitConfig, resetInfraKitConfigCache } from 'src/lib/infra-kit-config'
+import { getInfraKitConfig, getInfraKitConfigPaths, resetInfraKitConfigCache } from 'src/lib/infra-kit-config'
 import { logger } from 'src/lib/logger'
 import type { ToolsExecutionResult } from 'src/types'
 
-const LOCAL_CONFIG_FILE = 'infra-kit.local.yml'
-
 interface CheckResult {
   name: string
   status: 'pass' | 'fail'
@@ -110,32 +108,43 @@ const checkInfraKitConfigValid = async (): Promise<CheckResult> => {
     return {
       name,
       status: 'pass',
-      message: 'infra-kit.yml is valid (infra-kit.local.yml overrides applied if present)',
+      message: 'infra-kit.yml is valid (user overrides applied if present)',
     }
   } catch (err) {
     return { name, status: 'fail', message: (err as Error).message }
   }
 }
 
-const checkLocalConfigGitignored = async (): Promise<CheckResult> => {
-  const name = 'infra-kit.local.yml gitignored'
+/**
+ * Surface where this developer's user-scope override file would live and
+ * whether it has been created. Always passes — informational only — so the
+ * user knows the resolved project name and target path at a glance.
+ *
+ * @example
+ * await checkUserOverridePath()
+ * // {
+ * //   name: 'user override path',
+ * //   status: 'pass',
+ * //   message: '~/.infra-kit/projects/api/infra-kit.yml (not yet created) — project: api',
+ * // }
+ */
+const checkUserOverridePath = async (): Promise<CheckResult> => {
+  const name = 'user override path'
 
   try {
-    const root = await getProjectRoot()
-
-    await $({ cwd: root, nothrow: true })`git check-ignore -q ${LOCAL_CONFIG_FILE}`.then((result) => {
-      if (result.exitCode !== 0) {
-        throw new Error('not ignored')
-      }
-    })
+    const paths = await getInfraKitConfigPaths()
+    const home = os.homedir()
+    const display = paths.userProject.startsWith(home) ? `~${paths.userProject.slice(home.length)}` : paths.userProject
+    const exists = fs.existsSync(paths.userProject)
+    const suffix = exists ? '(exists)' : '(not yet created)'
 
-    return { name, status: 'pass', message: `${LOCAL_CONFIG_FILE} is covered by .gitignore` }
-  } catch {
     return {
       name,
-      status: 'fail',
-      message: `${LOCAL_CONFIG_FILE} is not gitignored. Add "${LOCAL_CONFIG_FILE}" to .gitignore.`,
+      status: 'pass',
+      message: `${display} ${suffix} — project: ${paths.projectName}`,
     }
+  } catch (err) {
+    return { name, status: 'fail', message: (err as Error).message }
   }
 }
 
@@ -184,7 +193,7 @@ export const doctor = async (): Promise<ToolsExecutionResult> => {
     Promise.resolve(checkZshrcInitialized()),
     checkPnpmWorkspaceVirtualStore(),
     checkInfraKitConfigValid(),
-    checkLocalConfigGitignored(),
+    checkUserOverridePath(),
   ])
 
   logger.info('Doctor check results:\n')

package/src/commands/init/init.ts

@@ -10,8 +10,44 @@ export const MARKER_END = '# -- infra-kit:end --'
 const LEGACY_PAIRED: [start: string, end: string][] = [['# region infra-kit', '# endregion infra-kit']]
 const LEGACY_SINGLE = '# infra-kit shell functions'
 
+const USER_GLOBAL_CONFIG_STUB = `# infra-kit user-global config — ~/.infra-kit/config.yml
+#
+# Merge chain (later layers override earlier ones at top-level keys):
+#   1. <repo>/infra-kit.yml                            — committed project config (required)
+#   2. ~/.infra-kit/config.yml                         — this file (user-global)
+#   3. ~/.infra-kit/projects/<repo-name>/infra-kit.yml — user-scope per-project override
+#
+# Merge is shallow: setting a top-level key here replaces that whole section
+# from layer 1. Arrays do not concatenate. Top-level keys recognized:
+# environments, envManagement, ide, taskManager, worktrees.
+#
+# Uncomment the blocks you want to apply globally across every project on this
+# machine. Per-project tweaks belong in layer 3 — run \`infra-kit config edit\`.
+
+# Per-developer IDE config
+# ide:
+#   provider: cursor
+#   config:
+#     mode: workspace
+#     workspaceConfigPath: /path/to/your.code-workspace
+
+# Worktree prompt defaults — silences the follow-up prompts in \`worktrees-add\`
+# worktrees:
+#   openInGithubDesktop: false
+#   openInCmux: true
+`
+
 /**
- * Append infra-kit shell functions directly to .zshrc.
+ * Append infra-kit shell functions to .zshrc and seed the user-global
+ * config stub at ~/.infra-kit/config.yml on first run. Idempotent: a
+ * subsequent run replaces the existing zshrc block in place and leaves
+ * the user-global config untouched.
+ *
+ * @example
+ * // CLI: `infra-kit init`  (or via the `pnpm dx-init` alias)
+ * // INFO: Added infra-kit shell functions to /Users/me/.zshrc
+ * // INFO: Wrote user-global config stub to /Users/me/.infra-kit/config.yml
+ * // INFO: Run `source ~/.zshrc` or open a new terminal to activate.
  */
 export const init = async (): Promise<void> => {
   const zshrcPath = path.join(os.homedir(), '.zshrc')
@@ -26,9 +62,37 @@ export const init = async (): Promise<void> => {
 
   fs.appendFileSync(zshrcPath, `\n${shellBlock}\n`)
   logger.info(`Added infra-kit shell functions to ${zshrcPath}`)
+
+  seedUserGlobalConfig()
+
   logger.info('Run `source ~/.zshrc` or open a new terminal to activate.')
 }
 
+/**
+ * Create `~/.infra-kit/config.yml` with the documented stub when absent.
+ * Skips silently if the file already exists so user edits are preserved.
+ *
+ * @example
+ * seedUserGlobalConfig()
+ * // first call:  writes ~/.infra-kit/config.yml from USER_GLOBAL_CONFIG_STUB
+ * // later calls: leaves the file alone, logs that it is already present
+ */
+const seedUserGlobalConfig = (): void => {
+  const userConfigDir = path.join(os.homedir(), '.infra-kit')
+  const userConfigPath = path.join(userConfigDir, 'config.yml')
+
+  if (fs.existsSync(userConfigPath)) {
+    logger.info(`User-global config already present at ${userConfigPath}`)
+
+    return
+  }
+
+  fs.mkdirSync(userConfigDir, { recursive: true })
+  fs.writeFileSync(userConfigPath, USER_GLOBAL_CONFIG_STUB, 'utf-8')
+
+  logger.info(`Wrote user-global config stub to ${userConfigPath}`)
+}
+
 const isBlockLine = (line: string): boolean => {
   return (
     line.startsWith('#') ||