chore: Remove DEFAULT_REPO constant and update create-gen-app README to detail modular API components and remove ignore pattern references.

Author: sdqede

packages/create-gen-app-test/src/index.ts

@@ -4,7 +4,6 @@ import { GitCloner } from 'create-gen-app';
 import { Templatizer } from 'create-gen-app';
 
 // Configuration constants (top-most layer owns defaults)
-const DEFAULT_REPO = 'launchql/boilerplates';
 const DEFAULT_TTL = 604800000; // 1 week in milliseconds
 const DEFAULT_TOOL_NAME = 'pgpm';
 

packages/create-gen-app/README.md

@@ -22,7 +22,7 @@ A TypeScript-first library for cloning template repositories, asking the user fo
 
 - Clone any Git repo (or GitHub `org/repo` shorthand) and optionally select a branch + subdirectory
 - Extract template variables from filenames and file contents using the safer `____variable____` convention
-- Merge auto-discovered variables with `.questions.{json,js}` (questions win, including `ignore` patterns)
+- Merge auto-discovered variables with `.questions.{json,js}` (questions win)
 - Interactive prompts powered by `inquirerer`, with flexible override mapping (`argv` support) and non-TTY mode for CI
 - License scaffolding: choose from MIT, Apache-2.0, ISC, GPL-3.0, BSD-3-Clause, Unlicense, or MPL-2.0 and generate a populated `LICENSE`
 - Built-in template caching powered by `appstash`, so repeat runs skip `git clone` (configurable via `cache` options)
@@ -37,51 +37,65 @@ npm install create-gen-app
 
 ## Library Usage
 
-```typescript
-import * as os from "os";
-import * as path from "path";
-
-import { createGen } from "create-gen-app";
-
-await createGen({
-  templateUrl: "https://github.com/user/template-repo",
-  fromBranch: "main",
-  fromPath: "templates/module",
-  outputDir: "./my-new-project",
-  argv: {
-    USERFULLNAME: "Jane Dev",
-    USEREMAIL: "jane@example.com",
-    MODULENAME: "awesome-module",
-    LICENSE: "MIT",
-  },
-  noTty: true,
-  cache: {
-    // optional: override tool/baseDir (defaults to pgpm + ~/.pgpm)
-    toolName: "pgpm",
-    baseDir: path.join(os.tmpdir(), "create-gen-cache"),
-  },
-});
-```
+`create-gen-app` provides a modular set of classes to handle template cloning, caching, and processing.
 
-### Template Caching
+### Core Components
 
-`create-gen-app` caches repositories under `~/.pgpm/cache/repos/<hash>` by default (using [`appstash`](https://github.com/hyperweb-io/dev-utils/tree/main/packages/appstash)). The first run clones & stores the repo, subsequent runs re-use the cached directory.
+- **CacheManager**: Handles local caching of git repositories with TTL (Time-To-Live) support.
+- **GitCloner**: Handles cloning git repositories.
+- **Templatizer**: Handles variable extraction, user prompting, and template generation.
 
-- Disable caching with `cache: false` or `cache: { enabled: false }`
-- Override the tool name or base directory with `cache: { toolName, baseDir }`
-- For tests/CI, point `baseDir` to a temporary folder so the suite does not touch the developer’s real home directory:
+### Example: Orchestration
 
-```ts
-const tempBase = fs.mkdtempSync(path.join(os.tmpdir(), "create-gen-cache-"));
+Here is how you can combine these components to create a full CLI pipeline (similar to `create-gen-app-test`):
 
-await createGen({
-  ...options,
-  cache: { baseDir: tempBase, toolName: "pgpm-test-suite" },
-});
+```typescript
+import * as path from "path";
+import { CacheManager, GitCloner, Templatizer } from "create-gen-app";
+
+async function main() {
+  const repoUrl = "https://github.com/user/template-repo";
+  const outputDir = "./my-new-project";
+
+  // 1. Initialize components
+  const cacheManager = new CacheManager({
+    toolName: "my-cli", // ~/.my-cli/cache
+    ttl: 604800000,     // 1 week
+  });
+  const gitCloner = new GitCloner();
+  const templatizer = new Templatizer();
+
+  // 2. Resolve template path (Cache or Clone)
+  const normalizedUrl = gitCloner.normalizeUrl(repoUrl);
+  const cacheKey = cacheManager.createKey(normalizedUrl);
+  
+  // Check cache
+  let templateDir = cacheManager.get(cacheKey);
+  const isExpired = cacheManager.checkExpiration(cacheKey);
+
+  if (!templateDir || isExpired) {
+    console.log("Cloning template...");
+    if (isExpired) cacheManager.clear(cacheKey);
+    
+    // Clone to a temporary location managed by CacheManager
+    const tempDest = path.join(cacheManager.reposDir, cacheKey);
+    await gitCloner.clone(normalizedUrl, tempDest, { depth: 1 });
+    
+    // Register and update cache
+    cacheManager.set(cacheKey, tempDest);
+    templateDir = tempDest;
+  }
+
+  // 3. Process Template
+  await templatizer.process(templateDir, outputDir, {
+    argv: {
+      PROJECT_NAME: "my-app",
+      LICENSE: "MIT"
+    }
+  });
+}
 ```
 
-The cache directory never mutates the template, so reusing the same cached repo across many runs is safe.
-
 ### Template Variables
 
 Variables should be wrapped in four underscores on each side:
@@ -97,13 +111,12 @@ export const projectName = "____projectName____";
 export const author = "____fullName____";
 ```
 
-### Custom Questions & Ignore Rules
+### Custom Questions
 
 Create a `.questions.json`:
 
 ```json
 {
-  "ignore": ["__tests__", "docs/drafts"],
   "questions": [
     {
       "name": "____fullName____",
@@ -133,11 +146,19 @@ No code changes are needed; the generator discovers templates at runtime and wil
 
 ## API Overview
 
-- `createGen(options)` – full pipeline (clone → extract → prompt → replace)
-- `cloneRepo(url, { branch })` – clone to a temp dir
-- `normalizeCacheOptions(cache)` / `prepareTemplateDirectory(...)` – inspect or reuse cached template repos
-- `extractVariables(dir)` – parse file/folder names + content for variables, load `.questions`
-- `promptUser(extracted, argv, noTty)` – run interactive questions with override alias deduping
-- `replaceVariables(templateDir, outputDir, extracted, answers)` – copy files, rename paths, render licenses
+### CacheManager
+- `new CacheManager(config)`: Initialize with `toolName` and `ttl`.
+- `get(key)`: Get path to cached repo if exists.
+- `set(key, path)`: Register a path in the cache.
+- `checkExpiration(key)`: Check if a cache entry is expired.
+- `clear(key)`: Remove a specific cache entry.
+- `clearAll()`: Clear all cached repos.
+
+### GitCloner
+- `clone(url, dest, options)`: Clone a repo to a destination.
+- `normalizeUrl(url)`: Normalize a git URL for consistency.
+
+### Templatizer
+- `process(templateDir, outputDir, options)`: Run the full template generation pipeline (extract -> prompt -> replace).
 
-See `packages/create-gen-app-test/dev/README.md` for the local development helper script (`pnpm --filter create-gen-app-test dev`).
+See `packages/create-gen-app-test` for a complete reference implementation.