CM CLI

El CLI de Creative Minds es una herramienta esencial para estandarizar y acelerar el desarrollo de proyectos. Facilita la generación de módulos, características y la gestión de la estructura del proyecto.

Instalación

Instalación Global

# Login
 
## hacer login en una cuenta de github con acceso a la organizacion o usar el siguiente comando desde la terminal:
$ npm login --registry=https://npm.pkg.github.com/ --scope=@crtv-mnds
 
## acceder con el username y como password usar el token proporcionado por la organizacion
 
# Instalar globalmente
npm install -g @crtv-mnds/cli
 
# Verificar instalación
cm --version

Instalación Local

# Instalar como dependencia de desarrollo
npm install --save-dev @crtv-mnds/cli
 
# Usar con npx
npx cm --version

Configuración

La primera vez que ejecutes cualquier comando, se creará automáticamente un archivo cmkit-config.json con la configuración por defecto:

{
  "version": "1.0.0",
  "paths": {
    "modulesRoot": "./src/modules",
    "featuresRoot": "./src/features"
  },
  "conventions": {
    "requireDocsInModule": true,
    "requireModuleDirs": [
      "features",
      "actions",
      "services",
      "adapters"
    ]
  },
  "defaults": {
    "featureType": "standalone",
    "cleanMode": false
  }
}

Comandos Principales

1. Generación de Recursos (g o generate)

Genera nuevos módulos o características en tu proyecto.

# Generar un nuevo módulo
cm g m mi-modulo
 
# Generar una característica
cm g f mi-caracteristica
 
# Generar en modo limpio (solo comentarios)
cm g m mi-modulo --clean

2. Construir Starter Kit (b o build)

Construye un proyecto base siguiendo las mejores prácticas.

# Construir un starter kit Next.js
cm b next

3. Eliminar Recursos (r o remove)

Elimina módulos o características existentes.

# Eliminar un módulo
cm r m mi-modulo
 
# Eliminar una característica
cm r f mi-caracteristica

4. Listar Módulos (l o list)

Muestra información sobre los módulos del proyecto.

# Listar todos los módulos
cm l
 
# Ver detalles de un módulo específico
cm l mi-modulo

5. Formatear Código (f o format)

Formatea y valida el código según los estándares.

# Formatear todos los módulos
cm f
 
# Formatear un módulo específico
cm f mi-modulo

Estructura de Directorios

La herramienta sigue esta estructura estándar:

src/
  modules/         # Módulos principales
    mi-modulo/
      features/    # Características del módulo
      actions/     # Acciones/controladores
      services/    # Lógica de negocio
      adapters/    # Adaptadores externos
  features/        # Características globales

Ejemplo de Flujo de Trabajo

1. Iniciar un nuevo proyecto:

   mkdir mi-proyecto
   cd mi-proyecto
   npm init -y
   cm g m autenticacion

2. Agregar una característica:

   cd mi-proyecto
   cm g f login

3. Ver módulos existentes:

   cm l

Configuración Avanzada

Puedes personalizar el comportamiento del CLI editando el archivo cmkit-config.json:

• paths: Define las rutas base para módulos y características
• conventions: Establece las convenciones de estructura
• defaults: Configura los valores por defecto para la generación
• format: Opciones de formateo de código

Solución de Problemas

Si encuentras algún problema:

1. Verifica que estás usando la versión correcta:

   cm --version

2. Revisa los logs de error

3. Asegúrate de que el archivo cmkit-config.json tenga la estructura correcta

Contribución

Si deseas contribuir al desarrollo de CM CLI, visita nuestro repositorio en GitHub .

Próximos Pasos

1. Componentes - Sistema de componentes detallado
2. Fetching - Manejo de datos y APIs
3. Manejo de Errores - Estrategias de error handling