devstarter-tool 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +82 -62
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,126 +1,146 @@
1
- # devStarter CLI
1
+ # devstarter-tool
2
2
 
3
- CLI para generar proyectos con buenas prácticas y configuraciones predefinidas.
3
+ CLI to generate projects with best practices and predefined configurations.
4
4
 
5
- ## Instalacion
5
+ ## Installation
6
6
 
7
7
  ```bash
8
- npm install -g devstarter-cli
8
+ npm install -g devstarter-tool
9
9
  ```
10
10
 
11
- O ejecutar directamente con npx:
11
+ Or run directly with npx:
12
12
 
13
13
  ```bash
14
- npx devstarter-cli init my-app
14
+ npx devstarter-tool init my-app
15
15
  ```
16
16
 
17
- ## Uso
17
+ ## Usage
18
18
 
19
- ### Comando basico
19
+ ### Basic command
20
20
 
21
21
  ```bash
22
- devstarter init [nombre-proyecto]
22
+ devstarter init [project-name]
23
23
  ```
24
24
 
25
- ### Opciones
25
+ ### Options
26
26
 
27
- | Opcion | Descripcion |
27
+ | Option | Description |
28
28
  |--------|-------------|
29
- | `-y, --yes` | Usar valores por defecto sin preguntar |
30
- | `-t, --type <tipo>` | Tipo de proyecto: `frontend` o `backend` |
31
- | `--dry-run` | Previsualizar cambios sin crear archivos |
29
+ | `-y, --yes` | Use default values without prompting |
30
+ | `-t, --type <type>` | Project type: `frontend` or `backend` |
31
+ | `--template <name>` | Template to use |
32
+ | `--dry-run` | Preview changes without creating files |
32
33
 
33
- ### Ejemplos
34
+ ### Examples
34
35
 
35
36
  ```bash
36
- # Modo interactivo completo
37
+ # Full interactive mode
37
38
  devstarter init
38
39
 
39
- # Crear proyecto con nombre especifico
40
+ # Create project with specific name
40
41
  devstarter init my-app
41
42
 
42
- # Crear proyecto frontend sin preguntas
43
+ # Create frontend project without prompts
43
44
  devstarter init my-app --type frontend -y
44
45
 
45
- # Previsualizar que archivos se crearian
46
+ # Preview what files would be created
46
47
  devstarter init my-app --type frontend --dry-run
47
48
  ```
48
49
 
49
- ## Templates disponibles
50
+ ## Project Structures
51
+
52
+ ### Basic (single project)
53
+
54
+ ```
55
+ my-app/
56
+ ├── src/
57
+ │ └── main.ts (or main.tsx for React)
58
+ ├── package.json
59
+ ├── README.md
60
+ └── .git/ (if git is initialized)
61
+ ```
62
+
63
+ ### Monorepo (full-stack)
64
+
65
+ ```
66
+ my-app/
67
+ ├── apps/
68
+ │ ├── web/ <- frontend template
69
+ │ └── api/ <- backend template
70
+ ├── packages/
71
+ │ └── shared/ <- shared code
72
+ ├── package.json
73
+ ├── pnpm-workspace.yaml
74
+ ├── tsconfig.base.json
75
+ └── README.md
76
+ ```
77
+
78
+ ## Available Templates
50
79
 
51
80
  ### Frontend
52
81
 
53
- | Template | Descripcion |
82
+ | Template | Description |
54
83
  |----------|-------------|
55
- | `basic` | TypeScript minimal con estructura basica |
84
+ | `basic` | Minimal TypeScript with basic structure |
56
85
  | `react` | React 18 + Vite + TypeScript |
57
86
 
58
87
  ### Backend
59
88
 
60
- | Template | Descripcion |
89
+ | Template | Description |
61
90
  |----------|-------------|
62
91
  | `basic` | Express + TypeScript |
63
92
 
64
- ## Estructura de proyecto generado
65
-
66
- ```
67
- my-app/
68
- ├── src/
69
- │ └── main.ts (o main.tsx para React)
70
- ├── package.json
71
- ├── README.md
72
- └── .git/ (si se inicializa git)
73
- ```
74
-
75
- ## Caracteristicas
93
+ ## Features
76
94
 
77
- - Deteccion automatica del package manager (npm, pnpm, yarn)
78
- - Seleccion interactiva de templates
79
- - Inicializacion de repositorio Git opcional
80
- - Modo dry-run para previsualizar cambios
81
- - Normalizacion automatica de nombres de proyecto (kebab-case)
82
- - Output con colores para mejor legibilidad
95
+ - Project structure selection (basic or monorepo)
96
+ - Automatic package manager detection (npm, pnpm, yarn)
97
+ - Interactive template selection
98
+ - Optional Git repository initialization
99
+ - Dry-run mode to preview changes
100
+ - Automatic project name normalization (kebab-case)
101
+ - Colored output for better readability
83
102
 
84
- ## Desarrollo
103
+ ## Development
85
104
 
86
- ### Requisitos
105
+ ### Requirements
87
106
 
88
107
  - Node.js 18+
89
- - npm, pnpm o yarn
108
+ - npm, pnpm or yarn
90
109
 
91
110
  ### Setup
92
111
 
93
112
  ```bash
94
- # Clonar repositorio
95
- git clone https://github.com/abraham-diaz/devStarter-cli.git
96
- cd devStarter-cli
113
+ # Clone repository
114
+ git clone https://github.com/abraham-diaz/devstarter-cli.git
115
+ cd devstarter-cli
97
116
 
98
- # Instalar dependencias
117
+ # Install dependencies
99
118
  npm install
100
119
 
101
- # Compilar
120
+ # Build
102
121
  npm run build
103
122
 
104
- # Ejecutar localmente
123
+ # Run locally
105
124
  node dist/cli.js init test-app --dry-run
106
125
  ```
107
126
 
108
- ### Scripts disponibles
127
+ ### Available Scripts
109
128
 
110
- | Script | Descripcion |
129
+ | Script | Description |
111
130
  |--------|-------------|
112
- | `npm run build` | Compila TypeScript y copia templates |
113
- | `npm run dev` | Modo watch para desarrollo |
114
- | `npm run lint` | Ejecuta ESLint |
115
- | `npm run format` | Formatea codigo con Prettier |
131
+ | `npm run build` | Compile TypeScript and copy templates |
132
+ | `npm run dev` | Watch mode for development |
133
+ | `npm run test` | Run tests |
134
+ | `npm run lint` | Run ESLint |
135
+ | `npm run format` | Format code with Prettier |
116
136
 
117
- ### Agregar nuevos templates
137
+ ### Adding New Templates
118
138
 
119
- 1. Crear carpeta en `src/templates/<tipo>/<nombre-template>/`
120
- 2. Agregar archivos del template (usar `.tpl` para archivos con placeholders)
121
- 3. Placeholders disponibles: `{{projectName}}`
122
- 4. Ejecutar `npm run build`
139
+ 1. Create folder in `src/templates/<type>/<template-name>/`
140
+ 2. Add template files (use `.tpl` extension for files with placeholders)
141
+ 3. Available placeholders: `{{projectName}}`
142
+ 4. Run `npm run build`
123
143
 
124
- ## Licencia
144
+ ## License
125
145
 
126
146
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "devstarter-tool",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "description": "CLI to generate projects with best practices (basic or monorepo)",
6
6
  "author": "abraham-diaz",