@codabytez/create-next-template 0.1.4 → 0.1.5

package/dist/index.js

@@ -26,13 +26,13 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 // src/index.ts
 var p2 = __toESM(require("@clack/prompts"));
 var import_chalk2 = __toESM(require("chalk"));
-var import_path6 = __toESM(require("path"));
+var import_path7 = __toESM(require("path"));
 
 // src/installer.ts
 var p = __toESM(require("@clack/prompts"));
 var import_chalk = __toESM(require("chalk"));
-var import_fs_extra5 = __toESM(require("fs-extra"));
-var import_path5 = __toESM(require("path"));
+var import_fs_extra6 = __toESM(require("fs-extra"));
+var import_path6 = __toESM(require("path"));
 
 // src/helpers/copy.ts
 var import_fs_extra = __toESM(require("fs-extra"));
@@ -248,6 +248,77 @@ export default function RootLayout({
   await import_fs_extra4.default.writeFile(import_path4.default.join(appDir, "layout.tsx"), layoutContent);
 }
 
+// src/generators/readme.ts
+var import_fs_extra5 = __toESM(require("fs-extra"));
+var import_path5 = __toESM(require("path"));
+var FEATURE_LABELS = {
+  animations: "Framer Motion",
+  dataFetching: "TanStack Query + Axios",
+  forms: "React Hook Form + Zod",
+  extraIcons: "Iconsax React",
+  auth: "Clerk",
+  prisma: "Prisma (PostgreSQL)",
+  convex: "Convex",
+  appwrite: "Appwrite",
+  ui: "shadcn/ui"
+};
+async function generateReadme(projectPath, projectName, packageManager, features) {
+  const featureList = features.filter((f) => FEATURE_LABELS[f]).map((f) => `- ${FEATURE_LABELS[f]}`).join("\n");
+  const hasPrisma = features.includes("prisma");
+  const hasConvex = features.includes("convex");
+  const hasAuth = features.includes("auth");
+  const hasShadcn = features.includes("ui");
+  const envSection = hasPrisma || hasConvex || hasAuth ? `
+## Environment Variables
+
+Copy \`.env.example\` to \`.env\` and fill in the required values:
+
+\`\`\`bash
+cp .env.example .env
+\`\`\`
+` : "";
+  const extraSteps = [];
+  if (hasShadcn) extraSteps.push(`npx shadcn@latest init`);
+  if (hasPrisma) extraSteps.push(`npx prisma migrate dev`);
+  if (hasConvex) extraSteps.push(`npx convex dev`);
+  const extraSection = extraSteps.length > 0 ? `
+## Additional Setup
+
+\`\`\`bash
+${extraSteps.join("\n")}
+\`\`\`
+` : "";
+  const content = `# ${projectName}
+
+A [Next.js](https://nextjs.org) project bootstrapped with [create-next-template](https://github.com/codabytez/create-next-template).
+
+## Tech Stack
+
+- [Next.js](https://nextjs.org)
+- [TypeScript](https://www.typescriptlang.org)
+- [Tailwind CSS](https://tailwindcss.com)
+${featureList ? featureList + "\n" : ""}
+## Getting Started
+
+\`\`\`bash
+${packageManager} run dev
+\`\`\`
+
+Open [http://localhost:3000](http://localhost:3000) in your browser.
+${envSection}${extraSection}
+## Code Quality
+
+This project uses ESLint, Prettier, and Husky pre-commit hooks to enforce consistent code style.
+
+\`\`\`bash
+${packageManager} run lint          # lint
+${packageManager} run format        # format
+${packageManager} run check-types   # type check
+\`\`\`
+`;
+  await import_fs_extra5.default.writeFile(import_path5.default.join(projectPath, "README.md"), content);
+}
+
 // src/installer.ts
 var FEATURE_TEMPLATE_MAP = {
   animations: "animations",
@@ -269,7 +340,7 @@ async function runInstaller({
 }) {
   const s = p.spinner();
   if (!inPlace) {
-    if (await import_fs_extra5.default.pathExists(projectPath)) {
+    if (await import_fs_extra6.default.pathExists(projectPath)) {
       const overwrite = await p.confirm({
         message: `Directory "${projectName}" already exists. Overwrite?`
       });
@@ -277,9 +348,9 @@ async function runInstaller({
         p.cancel("Operation cancelled");
         process.exit(0);
       }
-      await import_fs_extra5.default.remove(projectPath);
+      await import_fs_extra6.default.remove(projectPath);
     }
-    await import_fs_extra5.default.ensureDir(projectPath);
+    await import_fs_extra6.default.ensureDir(projectPath);
   }
   s.start("Scaffolding project structure");
   await copyTemplate("base", projectPath);
@@ -290,12 +361,13 @@ async function runInstaller({
     }
   }
   await generateLayout(projectPath, features);
+  await generateReadme(projectPath, projectName, packageManager, features);
   await mergeEnvExamples(projectPath, features);
-  const huskyDir = import_path5.default.join(projectPath, ".husky");
+  const huskyDir = import_path6.default.join(projectPath, ".husky");
   for (const hook of ["pre-commit", "pre-push"]) {
-    const hookPath = import_path5.default.join(huskyDir, hook);
-    if (await import_fs_extra5.default.pathExists(hookPath)) {
-      await import_fs_extra5.default.chmod(hookPath, 493);
+    const hookPath = import_path6.default.join(huskyDir, hook);
+    if (await import_fs_extra6.default.pathExists(hookPath)) {
+      await import_fs_extra6.default.chmod(hookPath, 493);
     }
   }
   s.stop("Project structure scaffolded");
@@ -312,6 +384,8 @@ async function runInstaller({
   }
   s.start("Initializing git repository");
   await runCommand("git", ["init"], projectPath);
+  await runCommand("git", ["rm", "-r", "--cached", "--quiet", "."], projectPath).catch(() => {
+  });
   await runCommand("git", ["add", "-A"], projectPath);
   await runCommand(
     "git",
@@ -366,7 +440,7 @@ async function main() {
   p2.intro(import_chalk2.default.bgCyan(import_chalk2.default.black(" create-next-template ")));
   const dirArg = args.find((a) => !a.startsWith("-"));
   const inPlace = dirArg === ".";
-  const defaultName = inPlace ? import_path6.default.basename(process.cwd()) : dirArg ?? void 0;
+  const defaultName = inPlace ? import_path7.default.basename(process.cwd()) : dirArg ?? void 0;
   const projectName = await p2.text({
     message: "What is your project name?",
     placeholder: "my-next-app",
@@ -430,7 +504,7 @@ async function main() {
       `You selected multiple databases (${dbChoices.join(", ")}). This is supported but may require manual configuration.`
     );
   }
-  const projectPath = inPlace ? process.cwd() : import_path6.default.resolve(process.cwd(), projectName);
+  const projectPath = inPlace ? process.cwd() : import_path7.default.resolve(process.cwd(), projectName);
   await runInstaller({
     projectName,
     projectPath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codabytez/create-next-template",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "CLI to scaffold Next.js projects with your preferred stack",
   "bin": {
     "create-next-template": "./dist/index.js"