devstarter-tool 0.2.1 → 0.2.2

package/README.md

@@ -2,6 +2,16 @@
 
 CLI to generate projects with best practices and predefined configurations.
 
+## Features
+
+- **Project structures**: Basic (single project) or Monorepo (full-stack)
+- **Automatic dependency installation**: No need to run `npm install` manually
+- **Vitest integration**: Optional testing setup with one flag
+- **Package manager detection**: Automatically uses npm, pnpm, or yarn
+- **Git initialization**: Optional repository setup
+- **Interactive prompts**: Guided project creation
+- **Dry-run mode**: Preview changes before creating files
+
 ## Installation
 
 ```bash
@@ -14,12 +24,26 @@ Or run directly with npx:
 npx devstarter-tool init my-app
 ```
 
-## Usage
+## Quick Start
+
+```bash
+# Interactive mode - guided setup
+devstarter init
 
-### Basic command
+# Quick project with defaults
+devstarter init my-app -y
+
+# Frontend project with Vitest
+devstarter init my-app --type frontend --vitest
+
+# Preview without creating files
+devstarter init my-app --dry-run
+```
+
+## Usage
 
 ```bash
-devstarter init [project-name]
+devstarter init [project-name] [options]
 ```
 
 ### Options
@@ -28,10 +52,10 @@ devstarter init [project-name]
 |--------|-------------|
 | `-y, --yes` | Use default values without prompting |
 | `-t, --type <type>` | Project type: `frontend` or `backend` |
-| `--template <name>` | Template to use |
+| `--template <name>` | Template to use (e.g., `basic`, `react`) |
+| `--vitest` | Add Vitest for testing |
+| `--no-git` | Skip Git repository initialization |
 | `--dry-run` | Preview changes without creating files |
-| `--no-git` | Skip git repository initialization |
-| `--no-vitest` | Skip Vitest testing framework setup |
 
 ### Examples
 
@@ -42,17 +66,17 @@ devstarter init
 # Create project with specific name
 devstarter init my-app
 
-# Create frontend project without prompts
-devstarter init my-app --type frontend -y
+# Frontend with React template
+devstarter init my-app --type frontend --template react
 
-# Preview what files would be created
-devstarter init my-app --type frontend --dry-run
+# Backend with testing setup
+devstarter init my-api --type backend --vitest
 
-# Create project without git initialization
-devstarter init my-app --no-git
+# Quick frontend with all defaults
+devstarter init my-app --type frontend -y
 
-# Create project without Vitest setup
-devstarter init my-app --no-vitest
+# Create without Git
+devstarter init my-app --no-git
 ```
 
 ## Project Structures
@@ -62,13 +86,12 @@ devstarter init my-app --no-vitest
 ```
 my-app/
 ├── src/
-│   ├── main.ts (or main.tsx for React)
-│   └── __tests__/
-│       └── example.test.ts
-├── vitest.config.ts
+│   └── main.ts
 ├── package.json
-├── README.md
-└── .git/ (if git is initialized)
+├── tsconfig.json
+├── vitest.config.ts   # if --vitest
+├── node_modules/
+└── .git/              # if git initialized
 ```
 
 ### Monorepo (full-stack)
@@ -76,10 +99,16 @@ my-app/
 ```
 my-app/
 ├── apps/
-│   ├── web/        <- frontend template
-│   └── api/        <- backend template
+│   ├── web/           # frontend template
+│   │   ├── src/
+│   │   ├── package.json
+│   │   └── vitest.config.ts
+│   └── api/           # backend template
+│       ├── src/
+│       ├── package.json
+│       └── vitest.config.ts
 ├── packages/
-│   └── shared/     <- shared code
+│   └── shared/        # shared code
 ├── package.json
 ├── pnpm-workspace.yaml
 ├── tsconfig.base.json
@@ -92,7 +121,7 @@ my-app/
 
 | Template | Description |
 |----------|-------------|
-| `basic` | Minimal TypeScript with basic structure |
+| `basic` | Vite + TypeScript |
 | `react` | React 18 + Vite + TypeScript |
 
 ### Backend
@@ -101,42 +130,29 @@ my-app/
 |----------|-------------|
 | `basic` | Express + TypeScript |
 
-## Features
-
-- Project structure selection (basic or monorepo)
-- Automatic package manager detection (npm, pnpm, yarn)
-- Interactive template selection
-- Optional Git repository initialization
-- Optional Vitest testing framework setup
-- Dry-run mode to preview changes
-- Automatic project name normalization (kebab-case)
-- Colored output for better readability
-
-## Testing Setup (Vitest)
+## Vitest Integration
 
-By default, projects are created with Vitest configured. This includes:
+When using `--vitest`, the CLI adds:
 
 - `vitest` as a dev dependency
