Griddo CLI (WIP, DRAFT, There be Dragons, etc..)

Development wip...

Herramienta de terminal para facilitar el desarrollo de proyectos con Griddo.

npm install -g @griddo/cli

Nuevo proyecto

Crea un nuevo projecto Griddo usando la última versión.

griddo new project myNewBrandProject --template CSSModules

Nuevo elemento de la biblioteca

Esta opción permite generar los distintos elementos de Griddo que pueden formar una instancia: component, module, template, object y element.

griddo new element (interactive)

griddo new template NewsList --mode list --nice-name "News List" --no-special

Plantillas

De cara a generar los ficheros de los distintos elementos, esta librería utilizará unas plantillas. Si no se especifica en el fichero de configuración la carpeta que contiene dichas plantillas, se usarán unas por defecto.

La estructura de ficheros que debe contener la carpeta de plantillas debe ser similar a esta:

.
├── templates
│   ├── components
│   │   ├── component.schema
│   │   ├── component.stories
│   │   ├── component.ui
│   ├── elements
│   │   ├── element.stories
│   │   ├── element.ui
│   ├── modules
│   │   ├── module.schema
│   │   ├── module.stories
│   │   ├── module.ui
│   ├── objects
│   │   ├── object.schema
│   ├── templates
│   │   ├── template.schema
│   │   ├── template.stories
│   │   ├── template.ui

Tags disponibles para plantillas

Los tags DISPLAY_NAME y NAME son comunes para components, modules, templates, objects y elements. Los tags que empiezan por TEMPLATE_ son exclusivos de templates.

DISPLAY_NAME
NAME

TEMPLATE_TYPE
TEMPLATE_LABEL
TEMPLATE_MODE

Formato

Todos los ficheros generados se formatearán con Prettier. Este script usará la configuración de Prettier de la instancia, leyendo su fichero .prettierrc.json. Si este fichero no existiese, se aplicará una configuración por defecto.

Configuración por defecto de Prettier:

{
  "useTabs": true
}

Notas: en próximas versiones de Prettier, el parámetro useTabs será true por defecto y se podrá eliminar esta configuración.

TODO:

• Adaptar a últimos cambios del AutoType https://www.notion.so/griddoio/Griddo-AutoTypes-e7cad91087b544209b7052a37e86b484.
• Para los types del AutoType de Griddo Core, tener en cuenta los sufijos que se hayan definido en la instancia.
• Leer la configuración de la instancia.
• Corregir errores de TS del fichero de configuración.
• Definir valores por defecto para la configuración y documentarla.
• Ejecutar eslint si la instancia tiene .eslintrc.js.

• Implementar la salida del inquirer probablemente a program.ts o processElement.ts
• Pasar griddorc.ts a js/json/yml...
• Scripts para publicar en npm
• Usar async/await?