nuxt-bake 1.0.1

package/README.md

@@ -0,0 +1,79 @@
+# nuxt-bake
+
+A CLI tool to quickly scaffold a Nuxt.js starter project with modern tools and best practices.
+
+## Testing
+
+The project includes unit and end-to-end tests set up with Vitest and Playwright. For development, you can run the tests using the following commands:
+
+- To run unit tests with Vitest:
+
+```bash
+npm run test
+```
+
+- To check test coverage:
+
+```bash
+npm run coverage
+```
+
+- To run end-to-end tests with Playwright:
+
+```bash
+npm run test:e2e
+```
+
+## Publishing the Package
+
+The package includes release scripts that handle versioning and publishing:
+
+```bash
+# For bug fixes (1.0.10 → 1.0.11)
+npm run release:patch
+
+# For new features (1.0.10 → 1.1.0)
+npm run release:minor
+
+# For breaking changes (1.0.10 → 2.0.0)
+npm run release:major
+```
+
+Each script will:
+
+1. Bump the version accordingly
+2. Publish to npm with public access
+
+## Usage
+
+Create a new project using npx:
+
+```bash
+npx nuxt-bake
+
+# or install globally:
+npm install -g nuxt-bake
+nuxt-bake
+```
+
+You’ll be prompted to choose:
+
+- Project name
+- Features (i18n, testing, etc.)
+- Install dependencies?
+- Package manager (npm, pnpm, yarn)
+- Git repository initialization?
+
+After setup, you’ll have a fresh Nuxt.js project ready to go!
+
+## Contact
+
+Feel free to reach out to discuss collaboration opportunities or to say hello!
+
+- [**My Email**](mailto:matheus.felipe.19rt@gmail.com)
+- [**My LinkedIn Profile**](https://www.linkedin.com/in/matheus-mortari-19rt)
+- [**My GitHub Profile**](https://github.com/matimortari)
+
+## License
+
+This project is licensed under the [**MIT License**](https://github.com/matimortari/nuxt-bake/blob/main/LICENSE).

package/dist/helpers/constants.js

@@ -0,0 +1,28 @@
+export const REPO_URL = "https://github.com/matimortari/nuxtjs-starter.git";
+export const PRESET_EXTRA_SCRIPTS = {
+    "standard": {},
+    "with-i18n": {},
+    "with-tests": {
+        "test": "vitest",
+        "test:e2e": "playwright test",
+        "coverage": "vitest --coverage",
+    },
+};
+export const PRESET_EXTRA_PACKAGES = {
+    "standard": {},
+    "with-i18n": {
+        dependencies: {
+            "@nuxtjs/i18n": "10.2.1",
+        },
+    },
+    "with-tests": {
+        devDependencies: {
+            "@nuxt/test-utils": "3.19.2",
+            "@vitest/coverage-v8": "4.0.15",
+            "@vue/test-utils": "3.20.0",
+            "happy-dom": "13.7.6",
+            "@playwright/test": "1.57.0",
+            "vitest": "4.0.15",
+        },
+    },
+};

package/dist/helpers/git.js

@@ -0,0 +1,32 @@
+import { spawnSync } from "node:child_process";
+import os from "node:os";
+import path from "node:path";
+export function cloneRepoToTemp(repoUrl) {
+    const tmpDir = path.join(os.tmpdir(), `nuxtjs-starter-${Date.now()}`);
+    const result = spawnSync("git", ["clone", "--depth=1", "--quiet", repoUrl, tmpDir], {
+        stdio: "pipe",
+        shell: true,
+    });
+    if (result.error) {
+        console.error("Failed to get project from remote:", result.error.message);
+        return null;
+    }
+    if (result.status !== 0) {
+        console.error("Failed to clone repository");
+        return null;
+    }
+    return tmpDir;
+}
+export function promptAndInitGit(targetDir) {
+    const result = spawnSync("git", ["init", "--quiet"], {
+        cwd: targetDir,
+        stdio: "pipe",
+        shell: true,
+    });
+    if (result.error) {
+        console.error("Failed to initialize Git:", result.error.message);
+    }
+    else if (result.status !== 0) {
+        console.error("Git init failed");
+    }
+}

package/dist/helpers/package-manager.js

@@ -0,0 +1,77 @@
+import { execSync } from "node:child_process";
+import path from "node:path";
+import fs from "fs-extra";
+import inquirer from "inquirer";
+import ora from "ora";
+function mergeObjects(base = {}, extra = {}) {
+    return { ...base, ...extra };
+}
+export function createPackageManagerCommands(pkgManager) {
+    switch (pkgManager) {
+        case "yarn":
+            return {
+                name: "yarn",
+                installCmd: "yarn install",
+                runScript: (script) => `yarn ${script}`,
+            };
+        case "pnpm":
+            return {
+                name: "pnpm",
+                installCmd: "pnpm install",
+                runScript: (script) => `pnpm ${script}`,
+            };
+        case "bun":
+            return {
+                name: "bun",
+                installCmd: "bun install",
+                runScript: (script) => `bun run ${script}`,
+            };
+        case "npm":
+        default:
+            return {
+                name: "npm",
+                installCmd: "npm install",
+                runScript: (script) => `npm run ${script}`,
+            };
+    }
+}
+export async function promptForPackageManager() {
+    const { pkgManager } = await inquirer.prompt({
+        type: "list",
+        name: "pkgManager",
+        message: "Which package manager do you want to use?",
+        choices: [
+            { name: "npm", value: "npm" },
+            { name: "yarn", value: "yarn" },
+            { name: "pnpm", value: "pnpm" },
+            { name: "bun", value: "bun" },
+        ],
+        default: "npm",
+    });
+    return createPackageManagerCommands(pkgManager);
+}
+export async function installDependencies(targetDir, pkgManager) {
+    const spinner = ora("Installing dependencies...").start();
+    try {
+        spinner.stop();
+        execSync(pkgManager.installCmd, { cwd: targetDir, stdio: "inherit" });
+        execSync(pkgManager.runScript("lint:fix"), { cwd: targetDir, stdio: "ignore" });
+        spinner.succeed("Dependencies installed!");
+    }
+    catch (err) {
+        spinner.fail("Failed to install dependencies");
+        throw err;
+    }
+}
+export async function updatePackageJson(rootTemplateDir, targetDir, preset, extras) {
+    const rootPkgPath = path.join(rootTemplateDir, "package.json");
+    const targetPkgPath = path.join(targetDir, "package.json");
+    const rootPkg = JSON.parse(await fs.readFile(rootPkgPath, "utf8"));
+    const mergedPkg = {
+        ...rootPkg,
+        dependencies: mergeObjects(rootPkg.dependencies, extras.dependencies),
+        devDependencies: mergeObjects(rootPkg.devDependencies, extras.devDependencies),
+        scripts: mergeObjects(rootPkg.scripts, extras.scripts),
+    };
+    await fs.writeFile(targetPkgPath, JSON.stringify(mergedPkg, null, 2), "utf8");
+}

package/dist/helpers/template.js

@@ -0,0 +1,27 @@
+import path from "node:path";
+import fs from "fs-extra";
+export async function copyRootTemplate(tmpDir, targetDir) {
+    const rootTemplateDir = path.join(tmpDir, "package", "templates", "base");
+    if (!(await fs.pathExists(rootTemplateDir))) {
+        throw new Error(`Root template directory "${rootTemplateDir}" not found in the repo.`);
+    }
+    await fs.copy(rootTemplateDir, targetDir);
+    return rootTemplateDir;
+}
+export async function copyPresetFiles(tmpDir, preset, targetDir) {
+    const presetDir = path.join(tmpDir, "package", "templates", preset);
+    if (!(await fs.pathExists(presetDir))) {
+        throw new Error(`Preset directory "${presetDir}" not found in the repo.`);
+    }
+    const presetRootFiles = await fs.readdir(presetDir);
+    for (const file of presetRootFiles) {
+        if (file === "app") {
+            continue;
+        }
+        await fs.copy(path.join(presetDir, file), path.join(targetDir, file), { overwrite: true });
+    }
+    const presetAppDir = path.join(presetDir, "app");
+    if (await fs.pathExists(presetAppDir)) {
+        await fs.copy(presetAppDir, path.join(targetDir, "app"), { overwrite: true });
+    }
+}

package/dist/helpers/utils.js

@@ -0,0 +1,42 @@
+import path from "node:path";
+import fs from "fs-extra";
+import inquirer from "inquirer";
+export function getProjectNameFromArgs() {
+    const args = process.argv.slice(2);
+    const nIndex = args.findIndex(a => a === "-n" || a === "--name");
+    if (nIndex !== -1 && args.length > nIndex + 1) {
+        return args[nIndex + 1];
+    }
+    return null;
+}
+export async function promptForProjectName() {
+    let projectName = getProjectNameFromArgs();
+    if (!projectName) {
+        const { projectName: answerName } = await inquirer.prompt({
+            type: "input",
+            name: "projectName",
+            message: "Enter your new project folder name:",
+            default: "my-nuxt-app",
+            validate: input => (input ? true : "Project folder name cannot be empty"),
+        });
+        projectName = answerName;
+    }
+    return projectName;
+}
+export async function validateTargetDirectory(projectName) {
+    const targetDir = path.resolve(process.cwd(), projectName);
+    const exists = await fs.pathExists(targetDir);
+    if (exists) {
+        const { overwrite } = await inquirer.prompt({
+            type: "confirm",
+            name: "overwrite",
+            message: `Directory "${projectName}" already exists. Overwrite?`,
+            default: false,
+        });
+        if (!overwrite) {
+            return null;
+        }
+        await fs.remove(targetDir);
+    }
+    return targetDir;
+}

package/dist/index.js

@@ -0,0 +1,96 @@
+#!/usr/bin/env node
+import fs from "fs-extra";
+import inquirer from "inquirer";
+import ora from "ora";
+import { PRESET_EXTRA_PACKAGES, PRESET_EXTRA_SCRIPTS, REPO_URL } from "./helpers/constants.js";
+import { cloneRepoToTemp, promptAndInitGit } from "./helpers/git.js";
+import { installDependencies, promptForPackageManager, updatePackageJson } from "./helpers/package-manager.js";
+import { copyPresetFiles, copyRootTemplate } from "./helpers/template.js";
+import { promptForProjectName, validateTargetDirectory } from "./helpers/utils.js";
+async function run() {
+    let tmpDir;
+    try {
+        const projectName = await promptForProjectName();
+        if (!projectName) {
+            console.log("\nProject name is required. Please provide a valid name.\n");
+            process.exit(1);
+        }
+        const targetDir = await validateTargetDirectory(projectName);
+        if (!targetDir) {
+            console.log(`\nFolder "${projectName}" already exists. Please choose another name or remove it.\n`);
+            process.exit(1);
+        }
+        const spinnerClone = ora("Creating project root...").start();
+        tmpDir = cloneRepoToTemp(REPO_URL);
+        if (!tmpDir) {
+            spinnerClone.fail("Failed to clone repository.");
+            process.exit(1);
+        }
+        const rootTemplateDir = await copyRootTemplate(tmpDir, targetDir);
+        spinnerClone.succeed();
+        const { preset } = await inquirer.prompt({
+            type: "list",
+            name: "preset",
+            message: "Select a preset:",
+            choices: [
+                { name: "Standard", value: "standard" },
+                { name: "With i18n", value: "with-i18n" },
+                { name: "With Tests", value: "with-tests" },
+            ],
+        });
+        await copyPresetFiles(tmpDir, preset, targetDir);
+        await updatePackageJson(rootTemplateDir, targetDir, preset, {
+            dependencies: PRESET_EXTRA_PACKAGES[preset]?.dependencies || {},
+            devDependencies: PRESET_EXTRA_PACKAGES[preset]?.devDependencies || {},
+            scripts: PRESET_EXTRA_SCRIPTS[preset] || {},
+        });
+        const { installDeps } = await inquirer.prompt({
+            type: "confirm",
+            name: "installDeps",
+            message: "Install dependencies now?",
+            default: true,
+        });
+        if (installDeps) {
+            const pkgManager = await promptForPackageManager();
+            const spinnerInstall = ora("Installing dependencies...").start();
+            await installDependencies(targetDir, pkgManager);
+            spinnerInstall.succeed("Dependencies installed!");
+        }
+        const { initGit } = await inquirer.prompt({
+            type: "confirm",
+            name: "initGit",
+            message: "Initialize a Git repository?",
+            default: true,
+        });
+        if (initGit) {
+            const spinnerGit = ora("Initializing Git repo...").start();
+            promptAndInitGit(targetDir);
+            spinnerGit.succeed(`Git repository initialized for ${projectName}`);
+        }
+        console.log(`
+  ✅ Project setup complete!
+
+  Next steps:
+    1. Navigate to your project:
+     cd ${projectName}
+
+     2. Migrate or push database schemas:
+     npm run db:migrate
+     npm run db:push
+     npm run db:generate
+
+     3. Start the development server:
+      npm run dev
+  `);
+    }
+    catch (error) {
+        console.error("Error:", error);
+        process.exit(1);
+    }
+    finally {
+        if (tmpDir && await fs.pathExists(tmpDir)) {
+            await fs.remove(tmpDir);
+        }
+    }
+}
+run();

package/eslint.config.ts

@@ -0,0 +1,26 @@
+import antfu from "@antfu/eslint-config"
+
+export default antfu({
+  typescript: true,
+  jsonc: true,
+  formatters: { markdown: true },
+  stylistic: {
+    indent: 2,
+    quotes: "double",
+    semi: false,
+  },
+  rules: {
+    "no-new": "off",
+    "no-undef": "off",
+    "no-alert": "off",
+    "no-console": "off",
+    "node/prefer-global/process": "off",
+    "curly": ["error", "all"],
+    "object-curly-newline": ["error", {
+      ObjectExpression: { multiline: false, consistent: true },
+      ObjectPattern: { multiline: false, consistent: true },
+      ImportDeclaration: { multiline: false, consistent: true },
+      ExportDeclaration: { multiline: false, consistent: true },
+    }],
+  },
+})

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "nuxt-bake",
+  "type": "module",
+  "version": "1.0.1",
+  "description": "A CLI tool to quickly scaffold a Nuxt.js starter project",
+  "author": "Matheus Mortari <matheus.felipe.19rt@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/matimortari/nuxt-bake.git",
+    "directory": "package"
+  },
+  "keywords": [
+    "starter",
+    "template",
+    "nuxt",
+    "nuxt4",
+    "nuxtjs",
+    "vue",
+    "typescript",
+    "tailwindcss"
+  ],
+  "bin": {
+    "nuxt-bake": "dist/index.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "clean": "rimraf dist my-nuxt-app",
+    "test": "vitest run",
+    "coverage": "vitest --coverage",
+    "test:e2e": "playwright test",
+    "release:patch": "npm version patch && npm publish --access public",
+    "release:minor": "npm version minor && npm publish --access public",
+    "release:major": "npm version major && npm publish --access public"
+  },
+  "dependencies": {
+    "chalk": "5.6.2",
+    "figures": "6.1.0",
+    "fs-extra": "11.3.3",
+    "inquirer": "13.3.0",
+    "ora": "9.3.0",
+    "rimraf": "6.1.3"
+  },
+  "devDependencies": {
+    "@playwright/test": "1.58.2",
+    "@types/fs-extra": "11.0.4",
+    "@vitest/coverage-v8": "4.0.18",
+    "vitest": "4.0.18"
+  }
+}

package/playwright.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from "@playwright/test"
+
+export default defineConfig({
+  outputDir: "./tests/e2e/test-results",
+  testDir: "./tests/e2e",
+})

package/src/helpers/git.ts

@@ -0,0 +1,28 @@
+import { spawnSync } from "node:child_process"
+import os from "node:os"
+import path from "node:path"
+
+export function cloneRepoToTemp(repoUrl: string) {
+  const tmpDir = path.join(os.tmpdir(), `nuxt-bake-${Date.now()}`)
+  const result = spawnSync("git", ["clone", "--depth=1", "--quiet", repoUrl, tmpDir], { stdio: "pipe", shell: true })
+  if (result.error) {
+    console.error("Failed to get project from remote:", result.error.message)
+    return null
+  }
+  if (result.status !== 0) {
+    console.error("Failed to clone repository")
+    return null
+  }
+
+  return tmpDir
+}
+
+export function promptAndInitGit(targetDir: string) {
+  const result = spawnSync("git", ["init", "--quiet"], { cwd: targetDir, stdio: "pipe", shell: true })
+  if (result.error) {
+    console.error("Failed to initialize Git:", result.error.message)
+  }
+  else if (result.status !== 0) {
+    console.error("Git init failed")
+  }
+}

package/src/helpers/package-manager.ts

@@ -0,0 +1,86 @@
+import { execSync } from "node:child_process"
+import path from "node:path"
+import fs from "fs-extra"
+import inquirer from "inquirer"
+import ora from "ora"
+
+function mergeObjects(base = {}, extra = {}) {
+  return { ...base, ...extra }
+}
+
+export function createPackageManagerCommands(pkgManager: string) {
+  switch (pkgManager) {
+    case "yarn":
+      return {
+        name: "yarn",
+        installCmd: "yarn install",
+        runScript: (script: string) => `yarn ${script}`,
+      }
+    case "pnpm":
+      return {
+        name: "pnpm",
+        installCmd: "pnpm install",
+        runScript: (script: string) => `pnpm ${script}`,
+      }
+    case "bun":
+      return {
+        name: "bun",
+        installCmd: "bun install",
+        runScript: (script: string) => `bun run ${script}`,
+      }
+    case "npm":
+    default:
+      return {
+        name: "npm",
+        installCmd: "npm install",
+        runScript: (script: string) => `npm run ${script}`,
+      }
+  }
+}
+
+export async function promptForPackageManager() {
+  const { pkgManager } = await inquirer.prompt({
+    type: "list",
+    name: "pkgManager",
+    message: "Which package manager do you want to use?",
+    choices: [
+      { name: "npm", value: "npm" },
+      { name: "yarn", value: "yarn" },
+      { name: "pnpm", value: "pnpm" },
+      { name: "bun", value: "bun" },
+    ],
+    default: "npm",
+  })
+
+  return createPackageManagerCommands(pkgManager)
+}
+
+export async function installDependencies(targetDir: string, pkgManager: any) {
+  const spinner = ora("Installing dependencies...").start()
+
+  try {
+    spinner.stop()
+    execSync(pkgManager.installCmd, { cwd: targetDir, stdio: "inherit" })
+    execSync(pkgManager.runScript("lint:fix"), { cwd: targetDir, stdio: "ignore" })
+    spinner.succeed("Dependencies installed!")
+  }
+  catch (err: any) {
+    spinner.fail("Failed to install dependencies")
+    throw err
+  }
+}
+
+export async function updatePackageJson(rootTemplateDir: string, targetDir: string, preset: string, extras: any) {
+  const rootPkgPath = path.join(rootTemplateDir, "package.json")
+  const targetPkgPath = path.join(targetDir, "package.json")
+  const rootPkg = JSON.parse(await fs.readFile(rootPkgPath, "utf8"))
+
+  const mergedPkg = {
+    ...rootPkg,
+    dependencies: mergeObjects(rootPkg.dependencies, extras.dependencies),
+    devDependencies: mergeObjects(rootPkg.devDependencies, extras.devDependencies),
+    scripts: mergeObjects(rootPkg.scripts, extras.scripts),
+  }
+
+  await fs.writeFile(targetPkgPath, JSON.stringify(mergedPkg, null, 2), "utf8")
+}

package/src/helpers/template.ts

@@ -0,0 +1,35 @@
+import type { Preset } from "./utils"
+import path from "node:path"
+import fs from "fs-extra"
+
+export async function copyRootTemplate(tmpDir: string, targetDir: string) {
+  const rootTemplateDir = path.join(tmpDir, "package", "templates", "base")
+  if (!(await fs.pathExists(rootTemplateDir))) {
+    throw new Error(`Root template directory "${rootTemplateDir}" not found in the repo.`)
+  }
+
+  await fs.copy(rootTemplateDir, targetDir)
+
+  return rootTemplateDir
+}
+
+export async function copyPresetFiles(tmpDir: string, preset: Preset, targetDir: string) {
+  const presetDir = path.join(tmpDir, "package", "templates", preset)
+  if (!(await fs.pathExists(presetDir))) {
+    throw new Error(`Preset directory "${presetDir}" not found in the repo.`)
+  }
+
+  const presetRootFiles = await fs.readdir(presetDir)
+  for (const file of presetRootFiles) {
+    if (file === "app") {
+      continue
+    }
+
+    await fs.copy(path.join(presetDir, file), path.join(targetDir, file), { overwrite: true })
+  }
+
+  const presetAppDir = path.join(presetDir, "app")
+  if (await fs.pathExists(presetAppDir)) {
+    await fs.copy(presetAppDir, path.join(targetDir, "app"), { overwrite: true })
+  }
+}