-- `vitest.config.ts` configuration file
-- Example test file in `src/__tests__/example.test.ts`
-- `test` script in package.json
-
-For React projects, it also adds `jsdom` for DOM testing.
-
-To skip Vitest setup, use the `--no-vitest` flag:
+- `vitest.config.ts` with basic configuration
+- `test` and `test:run` scripts in package.json
 
 ```bash
-devstarter init my-app --no-vitest
-```
+# Create project with Vitest
+devstarter init my-app --vitest
 
-## Development
+# Then run tests
+cd my-app
+npm test
+```
 
-### Requirements
+## Requirements
 
 - Node.js 18+
-- npm, pnpm or yarn
+- npm, pnpm, or yarn
 
-### Setup
+## Development
 
 ```bash
 # Clone repository
@@ -153,7 +169,7 @@ npm run build
 node dist/cli.js init test-app --dry-run
 ```
 
-### Available Scripts
+### Scripts
 
 | Script | Description |
 |--------|-------------|

package/dist/cli.js

@@ -14,5 +14,6 @@ program
     .option('--template <name>', 'Template variant (e.g. basic, react)')
     .option('--dry-run', 'Show what would be generated without creating files')
     .option('--no-git', 'Skip git repository initialization')
+    .option('--vitest', 'Add Vitest for testing')
     .action(initCommand);
 program.parse(process.argv);

package/dist/commands/init/collector.js

@@ -1,5 +1,5 @@
 import { DEFAULT_INIT_OPTIONS } from '../../types/project.js';
-import { askProjectName, askProjectStructure, askInitQuestions, askTemplate, askInitGit, } from '../../prompts/initPrompts.js';
+import { askProjectName, askProjectStructure, askInitQuestions, askTemplate, askInitGit, askUseVitest, } from '../../prompts/initPrompts.js';
 import { normalizeProjectName } from '../../utils/normalize.js';
 import { detectPackageManager } from '../../utils/detectPackageManager.js';
 import { listTemplates } from '../../utils/listTemplate.js';
@@ -60,12 +60,25 @@ async function collectBasicContext(projectName, options, useDefaults) {
     const templates = listTemplates(projectType);
     const templateFromFlag = resolveTemplateFlag(options.template, templates);
     const template = await collectTemplate(templateFromFlag, templates, useDefaults);
+    // Obtener useVitest
+    const vitestFlagProvided = options.vitest !== undefined;
+    let useVitest;
+    if (vitestFlagProvided) {
+        useVitest = options.vitest;
+    }
+    else if (useDefaults) {
+        useVitest = DEFAULT_INIT_OPTIONS.useVitest;
+    }
+    else {
+        useVitest = (await askUseVitest()).useVitest;
+    }
     return {
         structure: 'basic',
         projectName,
         projectType,
         template,
         initGit,
+        useVitest,
         packageManager: detectPackageManager(),
         isDryRun: Boolean(options.dryRun),
     };
@@ -102,12 +115,25 @@ async function collectMonorepoContext(projectName, useDefaults, options) {
             initGit = gitAnswer.initGit;
         }
     }
+    // Obtener useVitest
+    const vitestFlagProvided = options.vitest !== undefined;
+    let useVitest;
+    if (vitestFlagProvided) {
+        useVitest = options.vitest;
+    }
+    else if (useDefaults) {
+        useVitest = DEFAULT_INIT_OPTIONS.useVitest;
+    }
+    else {
+        useVitest = (await askUseVitest()).useVitest;
+    }
     return {
         structure: 'monorepo',
         projectName,
         webTemplate,
         apiTemplate,
         initGit,
+        useVitest,
         packageManager: 'pnpm', // Monorepo usa pnpm por defecto
         isDryRun: Boolean(options.dryRun),
     };

package/dist/generators/createMonorepo.js

@@ -3,7 +3,9 @@ import path from 'node:path';
 import { getTemplatePath } from '../utils/getTemplatePath.js';
 import { copyTemplate } from '../utils/copyTemplate.js';
 import { initGitRepo } from '../utils/git.js';
-export async function createMonorepo({ projectName, webTemplate, apiTemplate, initGit, }) {
+import { setupVitest } from '../utils/setupVitest.js';
+import { installDependencies } from '../utils/installDependencies.js';
+export async function createMonorepo({ projectName, webTemplate, apiTemplate, initGit, useVitest, packageManager, }) {
     // 1. Resolver ruta absoluta del proyecto
     const projectRoot = path.resolve(process.cwd(), projectName);
     // 2. Evitar sobrescribir carpetas existentes
@@ -32,7 +34,14 @@ export async function createMonorepo({ projectName, webTemplate, apiTemplate, in
     }
     // 7. Crear package shared básico
     await createSharedPackage(projectRoot, projectName);
-    // 8. Inicializar Git (si aplica)
+    // 8. Configurar Vitest en apps (si aplica)
+    if (useVitest) {
+        await setupVitest(path.join(projectRoot, 'apps', 'web'));
+        await setupVitest(path.join(projectRoot, 'apps', 'api'));
+    }
+    // 9. Instalar dependencias
+    installDependencies(projectRoot, packageManager);
+    // 10. Inicializar Git (si aplica)
     if (initGit) {
         initGitRepo(projectRoot);
     }

package/dist/generators/createProject.js

@@ -3,7 +3,9 @@ import path from 'node:path';
 import { getTemplatePath } from '../utils/getTemplatePath.js';
 import { copyTemplate } from '../utils/copyTemplate.js';
 import { initGitRepo } from '../utils/git.js';
-export async function createProject({ projectName, projectType, template, initGit, }) {
+import { setupVitest } from '../utils/setupVitest.js';
+import { installDependencies } from '../utils/installDependencies.js';
+export async function createProject({ projectName, projectType, template, initGit, useVitest, packageManager, }) {
     // 1. Resolver ruta absoluta del proyecto
     const projectRoot = path.resolve(process.cwd(), projectName);
     // 2. Evitar sobrescribir carpetas existentes
@@ -21,7 +23,13 @@ export async function createProject({ projectName, projectType, template, initGi
     await copyTemplate(templatePath, projectRoot, {
         projectName,
     });
-    // 6. Inicializar Git (si aplica)
+    // 6. Configurar Vitest (si aplica)
+    if (useVitest) {
+        await setupVitest(projectRoot);
+    }
+    // 7. Instalar dependencias
+    installDependencies(projectRoot, packageManager);
+    // 8. Inicializar Git (si aplica)
     if (initGit) {
         initGitRepo(projectRoot);
     }

package/dist/prompts/initPrompts.js

@@ -80,3 +80,11 @@ export async function askInitGit() {
         initial: true,
     }, { onCancel });
 }
+export async function askUseVitest() {
+    return prompts({
+        type: 'confirm',
+        name: 'useVitest',
+        message: 'Add Vitest for testing?',
+        initial: false,
+    }, { onCancel });
+}

package/dist/types/project.js

@@ -2,4 +2,5 @@ export const DEFAULT_INIT_OPTIONS = {
     projectStructure: 'basic',
     projectType: 'frontend',
     initGit: true,
+    useVitest: false,
 };

package/dist/utils/installDependencies.js

@@ -0,0 +1,8 @@
+import { execSync } from 'node:child_process';
+export function installDependencies(projectRoot, packageManager) {
+    const command = packageManager === 'yarn' ? 'yarn' : `${packageManager} install`;
+    execSync(command, {
+        cwd: projectRoot,
+        stdio: 'inherit',
+    });
+}

package/dist/utils/printSummary.js

@@ -14,7 +14,6 @@ export function printSummary(context) {
     console.log(`${styles.info('- Git:')} ${context.initGit ? styles.success('initialized') : styles.muted('not initialized')}\n`);
     console.log(styles.title('Next steps'));
     console.log(`  ${styles.highlight(`cd ${context.projectName}`)}`);
-    console.log(`  ${styles.highlight(`${context.packageManager} install`)}`);
     console.log(`  ${styles.highlight(`${context.packageManager} run dev`)}`);
     console.log('');
 }

package/dist/utils/setupVitest.js

@@ -0,0 +1,31 @@
+import fs from 'fs-extra';
+import path from 'node:path';
+const VITEST_CONFIG = `import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+  },
+});
+`;
+export async function setupVitest(projectRoot) {
+    const packageJsonPath = path.join(projectRoot, 'package.json');
+    // Leer package.json existente
+    const packageJson = await fs.readJson(packageJsonPath);
+    // Añadir devDependencies
+    packageJson.devDependencies = {
+        ...packageJson.devDependencies,
+        vitest: '^3.0.0',
+    };
+    // Añadir scripts de test
+    packageJson.scripts = {
+        ...packageJson.scripts,
+        test: 'vitest',
+        'test:run': 'vitest run',
+    };
+    // Escribir package.json actualizado
+    await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
+    // Crear vitest.config.ts
+    await fs.writeFile(path.join(projectRoot, 'vitest.config.ts'), VITEST_CONFIG);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devstarter-tool",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "type": "module",
   "description": "CLI to generate projects with best practices (basic or monorepo)",
   "author": "abraham-diaz",
@@ -22,7 +22,9 @@
     "backend",
     "boilerplate",
     "starter",
-    "devstarter"
+    "devstarter",
+    "vitest",
+    "testing"
   ],
   "engines": {
     "node": ">=18.0.0"