create-nattyjs 0.0.1-beta.69 → 0.0.1-beta.71

package/index.js

@@ -1,349 +1,92 @@
-#!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import minimist from "minimist";
-import prompts from "prompts";
-import { fileURLToPath } from "url";
-import { red, reset } from "kolorist";
-
-const argv = minimist(process.argv.slice(2), {
-    string: ["template"],
-    boolean: ["examples"],
-    alias: {
-        t: "template",
-        e: "examples",
-    },
-});
-
-const cwd = process.cwd();
-
-const renameFiles = {
-    _gitignore: ".gitignore",
-};
-
-const TEMPLATE_DEFINITIONS = [
-    {
-        id: "api-only",
-        aliases: ["nattyjs-blank"],
-        title: "API Only",
-        description: "Backend API (current blank template)",
-        templateDir: "template-nattyjs-blank",
-        exampleExcludedPaths: ["controllers"],
-    },
-    {
-        id: "fullstack-vue",
-        aliases: ["vue", "nattyjs-vue"],
-        title: "Fullstack + Vue",
-        description: "NattyJS API + Vue (Vite)",
-        templateDir: "template-fullstack-vue",
-        exampleOverlayDir: "__examples",
-    },
-    {
-        id: "fullstack-react",
-        aliases: ["react", "nattyjs-react"],
-        title: "Fullstack + React",
-        description: "NattyJS API + React (Vite)",
-        templateDir: "template-fullstack-react",
-        exampleOverlayDir: "__examples",
-    },
-    {
-        id: "fullstack-next",
-        aliases: ["next", "nextjs", "nattyjs-next"],
-        title: "Fullstack + Next.js",
-        description: "NattyJS API + Next.js",
-        templateDir: "template-fullstack-next",
-        exampleOverlayDir: "__examples",
-    },
-    {
-        id: "fullstack-nuxt",
-        aliases: ["nuxt", "nuxtjs", "nattyjs-nuxt"],
-        title: "Fullstack + Nuxt",
-        description: "NattyJS API + Nuxt",
-        templateDir: "template-fullstack-nuxt",
-        exampleOverlayDir: "__examples",
-    },
-    {
-        id: "fullstack-angular",
-        aliases: ["angular", "ng", "nattyjs-angular"],
-        title: "Fullstack + Angular",
-        description: "NattyJS API + Angular",
-        templateDir: "template-fullstack-angular",
-        exampleOverlayDir: "__examples",
-    },
-    {
-        id: "fullstack-astro",
-        aliases: ["astro", "nattyjs-astro"],
-        title: "Fullstack + Astro",
-        description: "NattyJS API + Astro",
-        templateDir: "template-fullstack-astro",
-        exampleOverlayDir: "__examples",
-    },
-    {
-        id: "fullstack-sveltekit",
-        aliases: ["sveltekit", "svelte-kit", "svelte", "nattyjs-sveltekit"],
-        title: "Fullstack + SvelteKit",
-        description: "NattyJS API + SvelteKit",
-        templateDir: "template-fullstack-sveltekit",
-        exampleOverlayDir: "__examples",
-    },
-];
-
-if (process.env.NATTYJS_PROMPT_INJECT) {
-    prompts.inject(JSON.parse(process.env.NATTYJS_PROMPT_INJECT));
-}
-
-function readJson(filePath) {
-    if (!fs.existsSync(filePath)) {
-        return undefined;
-    }
-
-    return JSON.parse(fs.readFileSync(filePath, "utf-8"));
-}
-
-function getTemplateById(value) {
-    if (!value) {
-        return undefined;
-    }
-
-    return TEMPLATE_DEFINITIONS.find((template) => {
-        return template.id === value || template.aliases.includes(value);
-    });
-}
-
-function isValidPackageName(projectName) {
-    return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(projectName);
-}
-
-function toValidPackageName(projectName) {
-    return projectName
-        .trim()
-        .toLowerCase()
-        .replace(/\s+/g, "-")
-        .replace(/^[._]/, "")
-        .replace(/[^a-z0-9-~]+/g, "-");
-}
-
-function isEmpty(dirPath) {
-    const files = fs.readdirSync(dirPath);
-    return files.length === 0 || (files.length === 1 && files[0] === ".git");
-}
-
-function emptyDir(dir) {
-    if (!fs.existsSync(dir)) {
-        return;
-    }
-
-    for (const file of fs.readdirSync(dir)) {
-        const absolutePath = path.resolve(dir, file);
-        if (fs.lstatSync(absolutePath).isDirectory()) {
-            emptyDir(absolutePath);
-            fs.rmdirSync(absolutePath);
-        } else {
-            fs.unlinkSync(absolutePath);
-        }
-    }
-}
-
-function copy(src, dest) {
-    const stat = fs.statSync(src);
-    if (stat.isDirectory()) {
-        copyDir(src, dest);
-        return;
-    }
-
-    fs.copyFileSync(src, dest);
-}
-
-function copyDir(srcDir, destDir) {
-    fs.mkdirSync(destDir, { recursive: true });
-    for (const file of fs.readdirSync(srcDir)) {
-        const srcFile = path.resolve(srcDir, file);
-        const destFile = path.resolve(destDir, file);
-        copy(srcFile, destFile);
-    }
-}
-
-function pkgFromUserAgent(userAgent) {
-    if (!userAgent) {
-        return undefined;
-    }
-
-    const pkgSpec = userAgent.split(" ")[0];
-    const [name, version] = pkgSpec.split("/");
-    return { name, version };
-}
-
-function shouldSkipTemplateFile(relativePath, template, includeExamples) {
-    if (includeExamples) {
-        return false;
-    }
-
-    const excludedPaths = template.exampleExcludedPaths || [];
-    return excludedPaths.some((excludedPath) => {
-        return relativePath === excludedPath || relativePath.startsWith(`${excludedPath}${path.sep}`);
-    });
-}
-
-function copyTemplateContents(templateDir, root, template, includeExamples) {
-    const entries = fs.readdirSync(templateDir);
-    for (const entry of entries) {
-        if (entry === "package.json") {
-            continue;
-        }
-
-        if (entry === template.exampleOverlayDir) {
-            continue;
-        }
-
-        if (shouldSkipTemplateFile(entry, template, includeExamples)) {
-            continue;
-        }
-
-        const sourcePath = path.join(templateDir, entry);
-        const targetPath = renameFiles[entry]
-            ? path.join(root, renameFiles[entry])
-            : path.join(root, entry);
-
-        copy(sourcePath, targetPath);
-    }
-
-    if (includeExamples && template.exampleOverlayDir) {
-        const overlayDir = path.join(templateDir, template.exampleOverlayDir);
-        if (fs.existsSync(overlayDir)) {
-            copyDir(overlayDir, root);
-        }
-    }
-}
-
-async function resolveProjectOptions() {
-    let targetDir = typeof argv._[0] === "string" ? argv._[0].trim() : "";
-    let selectedTemplate = getTemplateById(argv.template);
-    const defaultProjectName = targetDir || "nattyjs-project";
-
-    try {
-        return await prompts(
-            [
-                {
-                    type: targetDir ? null : "text",
-                    name: "projectName",
-                    message: reset("Project name:"),
-                    initial: defaultProjectName,
-                    validate: (value) => {
-                        const trimmed = value.trim();
-                        return trimmed.length > 0 || "Project name is required";
-                    },
-                    onState: (state) => {
-                        targetDir = state.value.trim() || defaultProjectName;
-                    },
-                },
-                {
-                    type: () => {
-                        return !targetDir || !fs.existsSync(targetDir) || isEmpty(targetDir) ? null : "confirm";
-                    },
-                    name: "overwrite",
-                    message: () => {
-                        const label = targetDir === "." ? "Current directory" : `Target directory "${targetDir}"`;
-                        return `${label} is not empty. Remove existing files and continue?`;
-                    },
-                    initial: false,
-                },
-                {
-                    type: (_, { overwrite } = {}) => {
-                        if (overwrite === false) {
-                            throw new Error(`${red("x")} Operation cancelled`);
-                        }
-                        return null;
-                    },
-                    name: "overwriteChecker",
-                },
-                {
-                    type: () => (isValidPackageName(path.basename(targetDir || defaultProjectName)) ? null : "text"),
-                    name: "packageName",
-                    message: reset("Package name:"),
-                    initial: () => toValidPackageName(path.basename(targetDir || defaultProjectName)),
-                    validate: (value) => isValidPackageName(value) || "Invalid package.json name",
-                },
-                {
-                    type: selectedTemplate ? null : "select",
-                    name: "templateId",
-                    message: reset("Select a template:"),
-                    choices: TEMPLATE_DEFINITIONS.map((template) => ({
-                        title: template.title,
-                        description: template.description,
-                        value: template.id,
-                    })),
-                },
-                {
-                    type: typeof argv.examples === "boolean" ? null : "toggle",
-                    name: "includeExamples",
-                    message: reset("Include examples?"),
-                    initial: true,
-                    active: "Yes",
-                    inactive: "No",
-                },
-            ],
-            {
-                onCancel: () => {
-                    throw new Error(`${red("x")} Operation cancelled`);
-                },
-            }
-        );
-    } catch (error) {
-        console.log(error.message);
-        return undefined;
-    }
-}
-
-async function initNatty() {
-    const promptResult = await resolveProjectOptions();
-    if (!promptResult) {
-        return;
-    }
-
-    const targetDir = (promptResult.projectName || argv._[0] || "").trim() || "nattyjs-project";
-    const template = getTemplateById(promptResult.templateId || argv.template) || TEMPLATE_DEFINITIONS[0];
-    const includeExamples = typeof argv.examples === "boolean" ? argv.examples : promptResult.includeExamples !== false;
-    const root = path.join(cwd, targetDir);
-
-    if (promptResult.overwrite) {
-        emptyDir(root);
-    } else if (!fs.existsSync(root)) {
-        fs.mkdirSync(root, { recursive: true });
-    }
-
-    const __filename = fileURLToPath(import.meta.url);
-    const __dirname = path.dirname(__filename);
-    const templateDir = path.join(__dirname, template.templateDir);
-
-    console.log(`\nScaffolding project in ${root}...`);
-
-    copyTemplateContents(templateDir, root, template, includeExamples);
-
-    const packageJsonPath = path.join(templateDir, "package.json");
-    const pkg = readJson(packageJsonPath);
-    const packageName = promptResult.packageName || toValidPackageName(path.basename(targetDir));
-    pkg.name = packageName;
-    fs.writeFileSync(path.join(root, "package.json"), JSON.stringify(pkg, null, 2));
-
-    const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
-    const pkgManager = pkgInfo ? pkgInfo.name : "npm";
-
-    console.log("\nDone. Now run:\n");
-    if (root !== cwd) {
-        console.log(`  cd ${path.relative(cwd, root)}`);
-    }
-
-    if (pkgManager === "yarn") {
-        console.log("  yarn");
-        console.log("  yarn dev");
-    } else {
-        console.log(`  ${pkgManager} install`);
-        console.log(`  ${pkgManager} run dev`);
-    }
-
-    console.log();
-}
-
-initNatty().catch((error) => {
-    console.error(error);
-});
+#!/usr/bin/env node
+import path from "path";
+import minimist from "minimist";
+import prompts from "prompts";
+import { fileURLToPath } from "url";
+import { getTemplateById, TEMPLATE_DEFINITIONS } from "./src/const/template-definitions.js";
+import { printIntro, formatSuccessSummary } from "./src/functions/cli-theme.js";
+import { pkgFromUserAgent } from "./src/functions/package-manager.js";
+import { toValidPackageName } from "./src/functions/package-name.js";
+import { resolveProjectOptions } from "./src/functions/prompt-project-options.js";
+import { prepareTargetDirectory, scaffoldProject } from "./src/functions/scaffold-project.js";
+import { getWorkspaceById, isFullstackTemplate } from "./src/const/workspace-definitions.js";
+
+const argv = minimist(process.argv.slice(2), {
+    string: ["template", "workspace"],
+    boolean: ["examples"],
+    alias: {
+        t: "template",
+        e: "examples",
+        w: "workspace",
+    },
+});
+const rawArguments = process.argv.slice(2);
+const examplesFlagProvided = rawArguments.some((argument) => {
+    return argument === "--examples" || argument === "--no-examples" || argument === "-e";
+});
+
+const cwd = process.cwd();
+
+if (process.env.NATTYJS_PROMPT_INJECT) {
+    prompts.inject(JSON.parse(process.env.NATTYJS_PROMPT_INJECT));
+}
+
+async function initNatty() {
+    printIntro();
+    const selectedTemplate = getTemplateById(argv.template);
+    const defaultProjectName =
+        (typeof argv._[0] === "string" ? argv._[0].trim() : "") || "nattyjs-project";
+    const promptResult = await resolveProjectOptions({
+        argv,
+        defaultProjectName,
+        selectedTemplate,
+        templateDefinitions: TEMPLATE_DEFINITIONS,
+        examplesFlagProvided,
+    });
+    if (!promptResult) {
+        return;
+    }
+
+    const targetDir = (promptResult.projectName || argv._[0] || "").trim() || "nattyjs-project";
+    const template = getTemplateById(promptResult.templateId || argv.template) || TEMPLATE_DEFINITIONS[0];
+    const isFullstack = isFullstackTemplate(template);
+    const workspaceSetup = (promptResult.workspaceSetup || argv.workspace || "standalone").trim();
+    const selectedWorkspace = isFullstack ? getWorkspaceById(workspaceSetup) || getWorkspaceById("standalone") : undefined;
+    const includeExamples = examplesFlagProvided ? argv.examples : promptResult.includeExamples !== false;
+    const root = path.join(cwd, targetDir);
+
+    prepareTargetDirectory(root, promptResult.overwrite);
+
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = path.dirname(__filename);
+
+    console.log(`\nScaffolding project in ${root}...`);
+
+    const packageName = promptResult.packageName || toValidPackageName(path.basename(targetDir));
+    scaffoldProject({
+        cwd,
+        root,
+        targetDir,
+        template,
+        includeExamples,
+        packageName,
+        packageBaseDir: __dirname,
+        workspaceSetup: selectedWorkspace?.id,
+        isFullstack,
+    });
+
+    const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
+    const pkgManager = pkgInfo ? pkgInfo.name : "npm";
+    formatSuccessSummary({
+        cwd,
+        root,
+        packageManager: pkgManager,
+        template,
+        workspace: selectedWorkspace,
+        includeExamples,
+    });
+}
+
+initNatty().catch((error) => {
+    console.error(error);
+});

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "create-nattyjs",
-  "version": "0.0.1-beta.69",
+  "version": "0.0.1-beta.71",
   "description": "Create NattyJS API Project",
   "main": "./index.js",
