@expressots/cli 3.0.0 → 4.0.0-preview.3

package/bin/utils/update-tsconfig-paths.js

@@ -0,0 +1,326 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateTsconfigPaths = exports.getPathAliasForFolder = exports.updateTsconfigPaths = exports.generatePathAlias = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const cli_ui_1 = require("./cli-ui");
+/**
+ * Default path alias mappings for opinionated scaffolding
+ * Maps folder names to their corresponding path aliases
+ */
+const DEFAULT_PATH_ALIASES = {
+    controllers: "@controllers",
+    useCases: "@useCases",
+    providers: "@providers",
+    entities: "@entities",
+    middleware: "@middleware",
+    interceptors: "@interceptors",
+    events: "@events",
+    guards: "@guards",
+    config: "@config",
+};
+/**
+ * Generate path alias from folder name
+ * Handles both default mappings and custom folder names
+ *
+ * @param folderName - The folder name (e.g., "useCases", "my-custom-folder")
+ * @returns The path alias (e.g., "@useCases", "@myCustomFolder")
+ */
+function generatePathAlias(folderName) {
+    // Check if we have a default mapping
+    if (DEFAULT_PATH_ALIASES[folderName]) {
+        return DEFAULT_PATH_ALIASES[folderName];
+    }
+    // For custom folder names, convert to camelCase and add @ prefix
+    // Handles: kebab-case, snake_case, PascalCase, camelCase
+    const camelCase = folderName
+        .split(/[-_]/)
+        .map((word, index) => {
+        if (index === 0) {
+            // First word: keep original case for already camelCase names
+            return word.charAt(0).toLowerCase() + word.slice(1);
+        }
+        // Subsequent words: capitalize first letter
+        return word.charAt(0).toUpperCase() + word.slice(1).toLowerCase();
+    })
+        .join("");
+    return `@${camelCase}`;
+}
+exports.generatePathAlias = generatePathAlias;
+/**
+ * Parse JSONC (JSON with Comments) by stripping comments and trailing commas.
+ *
+ * Implemented as a small character scanner so we are correctly string-aware:
+ * comment-delimiter sequences (slash-star and star-slash) inside a JSON
+ * string literal — e.g. the very common "src" double-star slash "*.ts"
+ * include glob — must NOT be treated as comments. The previous regex-based
+ * stripper silently corrupted such globs into `src*.ts`, which then got
+ * persisted to disk by the structured rewriter.
+ *
+ * Handles:
+ * - Line comments (`//` to end of line)
+ * - Block comments (may span lines, may also be empty)
+ * - Trailing commas before `}` / `]`
+ * - JSON string escapes (`\"`, `\\`, etc.)
+ *
+ * @param content - The JSONC content
+ * @returns Cleaned JSON string that can be parsed by JSON.parse
+ */
+function stripJsonComments(content) {
+    let out = "";
+    let inString = false;
+    let escape = false;
+    for (let i = 0; i < content.length; i++) {
+        const ch = content[i];
+        const next = content[i + 1];
+        if (inString) {
+            out += ch;
+            if (escape) {
+                escape = false;
+            }
+            else if (ch === "\\") {
+                escape = true;
+            }
+            else if (ch === '"') {
+                inString = false;
+            }
+            continue;
+        }
+        if (ch === '"') {
+            inString = true;
+            out += ch;
+            continue;
+        }
+        if (ch === "/" && next === "/") {
+            // Line comment — skip until newline (newline is preserved).
+            i += 2;
+            while (i < content.length && content[i] !== "\n")
+                i++;
+            i--; // Loop will increment past this position.
+            continue;
+        }
+        if (ch === "/" && next === "*") {
+            // Block comment — skip until closing */. Replace with a single
+            // space so adjacent tokens don't fuse (e.g. `a/*x*/b` -> `a b`).
+            i += 2;
+            while (i < content.length &&
+                !(content[i] === "*" && content[i + 1] === "/")) {
+                i++;
+            }
+            i++; // Consume the closing '*' (loop increments past '/').
+            out += " ";
+            continue;
+        }
+        out += ch;
+    }
+    // Strip trailing commas before `}` / `]` (legal in JSONC, not in JSON).
+    return out.replace(/,(\s*[}\]])/g, "$1");
+}
+/**
+ * Try to parse JSONC content, first stripping comments then parsing
+ * @param content - Raw file content
+ * @returns Parsed config object or null if parsing fails
+ */
+function parseJsonc(content) {
+    // Always try to strip comments first for consistency
+    const stripped = stripJsonComments(content);
+    try {
+        return JSON.parse(stripped);
+    }
+    catch {
+        // If stripping didn't help, try the original (unlikely but safe)
+        try {
+            return JSON.parse(content);
+        }
+        catch {
+            return null;
+        }
+    }
+}
+/**
+ * Text-based fallback to add path alias when JSON parsing fails
+ * This preserves the original file format (comments, etc.)
+ *
+ * @param content - Original file content
+ * @param aliasKey - The path alias key (e.g., "@config/*")
+ * @param aliasValue - The path alias value (e.g., ["./src/config/*"])
+ * @returns Modified content or null if update failed
+ */
+function addPathAliasTextBased(content, aliasKey, aliasValue) {
+    // Check if the alias already exists
+    if (content.includes(`"${aliasKey}"`)) {
+        return null; // Already exists, no update needed
+    }
+    // Find the "paths" object
+    const pathsMatch = content.match(/"paths"\s*:\s*\{/);
+    if (pathsMatch && pathsMatch.index !== undefined) {
+        // Insert new path alias after "paths": {
+        const insertPos = pathsMatch.index + pathsMatch[0].length;
+        const aliasEntry = `\n\t\t\t"${aliasKey}": ${JSON.stringify(aliasValue)},`;
+        return (content.slice(0, insertPos) + aliasEntry + content.slice(insertPos));
+    }
+    // Find compilerOptions to add paths object
+    const compilerOptionsMatch = content.match(/"compilerOptions"\s*:\s*\{/);
+    if (compilerOptionsMatch && compilerOptionsMatch.index !== undefined) {
+        // Find the end of compilerOptions opening brace.
+        // We don't inject `baseUrl` here on purpose — `paths` resolve
+        // relative to the tsconfig file when `baseUrl` is absent (TS 5+),
+        // which matches the v4 template convention.
+        const insertPos = compilerOptionsMatch.index + compilerOptionsMatch[0].length;
+        const insertion = "\n" +
+            `\t\t"paths": {\n\t\t\t"${aliasKey}": ${JSON.stringify(aliasValue)}\n\t\t},`;
+        return (content.slice(0, insertPos) + insertion + content.slice(insertPos));
+    }
+    // Can't find compilerOptions, give up
+    return null;
+}
+/**
+ * Update tsconfig.json paths to include missing aliases for opinionated scaffolding
+ * Handles both default folders and custom scaffoldSchematics overrides
+ *
+ * @param folderName - The folder name where the schematic is being created
+ * @param sourceRoot - The source root directory (default: "src")
+ */
+async function updateTsconfigPaths(folderName, sourceRoot = "src") {
+    if (!folderName) {
+        return; // No folder specified
+    }
+    const tsconfigPath = node_path_1.default.join(process.cwd(), "tsconfig.json");
+    const tsconfigBuildPath = node_path_1.default.join(process.cwd(), "tsconfig.build.json");
+    // Generate alias from folder name (handles custom names)
+    const alias = generatePathAlias(folderName);
+    const aliasKey = `${alias}/*`;
+    // Track if we updated any config
+    let updated = false;
+    // Update both tsconfig files if they exist
+    for (const configPath of [tsconfigPath, tsconfigBuildPath]) {
+        if (!node_fs_1.default.existsSync(configPath)) {
+            continue;
+        }
+        try {
+            const configContent = node_fs_1.default.readFileSync(configPath, "utf-8");
+            // Try JSON parsing first
+            const config = parseJsonc(configContent);
+            if (config) {
+                // JSON parsing succeeded - use structured approach
+                // Ensure compilerOptions exists
+                if (!config.compilerOptions) {
+                    config.compilerOptions = {};
+                }
+                const compilerOptions = config.compilerOptions;
+                // Determine the correct path value based on baseUrl. When
+                // `baseUrl` is absent (the TS 7-friendly default the v4
+                // templates ship) `paths` resolve relative to the tsconfig
+                // file itself — same effective behaviour as `baseUrl: "."`.
+                // We deliberately do NOT inject `baseUrl` here; doing so
+                // would silently undo the template's intentional removal.
+                const baseUrl = compilerOptions.baseUrl || ".";
+                const isBaseUrlSrc = baseUrl === `./${sourceRoot}` || baseUrl === sourceRoot;
+                const aliasValue = isBaseUrlSrc
+                    ? [`./${folderName}/*`]
+                    : [`./${sourceRoot}/${folderName}/*`];
+                // Ensure paths object exists
+                if (!compilerOptions.paths) {
+                    compilerOptions.paths = {};
+                }
+                const paths = compilerOptions.paths;
+                // Only add if it doesn't exist
+                if (!paths[aliasKey]) {
+                    paths[aliasKey] = aliasValue;
+                    // Write back to file with proper formatting (tab indent)
+                    node_fs_1.default.writeFileSync(configPath, JSON.stringify(config, null, "\t") + "\n", "utf-8");
+                    updated = true;
+                }
+            }
+            else {
+                // JSON parsing failed - use text-based fallback
+                // This preserves comments and formatting
+                // Try to detect baseUrl from content
+                const baseUrlMatch = configContent.match(/"baseUrl"\s*:\s*"([^"]+)"/);
+                const baseUrl = baseUrlMatch ? baseUrlMatch[1] : ".";
+                const isBaseUrlSrc = baseUrl === `./${sourceRoot}` || baseUrl === sourceRoot;
+                const aliasValue = isBaseUrlSrc
+                    ? [`./${folderName}/*`]
+                    : [`./${sourceRoot}/${folderName}/*`];
+                const modifiedContent = addPathAliasTextBased(configContent, aliasKey, aliasValue);
+                if (modifiedContent) {
+                    node_fs_1.default.writeFileSync(configPath, modifiedContent, "utf-8");
+                    updated = true;
+                }
+                else if (!configContent.includes(`"${aliasKey}"`)) {
+                    // Couldn't update and alias doesn't exist
+                    (0, cli_ui_1.printWarning)(`Could not update ${node_path_1.default.basename(configPath)}. Please add "${aliasKey}" path alias manually`, "tsconfig");
+                }
+            }
+        }
+        catch (error) {
+            // Log warning but don't fail the scaffolding process
+            (0, cli_ui_1.printWarning)(`Could not update ${node_path_1.default.basename(configPath)}: ${error instanceof Error ? error.message : "Unknown error"}`, "tsconfig");
+        }
+    }
+    // Print success message only if we updated something
+    if (updated) {
+        (0, cli_ui_1.printInfo)(`Path alias ${aliasKey} added`, "tsconfig");
+    }
+}
+exports.updateTsconfigPaths = updateTsconfigPaths;
+/**
+ * Get the path alias for a given folder name
+ * Used by other utilities to determine the correct import path
+ *
+ * @param folderName - The folder name
+ * @returns The path alias (e.g., "@useCases")
+ */
+function getPathAliasForFolder(folderName) {
+    return generatePathAlias(folderName);
+}
+exports.getPathAliasForFolder = getPathAliasForFolder;
+/**
+ * Check if tsconfig already has all required path aliases for opinionated mode
+ * This can be used to validate project setup
+ *
+ * @param requiredFolders - List of folder names that need path aliases
+ * @returns Object with missing aliases and whether all are present
+ */
+function validateTsconfigPaths(requiredFolders) {
+    const tsconfigPath = node_path_1.default.join(process.cwd(), "tsconfig.json");
+    if (!node_fs_1.default.existsSync(tsconfigPath)) {
+        return {
+            valid: false,
+            missingAliases: requiredFolders.map((f) => generatePathAlias(f)),
+        };
+    }
+    try {
+        const configContent = node_fs_1.default.readFileSync(tsconfigPath, "utf-8");
+        let config;
+        try {
+            config = JSON.parse(configContent);
+        }
+        catch {
+            config = JSON.parse(stripJsonComments(configContent));
+        }
+        const paths = config.compilerOptions
+            ?.paths || {};
+        const missingAliases = [];
+        for (const folder of requiredFolders) {
+            const aliasKey = `${generatePathAlias(folder)}/*`;
+            if (!paths[aliasKey]) {
+                missingAliases.push(aliasKey);
+            }
+        }
+        return {
+            valid: missingAliases.length === 0,
+            missingAliases,
+        };
+    }
+    catch {
+        return {
+            valid: false,
+            missingAliases: requiredFolders.map((f) => generatePathAlias(f)),
+        };
+    }
+}
+exports.validateTsconfigPaths = validateTsconfigPaths;

package/package.json

@@ -1,158 +1,167 @@
 {
-	"name": "@expressots/cli",
-	"version": "3.0.0",
-	"description": "Expressots CLI - modern, fast, lightweight nodejs web framework (@cli)",
-	"author": "Richard Zampieri",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/expressots/expressots-cli/issues"
-	},
-	"bin": {
-		"expressots": "bin/cli.js",
-		"ex": "bin/cli.js"
-	},
-	"engines": {
-		"node": ">=20.18.0"
-	},
-	"funding": {
-		"type": "github",
-		"url": "https://github.com/sponsors/expressots"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/expressots/expressots-cli"
-	},
-	"homepage": "https://expresso-ts.com",
-	"publishConfig": {
-		"access": "public"
-	},
-	"keywords": [
-		"ExpressoTS",
-		"CLI",
-		"Scaffolding"
-	],
-	"scripts": {
-		"prepare": "husky",
-		"start:build": "npm run build && npm run start",
-		"start": "node ./bin/cli.js",
-		"start:dev": "tsx ./src/cli.ts",
-		"build": "npm run clean && tsc -p tsconfig.json && npm run cp:templates && node scripts/chmod.js ./bin/cli.js",
-		"cp:templates": "node scripts/cp.js ./src/generate/templates ./bin/generate/",
-		"clean": "node scripts/rm.js bin",
-		"prepublish": "npm run build && npm pack",
-		"format": "prettier --write \"./src/**/*.ts\" --cache",
-		"lint": "eslint \"./src/**/*.ts\"",
-		"lint:fix": "eslint \"./src/**/*.ts\" --fix",
-		"release": "release-it",
-		"test": "jest",
-		"coverage": "jest --coverage",
-		"test:watch": "jest --watch"
-	},
-	"dependencies": {
-		"axios": "1.7.7",
-		"chalk-animation": "2.0.3",
-		"cli-progress": "3.12.0",
-		"cli-table3": "0.6.5",
-		"degit": "2.8.4",
-		"glob": "10.4.5",
-		"inquirer": "8.2.6",
-		"mustache": "4.2.0",
-		"semver": "7.6.3",
-		"ts-node": "10.9.2",
-		"yargs": "17.7.2"
-	},
-	"devDependencies": {
-		"@codecov/vite-plugin": "0.0.1-beta.9",
-		"@commitlint/cli": "19.2.1",
-		"@commitlint/config-conventional": "19.1.0",
-		"@expressots/shared": "3.0.0",
-		"@release-it/conventional-changelog": "7.0.2",
-		"@types/chalk-animation": "1.6.1",
-		"@types/cli-progress": "3.11.0",
-		"@types/degit": "2.8.3",
-		"@types/inquirer": "9.0.3",
-		"@types/jest": "^29.5.14",
-		"@types/mustache": "4.2.2",
-		"@types/node": "20.12.7",
-		"@types/yargs": "17.0.22",
-		"@typescript-eslint/eslint-plugin": "7.6.0",
-		"@typescript-eslint/parser": "7.6.0",
-		"chalk": "4.1.2",
-		"eslint": "8.57.0",
-		"eslint-config-prettier": "9.1.0",
-		"husky": "9.0.11",
-		"jest": "^29.7.0",
-		"prettier": "3.2.5",
-		"reflect-metadata": "0.2.2",
-		"release-it": "16.3.0",
-		"shx": "0.3.4",
-		"ts-jest": "^29.2.5",
-		"tsx": "^4.19.2",
-		"typescript": "5.2.2"
-	},
-	"release-it": {
-		"git": {
-			"commitMessage": "chore: release ${version}"
-		},
-		"github": {
-			"release": true
-		},
-		"npm": {
-			"publish": false
-		},
-		"plugins": {
-			"@release-it/conventional-changelog": {
-				"infile": "CHANGELOG.md",
-				"preset": {
-					"name": "conventionalcommits",
-					"types": [
-						{
-							"type": "feat",
-							"section": "Features"
-						},
-						{
-							"type": "fix",
-							"section": "Bug Fixes"
-						},
-						{
-							"type": "perf",
-							"section": "Performance Improvements"
-						},
-						{
-							"type": "revert",
-							"section": "Reverts"
-						},
-						{
-							"type": "docs",
-							"section": "Documentation"
-						},
-						{
-							"type": "style",
-							"section": "Styles"
-						},
-						{
-							"type": "refactor",
-							"section": "Code Refactoring"
-						},
-						{
-							"type": "test",
-							"section": "Tests"
-						},
-						{
-							"type": "build",
-							"section": "Build System"
-						},
-						{
-							"type": "ci",
-							"section": "Continuous Integrations"
-						},
-						{
-							"type": "chore",
-							"hidden": true
-						}
-					]
-				}
-			}
-		}
-	}
+  "name": "@expressots/cli",
+  "version": "4.0.0-preview.3",
+  "description": "Expressots CLI - modern, fast, lightweight nodejs web framework (@cli)",
+  "author": "Richard Zampieri",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/expressots/expressots-cli/issues"
+  },
+  "bin": {
+    "expressots": "bin/cli.js",
+    "ex": "bin/cli.js"
+  },
+  "engines": {
+    "node": ">=20.18.0"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/expressots"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/expressots/expressots-cli"
+  },
+  "homepage": "https://expresso-ts.com",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "ExpressoTS",
+    "CLI",
+    "Scaffolding"
+  ],
+  "scripts": {
+    "prepare": "husky",
+    "start:build": "npm run build && npm run start",
+    "start": "node ./bin/cli.js",
+    "start:dev": "tsx ./src/cli.ts",
+    "build": "npm run clean && tsc -p tsconfig.json && npm run cp:templates && node scripts/chmod.js ./bin/cli.js",
+    "cp:templates": "node scripts/cp.js ./src/generate/templates ./bin/generate/",
+    "clean": "node scripts/rm.js bin",
+    "prepublish": "npm run build && npm pack",
+    "format": "prettier --write \"./src/**/*.ts\" --cache",
+    "lint": "eslint \"./src/**/*.ts\" --cache --cache-location node_modules/.cache/eslint/",
+    "lint:fix": "eslint \"./src/**/*.ts\" --fix --cache --cache-location node_modules/.cache/eslint/",
+    "release": "release-it",
+    "release:prepare": "node scripts/release/prepare-publish.mjs",
+    "release:restore": "node scripts/release/restore-package-json.mjs",
+    "release:publish": "npm run build && npm run release:prepare && npm publish --tag next --access public && npm run release:restore",
+    "test": "jest",
+    "coverage": "jest --coverage",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@expressots/shared": "^4.0.0-preview.3",
+    "chalk": "4.1.2",
+    "cli-progress": "3.12.0",
+    "cross-spawn": "7.0.6",
+    "degit": "2.8.4",
+    "glob": "13.0.6",
+    "inquirer": "^8.2.7",
+    "mustache": "4.2.0",
+    "ora": "5.4.1",
+    "semver": "7.6.3",
+    "ts-node": "10.9.2",
+    "yargs": "17.7.2"
+  },
+  "devDependencies": {
+    "@codecov/vite-plugin": "^2.0.1",
+    "@commitlint/cli": "19.2.1",
+    "@commitlint/config-conventional": "19.1.0",
+    "@release-it/conventional-changelog": "^11.0.0",
+    "@types/cli-progress": "3.11.0",
+    "@types/cross-spawn": "6.0.6",
+    "@types/degit": "2.8.3",
+    "@types/inquirer": "9.0.3",
+    "@types/jest": "^29.5.14",
+    "@types/mustache": "4.2.2",
+    "@types/node": "20.12.7",
+    "@types/yargs": "17.0.22",
+    "@typescript-eslint/eslint-plugin": "7.6.0",
+    "@typescript-eslint/parser": "7.6.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "husky": "9.0.11",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.10",
+    "prettier": "3.2.5",
+    "reflect-metadata": "0.2.2",
+    "release-it": "^20.0.1",
+    "shx": "0.3.4",
+    "ts-jest": "^29.2.5",
+    "tsx": "^4.19.2",
+    "typescript": "5.2.2"
+  },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "eslint --cache --cache-location node_modules/.cache/eslint/ --fix",
+      "prettier --write --cache"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "infile": "CHANGELOG.md",
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "perf",
+              "section": "Performance Improvements"
+            },
+            {
+              "type": "revert",
+              "section": "Reverts"
+            },
+            {
+              "type": "docs",
+              "section": "Documentation"
+            },
+            {
+              "type": "style",
+              "section": "Styles"
+            },
+            {
+              "type": "refactor",
+              "section": "Code Refactoring"
+            },
+            {
+              "type": "test",
+              "section": "Tests"
+            },
+            {
+              "type": "build",
+              "section": "Build System"
+            },
+            {
+              "type": "ci",
+              "section": "Continuous Integrations"
+            },
+            {
+              "type": "chore",
+              "hidden": true
+            }
+          ]
+        }
+      }
+    }
+  }
 }