create-projx 1.1.1 → 1.2.0

package/README.md

@@ -54,32 +54,49 @@ Interactive prompt lets you pick components. Or specify them directly:
 npx create-projx my-app --components fastapi,fastify,frontend,mobile,e2e,infra
 ```
 
-### Add Components Later
+### Adopt an Existing Project
+
+Already have a project? Initialize projx to get the scaffolding (CI, hooks, docker-compose) without overwriting your code:
+
+```bash
+cd my-existing-app
+npx create-projx init
+```
 
-Already have a project? Add more components anytime:
+Auto-detects components by scanning for `fastapi` in pyproject.toml, `react`/`fastify` in package.json, `flutter` in pubspec.yaml, and `.tf` files. Confirms each mapping, writes `.projx-component` markers, and generates only missing shared files. Existing files get a diff/overwrite/skip prompt.
+
+### Add Components Later
 
 ```bash
 cd my-app
 npx create-projx add frontend mobile
 ```
 
-This copies the new component directories, regenerates shared files (docker-compose, CI, pre-commit hooks) to include them, and installs dependencies.
+Copies the new component directories, regenerates shared files (docker-compose, CI, pre-commit hooks) to include them, and installs dependencies.
 
 ### Update Scaffolding
 
-When we improve templates, update your project's scaffolding without touching your code:
+When templates improve, update your project:
 
 ```bash
 cd my-app
 npx create-projx@latest update
 ```
 
-This updates template files (base models, middleware, configs, Dockerfiles, CI) tracked in `.projx` manifest. Files you created (new entities, pages, features) are never touched.
+Creates a `projx/update-vX.X.X` branch with the latest template overlay. Your custom files are never deleted — only template files are added or replaced. Merge with conflict resolution:
+
+```bash
+git diff main...projx/update-v1.1.2    # review changes
+git checkout main && git merge --no-ff projx/update-v1.1.2  # merge with conflicts
+```
+
+Git shows conflicts on files you customized (controllers, middleware, configs). You keep your code, accept template improvements.
 
 ## Options
 
 ```
 npx create-projx <name> [options]
+npx create-projx init
 npx create-projx add <components...>
 npx create-projx update
 
@@ -90,19 +107,34 @@ npx create-projx update
 -h, --help             Show help
 ```
 
+## Rename Component Directories
+
+Rename `fastapi/` to `backend/`? Just rename the folder — the `.projx-component` marker file moves with it. The `update` command auto-discovers where each component lives by scanning for these markers. No config changes needed.
+
+```
+backend/.projx-component  →  { "components": ["fastapi"] }
+web/.projx-component      →  { "components": ["frontend"] }
+```
+
+CI, setup.sh, pre-commit hooks, and docker-compose are all regenerated with your custom directory names.
+
 ## What a Scaffolded Project Looks Like
 
 ```
 my-app/