-  "types": "./dist/index.d.ts",
   "type": "module",
   "files": [
+    "index.js",
+    "src",
     "template-nattyjs-blank",
     "template-fullstack-vue",
     "template-fullstack-react",
@@ -16,7 +17,7 @@
     "template-fullstack-sveltekit"
   ],
   "scripts": {
-    "test": "echo \"No tests defined\""
+    "test": "node --test test"
   },
   "author": "ajayojha",
   "license": "MIT",

package/src/const/template-definitions.js

@@ -0,0 +1,76 @@
+export const TEMPLATE_DEFINITIONS = [
+    {
+        id: "api-only",
+        aliases: ["nattyjs-blank"],
+        title: "API Only",
+        description: "Backend API starter with NattyJS conventions",
+        templateDir: "template-nattyjs-blank",
+        exampleExcludedPaths: ["controllers"],
+    },
+    {
+        id: "fullstack-vue",
+        aliases: ["vue", "nattyjs-vue"],
+        title: "Fullstack + Vue",
+        description: "NattyJS API + Vue (Vite) + typed client",
+        templateDir: "template-fullstack-vue",
+        exampleOverlayDir: "__examples",
+    },
+    {
+        id: "fullstack-react",
+        aliases: ["react", "nattyjs-react"],
+        title: "Fullstack + React",
+        description: "NattyJS API + React (Vite) + typed client",
+        templateDir: "template-fullstack-react",
+        exampleOverlayDir: "__examples",
+    },
+    {
+        id: "fullstack-next",
+        aliases: ["next", "nextjs", "nattyjs-next"],
+        title: "Fullstack + Next.js",
+        description: "NattyJS API + Next.js + typed client",
+        templateDir: "template-fullstack-next",
+        exampleOverlayDir: "__examples",
+    },
+    {
+        id: "fullstack-nuxt",
+        aliases: ["nuxt", "nuxtjs", "nattyjs-nuxt"],
+        title: "Fullstack + Nuxt",
+        description: "NattyJS API + Nuxt + typed client",
+        templateDir: "template-fullstack-nuxt",
+        exampleOverlayDir: "__examples",
+    },
+    {
+        id: "fullstack-angular",
+        aliases: ["angular", "ng", "nattyjs-angular"],
+        title: "Fullstack + Angular",
+        description: "NattyJS API + Angular + typed client",
+        templateDir: "template-fullstack-angular",
+        exampleOverlayDir: "__examples",
+    },
+    {
+        id: "fullstack-astro",
+        aliases: ["astro", "nattyjs-astro"],
+        title: "Fullstack + Astro",
+        description: "NattyJS API + Astro + typed client",
+        templateDir: "template-fullstack-astro",
+        exampleOverlayDir: "__examples",
+    },
+    {
+        id: "fullstack-sveltekit",
+        aliases: ["sveltekit", "svelte-kit", "svelte", "nattyjs-sveltekit"],
+        title: "Fullstack + SvelteKit",
+        description: "NattyJS API + SvelteKit + typed client",
+        templateDir: "template-fullstack-sveltekit",
+        exampleOverlayDir: "__examples",
+    },
+];
+
+export function getTemplateById(value) {
+    if (!value) {
+        return undefined;
+    }
+
+    return TEMPLATE_DEFINITIONS.find((template) => {
+        return template.id === value || template.aliases.includes(value);
+    });
+}

