rootless-config 1.3.0 → 1.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rootless-config",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Store project config files outside the project root, auto-deploy them where tools expect them.",
   "type": "module",
   "bin": {

package/src/cli/commands/migrate.js

@@ -5,28 +5,20 @@ import { readdir, unlink, readFile } from 'node:fs/promises'
 import { createLogger } from '../../utils/logger.js'
 import { fileExists, ensureDir, atomicWrite, readJsonFile } from '../../utils/fsUtils.js'
 import { confirm } from '../../utils/prompt.js'
-import { patchPackageScripts, getAllKnownFiles, NEVER_MIGRATE } from '../../core/scriptPatcher.js'
+import { patchPackageScripts, isRootRequired, isPatchable, isWebAsset, NEVER_MIGRATE } from '../../core/scriptPatcher.js'
 
-// Pattern-based detection for file families not covered by the explicit known-files set
-const ENV_PATTERN      = /^\.env/                   // .env, .env.local, .env.production, etc.
-const TSCONFIG_PATTERN = /^tsconfig.*\.json$/        // tsconfig.custom.json etc.
-const DOCKERFILE_PATTERN = /^Dockerfile/            // Dockerfile.dev, Dockerfile.prod etc.
-const DOCKER_COMPOSE_PATTERN = /^docker-compose/    // docker-compose.override.yml etc.
+// A file is migratable when rootless knows what to do with it:
+//  - isRootRequired → must be in root (will be copied there by prepare)
+//  - isPatchable    → can be redirected via --config flag in package.json scripts
+// Anything that's NEVER_MIGRATE (lock files, package.json) is excluded.
 
 async function findMigratableFiles(projectRoot) {
-  const knownFiles = getAllKnownFiles()
   const entries = await readdir(projectRoot, { withFileTypes: true })
   return entries
     .filter(e => {
       if (!e.isFile()) return false
       if (NEVER_MIGRATE.has(e.name)) return false
-      return (
-        knownFiles.has(e.name) ||
-        ENV_PATTERN.test(e.name) ||
-        TSCONFIG_PATTERN.test(e.name) ||
-        DOCKERFILE_PATTERN.test(e.name) ||
-        DOCKER_COMPOSE_PATTERN.test(e.name)
-      )
+      return isRootRequired(e.name) || isPatchable(e.name)
     })
     .map(e => e.name)
     .sort()
@@ -74,10 +66,8 @@ export default {
 
     for (const name of candidates) {
       const src = path.join(projectRoot, name)
-      const isEnv = ENV_PATTERN.test(name)
-      const isAsset = /\.(ico|png|jpg|jpeg|svg|txt|xml|webmanifest|json)$/.test(name) &&
-        ['favicon.ico', 'robots.txt', 'sitemap.xml', 'manifest.json', 'site.webmanifest'].includes(name)
-      const destSubdir = isEnv ? 'env' : (isAsset ? 'assets' : 'configs')
+      const isEnv = /^\.env/.test(name)
+      const destSubdir = isEnv ? 'env' : (isWebAsset(name) ? 'assets' : 'configs')
       const destDir = path.join(containerPath, destSubdir)
 
       await ensureDir(destDir)

package/src/cli/commands/setup.js

@@ -0,0 +1,54 @@
+/*-------- rootless setup — one-command full root cleanup: init + migrate + prepare --------*/
+
+import path from 'node:path'
+import { createLogger } from '../../utils/logger.js'
+import initCmd from './init.js'
+import migrateCmd from './migrate.js'
+import prepareCmd from './prepare.js'
+
+export default {
+  name: 'setup',
+  description: 'Full automated root cleanup: init .root, migrate all configs, prepare (copy + patch scripts)',
+
+  async handler(args) {
+    const logger = createLogger({ verbose: args.verbose ?? false })
+    const projectRoot = args.cwd ? path.resolve(args.cwd) : process.cwd()
+
+    logger.info('─────────────────────────────────────────')
+    logger.info(' rootless setup — cleaning your project root')
+    logger.info('─────────────────────────────────────────')
+    logger.info('')
+
+    // ── Step 1: init ──────────────────────────────────────────────────────────
+    logger.info('[1/3] Initializing .root container…')
+    await initCmd.handler({ ...args, yes: true, cwd: projectRoot })
+    logger.info('')
+
+    // ── Step 2: migrate ───────────────────────────────────────────────────────
+    logger.info('[2/3] Migrating config files from root…')
+    await migrateCmd.handler({ ...args, yes: true, cwd: projectRoot })
+    logger.info('')
+
+    // ── Step 3: prepare ───────────────────────────────────────────────────────
+    logger.info('[3/3] Preparing root (copying mandatory files + patching scripts)…')
+    await prepareCmd.handler({ ...args, yes: true })
+    logger.info('')
+
+    logger.info('─────────────────────────────────────────')
+    logger.success('Setup complete! Your project root is clean.')
+    logger.info('')
+    logger.info('What happened:')
+    logger.info('  • .root/ container created')
+    logger.info('  • Config files moved to .root/configs/')
+    logger.info('  • .env* files moved to .root/env/')
+    logger.info('  • Web assets moved to .root/assets/')
+    logger.info('  • package.json scripts patched with --config flags')
+    logger.info('  • Mandatory files copied back to root (prepare)')
+    logger.info('')
+    logger.info('Next steps:')
+    logger.info('  rootless status   — see what\'s managed')
+    logger.info('  rootless doctor   — verify everything is wired correctly')
+    logger.info('  rootless watch    — auto-sync on .root/ changes')
+    logger.info('─────────────────────────────────────────')
+  },
+}

package/src/cli/index.js

@@ -20,7 +20,7 @@ async function run(argv) {
   for (const cmd of registry.list()) {
     const sub = program.command(cmd.name).description(cmd.description)
 
-    if (['prepare', 'watch', 'migrate'].includes(cmd.name)) {
+    if (['prepare', 'watch', 'migrate', 'setup'].includes(cmd.name)) {
       sub.option('--yes', 'Auto-approve all file override prompts')
       sub.option('--no-yes', 'Auto-decline all file override prompts')
     }

package/src/core/scriptPatcher.js

@@ -146,8 +146,149 @@ const ROOT_REQUIRED_FILES = new Set([
   'renovate.json', '.renovaterc', '.renovaterc.json',
   // Misc
   '.htaccess', 'Procfile',
+  // GitHub Pages
+  '.nojekyll', 'CNAME', 'CXNAME',
+  // Hosting platform
+  '_redirects', '_headers', 'vercel.json', 'netlify.toml', 'wrangler.toml', 'fly.toml',
+  // Status / health
+  'status.json', 'health.json',
+  // NGINX / server
+  'nginx.conf', 'nginx.config',
+  // Service workers
+  'sw.js', 'service-worker.js',
+  // Web entry points
+  'index.html', 'index.htm', 'index.php',
 ])
 
+// ─── Pattern-based root-required detection ───────────────────────────────────
+
+/**
+ * Regex patterns for files that MUST be physically in the project root,
+ * matched against the basename only.
+ * Used for file families whose exact names can vary
+ * (e.g. icon-192.png, 404.htm, logo-dark.svg, server.ps1 …).
+ */
+const ROOT_REQUIRED_PATTERNS = [
+  // Environment files
+  /^\.env/,
+  // Docker variants
+  /^Dockerfile(\..+)?$/,
+  /^docker-compose.*\.(yml|yaml)$/,
+  // tsconfig variants
+  /^tsconfig.*\.json$/,
+  // GitHub Pages & hosting markers
+  /^\.nojekyll$/,
+  /^CNAME$/i,
+  /^CXNAME$/i,
+  // Error pages — 404.html, 404.htm, 404.md, 500.html …
+  /^[45]\d{2}\.(html?|php|md|txt)$/,
+  // Web entry points
+  /^index\.(html?|php)$/,
+  // index-style assets — index-ui.css, index.app.js, index.min.js …
+  /^index[-.].+\.(css|js|mjs)$/,
+  // Service workers
+  /^sw\.js$/,
+  /^service-worker.*\.js$/,
+  /^workbox-.*\.js$/,
+  // Web manifests
+  /^manifest.*\.json$/,
+  /^site\.webmanifest$/,
+  // Favicon & icons
+  /^favicon(\..+)?$/,
+  /^apple-touch-icon.*\.(png|jpg)$/,
+  /^icon.*\.(png|ico|svg|jpg|jpeg)$/,
+  /^android-chrome-.*\.(png|jpg)$/,
+  /^mstile-.*\.png$/,
+  /^browserconfig\.xml$/,
+  // Social & OG images
+  /^og[-_]image.*\.(png|jpg|jpeg|webp)$/,
+  /^twitter[-_]image.*\.(png|jpg|jpeg|webp)$/,
+  /^social[-_]image.*\.(png|jpg|jpeg|webp)$/,
+  /^opengraph.*\.(png|jpg|jpeg|webp)$/,
+  // Logo & branding
+  /^logo.*\.(png|svg|jpg|jpeg|webp)$/,
+  // Screenshots & splash screens
+  /^splash.*\.(png|jpg|jpeg)$/,
+  /^screenshot.*\.(png|jpg|jpeg)$/,
+  // Sitemaps & SEO
+  /^sitemap.*\.(xml|txt)$/,
+  // NGINX & server configs
+  /^nginx.*\.(conf|config)$/,
+  /\.nginx$/,
+  /^\.htaccess$/,
+  /^Procfile(\..+)?$/,
+  // Shell / batch scripts in root (server.ps1, server.run.cmd, start.sh …)
+  /\.ps1$/,
+  /\.sh$/,
+  /\.(bat|cmd)$/,
+  // Version manager dotfiles
+  /^\.nvmrc$/,
+  /^\.node-version$/,
+  // Git
+  /^\.gitignore$/,
+  /^\.gitattributes$/,
+  /^\.gitmodules$/,
+  /^CODEOWNERS$/,
+  // Docker misc
+  /^\.dockerignore$/,
+  // Documentation (any extension, any case)
+  /^README(\..+)?$/i,
+  /^CHANGELOG(\..+)?$/i,
+  /^OVERVIEW(\..+)?$/i,
+  /^LICENSE(\..+)?$/i,
+  /^CONTRIBUTING(\..+)?$/i,
+  /^CODE_OF_CONDUCT(\..+)?$/i,
+  /^SECURITY(\..+)?$/i,
+  /^SUPPORT(\..+)?$/i,
+  /^COPYING(\..+)?$/i,
+  /^AUTHORS(\..+)?$/i,
+  /^NOTICE(\..+)?$/i,
+  // Hosting platform
+  /^_redirects$/,
+  /^_headers$/,
+  /^vercel\.json$/,
+  /^netlify\.toml$/,
+  /^wrangler\.toml$/,
+  /^fly\.toml$/,
+  // Status / health check files
+  /^status\.json$/,
+  /^health\.json$/,
+]
+
+/**
+ * Patterns for web assets served directly from the root by a web server.
+ * Files matching these go into .root/assets/ so they get copied to root on `prepare`.
+ */
+const WEB_ASSET_PATTERNS = [
+  /^favicon(\..+)?$/,
+  /^apple-touch-icon.*\.(png|jpg)$/,
+  /^icon.*\.(png|ico|svg|jpg|jpeg)$/,
+  /^android-chrome-.*\.(png|jpg)$/,
+  /^mstile-.*\.png$/,
+  /^browserconfig\.xml$/,
+  /^og[-_]image.*\.(png|jpg|jpeg|webp)$/,
+  /^twitter[-_]image.*\.(png|jpg|jpeg|webp)$/,
+  /^social[-_]image.*\.(png|jpg|jpeg|webp)$/,
+  /^opengraph.*\.(png|jpg|jpeg|webp)$/,
+  /^logo.*\.(png|svg|jpg|jpeg|webp)$/,
+  /^splash.*\.(png|jpg|jpeg)$/,
+  /^screenshot.*\.(png|jpg|jpeg)$/,
+  /^[45]\d{2}\.(html?|php|md|txt)$/,
+  /^index\.(html?|php)$/,
+  /^index[-.].+\.(css|js|mjs)$/,
+  /^sw\.js$/,
+  /^service-worker.*\.js$/,
+  /^workbox-.*\.js$/,
+  /^manifest.*\.json$/,
+  /^site\.webmanifest$/,
+  /^sitemap.*\.(xml|txt)$/,
+  /^robots\.txt$/,
+  /^status\.json$/,
+  /^health\.json$/,
+  /^_redirects$/,
+  /^_headers$/,
+]
+
 /**
  * Lock files and core manifests that should NEVER be migrated.
  * They must always live in the project root and are managed by package managers.
@@ -195,18 +336,25 @@ function isPatchable(filename) {
 
 /**
  * Returns true if the file must be physically present in the project root.
+ * Checks exact names first, then the pattern registry.
  */
 function isRootRequired(filename) {
   if (NEVER_MIGRATE.has(filename)) return false
   if (ROOT_REQUIRED_FILES.has(filename)) return true
-  if (/^\.env/.test(filename)) return true           // .env.local, .env.production, etc.
-  if (/^Dockerfile/.test(filename)) return true      // Dockerfile.dev, Dockerfile.prod etc.
-  if (/^tsconfig.*\.json$/.test(filename)) return true // tsconfig.custom.json variants
-  if (/^docker-compose/.test(filename)) return true  // docker-compose.override.yml etc.
-  if (!isPatchable(filename)) return true            // unknown file → copy to root to be safe
+  if (ROOT_REQUIRED_PATTERNS.some(p => p.test(filename))) return true
+  if (!isPatchable(filename)) return true  // unknown file → safe default: copy to root
   return false
 }
 
+/**
+ * Returns true if the file is a web asset that should be served
+ * directly from the project root by a web server (images, HTML, SW, manifest …).
+ * These land in .root/assets/ and are copied to root on `prepare`.
+ */
+function isWebAsset(filename) {
+  return WEB_ASSET_PATTERNS.some(p => p.test(filename))
+}
+
 // ─── Config map building ─────────────────────────────────────────────────────
 
 /**
@@ -328,7 +476,10 @@ export {
   patchScriptString,
   isPatchable,
   isRootRequired,
+  isWebAsset,
   getAllKnownFiles,
   NEVER_MIGRATE,
+  ROOT_REQUIRED_PATTERNS,
+  WEB_ASSET_PATTERNS,
 }