-├── fastapi/              # Auto-entity CRUD backend
-├── frontend/             # Auto-entity UI from /_meta
-├── e2e/                  # Playwright E2E tests
-├── docker-compose.yml    # Production (backend + frontend + SSL)
-├── docker-compose.dev.yml # Development (PostgreSQL + hot reload)
-├── .github/workflows/    # CI per component
-├── .githooks/pre-commit  # Format + lint on commit
-├── setup.sh              # Install all deps
-└── .projx                # Manifest (tracks template files for updates)
+├── fastapi/                # Auto-entity CRUD backend
+│   └── .projx-component    # Identifies this as the fastapi component
+├── frontend/               # Auto-entity UI from /_meta
+│   └── .projx-component
+├── e2e/                    # Playwright E2E tests
+│   └── .projx-component
+├── docker-compose.yml      # Production (backend + frontend + SSL)
+├── docker-compose.dev.yml  # Development (PostgreSQL + hot reload)
+├── .github/workflows/      # CI per component (runs only on changes)
+├── .githooks/pre-commit    # Format + lint on commit
+├── .vscode/                # Editor settings + recommended extensions
+├── setup.sh                # Install all deps
+└── .projx                  # Components list + version
 ```
 
 Only the components you selected appear. Shared files (docker-compose, CI, hooks) are generated to match your selection.
@@ -121,9 +153,10 @@ The core idea: define a data model, get everything else for free.
 
 - JWT auth with Keycloak (pluggable providers)
 - Docker Compose for dev and prod
-- GitHub Actions CI per component
+- GitHub Actions CI per component (path-filtered — only runs when that component changes)
 - Pre-commit hooks (format + lint + typecheck)
 - Secret detection in pre-commit
+- VS Code settings + recommended extensions
 - 80% test coverage enforced
 - Auto-entity discovery across all stacks
 
@@ -139,6 +172,12 @@ cd projx
 
 The CLI lives in `cli/`. Templates are the root-level component directories (`fastapi/`, `frontend/`, etc.).
 
+```bash
+cd cli
+npm test        # run tests
+npm run build   # build CLI
+```
+
 ## License
 
 MIT

package/dist/index.js

@@ -437,8 +437,7 @@ async function doScaffold(opts, dest, repoDir, name, nameSnake, vars) {
   const projxConfig = {
     version: pkg.version,
     components: opts.components,
-    createdAt: (/* @__PURE__ */ new Date()).toISOString().split("T")[0],
-    paths: vars.paths
+    createdAt: (/* @__PURE__ */ new Date()).toISOString().split("T")[0]
   };
   await writeFile2(join3(dest, ".projx"), JSON.stringify(projxConfig, null, 2));
   if (opts.git) {
@@ -680,21 +679,24 @@ async function update(cwd, localRepo) {
     }
     execSync2(`git checkout -b ${branchName}`, { cwd, stdio: "pipe" });
     p3.log.info(`Created branch: ${branchName}`);
+    let touchedFiles;
     try {
-      await doUpdate(cwd, config, repoDir, pkg.version, componentPaths);
+      touchedFiles = await doUpdate(cwd, config, repoDir, pkg.version, componentPaths);
     } finally {
       await cleanupRepo(repoDir, isLocal);
     }
-    execSync2("git add -A", { cwd, stdio: "pipe" });
-    execSync2(`git commit -m "projx update to v${pkg.version}"`, { cwd, stdio: "pipe" });
+    for (const f of touchedFiles) {
+      execSync2(`git add "${f}"`, { cwd, stdio: "pipe" });
+    }
+    execSync2(`git commit --no-verify -m "projx update to v${pkg.version}"`, { cwd, stdio: "pipe" });
     p3.outro(
       `Updated on branch: ${branchName}
 
   Review changes:
     git diff ${originalBranch}...${branchName}
 