package/src/const/version-registry.js

@@ -0,0 +1,73 @@
+import fs from "fs";
+import path from "path";
+
+const FRONTEND_PACKAGE_VERSIONS = {
+    concurrently: "^9.0.1",
+    turbo: "^2.1.3",
+    nx: "^20.0.0",
+    "@vitejs/plugin-vue": "^5.1.4",
+    "@vitejs/plugin-react": "^4.3.2",
+    vue: "^3.5.13",
+    "vue-tsc": "^2.1.6",
+    vite: "^5.4.8",
+    react: "^18.3.1",
+    "react-dom": "^18.3.1",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    next: "^14.2.15",
+    nuxt: "^3.13.2",
+    "@angular/animations": "^18.2.8",
+    "@angular/common": "^18.2.8",
+    "@angular/compiler": "^18.2.8",
+    "@angular/core": "^18.2.8",
+    "@angular/forms": "^18.2.8",
+    "@angular/platform-browser": "^18.2.8",
+    "@angular/platform-browser-dynamic": "^18.2.8",
+    "@angular/router": "^18.2.8",
+    "@angular-devkit/build-angular": "^18.2.8",
+    "@angular/cli": "^18.2.8",
+    "@angular/compiler-cli": "^18.2.8",
+    rxjs: "^7.8.1",
+    tslib: "^2.7.0",
+    "zone.js": "^0.14.10",
+    astro: "^4.16.12",
+    "@sveltejs/adapter-auto": "^3.2.5",
+    "@sveltejs/kit": "^2.7.1",
+    "@sveltejs/vite-plugin-svelte": "^3.1.2",
+    svelte: "^4.2.19",
+    "svelte-check": "^4.0.4",
+    typescript: "^5.6.3",
+    "@types/node": "^22.7.4",
+    "reflect-metadata": "^0.2.2",
+    mri: "^1.2.0",
+    prompts: "^2.4.2",
+};
+
+const NATTY_PACKAGE_NAMES = [
+    "@nattyjs/cli",
+    "@nattyjs/client",
+    "@nattyjs/common",
+    "@nattyjs/core",
+    "@nattyjs/entity",
+    "@nattyjs/express",
+    "@nattyjs/orm",
+    "@nattyjs/types",
+    "@nattyjs/validation-decorators",
+];
+
+export function getVersionRegistry(packageBaseDir) {
+    const createPackageJsonPath = path.join(packageBaseDir, "package.json");
+    const createPackageJson = JSON.parse(fs.readFileSync(createPackageJsonPath, "utf8"));
+    const nattyVersion = createPackageJson.version;
+    const versions = {
+        ...FRONTEND_PACKAGE_VERSIONS,
+    };
+
+    for (const packageName of NATTY_PACKAGE_NAMES) {
+        versions[packageName] = nattyVersion;
+    }
+
+    return {
+        versions,
+    };
+}