-  Switch back and merge:
-    git checkout ${originalBranch} && git merge ${branchName}`
+  Merge (resolve conflicts for files you customized):
+    git checkout ${originalBranch} && git merge --no-ff ${branchName}`
     );
   } else {
     const dlSpinner = p3.spinner();
@@ -720,8 +722,15 @@ async function doUpdate(cwd, config, repoDir, version, componentPaths) {
   const name = detectProjectName(cwd, config.components, componentPaths);
   const nameSnake = toSnake(name);
   const vars = { projectName: name, components: config.components, paths: componentPaths };
+  const touchedFiles = [];
+  const usedPaths = /* @__PURE__ */ new Set();
   for (const component of config.components) {
     const targetDir = componentPaths[component];
+    if (usedPaths.has(targetDir)) {
+      p3.log.warn(`${component} shares directory ${targetDir}/ with another component \u2014 skipping overlay to avoid nesting.`);
+      continue;
+    }
+    usedPaths.add(targetDir);
     const spinner6 = p3.spinner();
     spinner6.start(`Updating ${targetDir}/ (${component})`);
     const componentSrc = join4(repoDir, component);
@@ -739,10 +748,12 @@ async function doUpdate(cwd, config, repoDir, version, componentPaths) {
       const dir = dest.substring(0, dest.lastIndexOf("/"));
       await mkdir3(dir, { recursive: true });
       await cp2(src, dest, { force: true });
+      touchedFiles.push(destRel);
     }
     await rm2(tmpDest, { recursive: true, force: true });
     if (!existsSync3(join4(cwd, targetDir, ".projx-component"))) {
       await writeComponentMarker(join4(cwd, targetDir), component);
+      touchedFiles.push(`${targetDir}/.projx-component`);
     }
     spinner6.stop(`${targetDir}/ updated.`);
   }
@@ -750,29 +761,24 @@ async function doUpdate(cwd, config, repoDir, version, componentPaths) {
   spinner5.start("Updating shared files");
   const hasBackend = config.components.includes("fastapi") || config.components.includes("fastify");
   if (hasBackend || config.components.includes("frontend")) {
-    await writeFile3(
-      join4(cwd, "docker-compose.yml"),
-      await generateDockerCompose(vars)
-    );
-    await writeFile3(
-      join4(cwd, "docker-compose.dev.yml"),
-      await generateDockerComposeDev(vars)
-    );
+    await writeFile3(join4(cwd, "docker-compose.yml"), await generateDockerCompose(vars));
+    touchedFiles.push("docker-compose.yml");
+    await writeFile3(join4(cwd, "docker-compose.dev.yml"), await generateDockerComposeDev(vars));
+    touchedFiles.push("docker-compose.dev.yml");
   }
   await mkdir3(join4(cwd, ".githooks"), { recursive: true });
-  const preCommit = await generatePreCommit(vars);
-  await writeFile3(join4(cwd, ".githooks/pre-commit"), preCommit);
+  await writeFile3(join4(cwd, ".githooks/pre-commit"), await generatePreCommit(vars));
   await chmod2(join4(cwd, ".githooks/pre-commit"), 493);
+  touchedFiles.push(".githooks/pre-commit");
   await mkdir3(join4(cwd, ".github/workflows"), { recursive: true });
-  await writeFile3(
-    join4(cwd, ".github/workflows/ci.yml"),
-    await generateCiYml(vars)
-  );
-  const setupSh = await generateSetupSh(vars);
-  await writeFile3(join4(cwd, "setup.sh"), setupSh);
+  await writeFile3(join4(cwd, ".github/workflows/ci.yml"), await generateCiYml(vars));
+  touchedFiles.push(".github/workflows/ci.yml");
+  await writeFile3(join4(cwd, "setup.sh"), await generateSetupSh(vars));
   await chmod2(join4(cwd, "setup.sh"), 493);
+  touchedFiles.push("setup.sh");
   await mkdir3(join4(cwd, ".vscode"), { recursive: true });
   await writeFile3(join4(cwd, ".vscode/settings.json"), generateVscodeSettings(vars));
+  touchedFiles.push(".vscode/settings.json");
   spinner5.stop("Shared files updated.");
   if (config.components.includes("mobile")) {
     const mobilePath = componentPaths.mobile ?? "mobile";
@@ -786,10 +792,11 @@ async function doUpdate(cwd, config, repoDir, version, componentPaths) {
   const updatedConfig = {
     version,
     components: config.components,
-    createdAt: config.createdAt,
-    paths: componentPaths
+    createdAt: config.createdAt
   };
   await writeFile3(join4(cwd, ".projx"), JSON.stringify(updatedConfig, null, 2));
+  touchedFiles.push(".projx");
+  return touchedFiles;
 }
 function detectProjectName(cwd, components, componentPaths) {
   for (const component of components) {
@@ -901,8 +908,7 @@ async function doAdd(cwd, config, toAdd, repoDir, skipInstall) {
   const updatedConfig = {
     version: pkg.version,
     components: allComponents,
-    createdAt: config.createdAt,
-    paths
+    createdAt: config.createdAt
   };
   await writeFile4(join5(cwd, ".projx"), JSON.stringify(updatedConfig, null, 2));
   p4.outro(`Added ${toAdd.join(", ")}. Shared files updated for all ${allComponents.length} components.
@@ -1236,8 +1242,7 @@ async function init(cwd, localRepo) {
     const projxConfig = {
       version: pkg.version,
       components,
-      createdAt: (/* @__PURE__ */ new Date()).toISOString().split("T")[0],
-      paths
+      createdAt: (/* @__PURE__ */ new Date()).toISOString().split("T")[0]
     };
     await writeFile5(join7(cwd, ".projx"), JSON.stringify(projxConfig, null, 2));
     p5.log.success(".projx");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-projx",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Scaffold production-grade projects. Pick your stack (FastAPI, Fastify, React, Flutter), get a fully wired template with auth, database, CI/CD, and E2E tests.",
   "type": "module",
   "bin": {