package/src/const/workspace-definitions.js

@@ -0,0 +1,55 @@
+export const PROJECT_LAYOUT_DEFINITIONS = [
+    {
+        id: "standalone",
+        title: "Single Repo",
+        description: "api/ + web/ folders with the simplest dev flow",
+        recommended: true,
+    },
+    {
+        id: "monorepo",
+        title: "Monorepo",
+        description: "apps/api + apps/web with a dedicated workspace tool",
+    },
+];
+
+export const WORKSPACE_DEFINITIONS = [
+    {
+        id: "standalone",
+        title: "Single Repo",
+        description: "api/ + web/ folders with no workspace tool",
+    },
+    {
+        id: "npm-workspaces",
+        title: "npm workspaces",
+        description: "Simple npm-native monorepo",
+        recommended: true,
+    },
+    {
+        id: "turborepo",
+        title: "Turborepo",
+        description: "Fast task orchestration and caching",
+    },
+    {
+        id: "nx",
+        title: "Nx",
+        description: "Structured workspace tooling and task graph",
+    },
+];
+
+export const MONOREPO_WORKSPACE_DEFINITIONS = WORKSPACE_DEFINITIONS.filter((workspace) => {
+    return workspace.id !== "standalone";
+});
+
+const FULLSTACK_TEMPLATE_PREFIX = "fullstack-";
+
+export function isFullstackTemplate(template) {
+    return Boolean(template?.id?.startsWith(FULLSTACK_TEMPLATE_PREFIX));
+}
+
+export function getWorkspaceById(value) {
+    if (!value) {
+        return undefined;
+    }
+
+    return WORKSPACE_DEFINITIONS.find((workspace) => workspace.id === value);
+}