GUI-DGT-004 Uso de prettier
v 1.1
Objetivo
Esta guía tiene como propósito mostrar al equipo DotGeist la instalación y uso de prettier para formateo de código.
Notas introductorias
Prettier es una herramienta de formateo de código que automáticamente ajusta el estilo de tu código para que sea consistente y legible, lo que facilita la colaboración en equipos y el mantenimiento del código.
Contenido
- Entra a VSCode e instala la extensión Prettier.
- Presiona CTRL + , (para windows) o Command + , (para mac). Esto abrirá la pestaña de configuración de VSCode.
- Dentro de esta pestaña, busca la palabra format.
- Selecciona Prettier como default formatter.
- Activa la opción Format on save.
- Ahora tu código se formateará con Prettier cada que guardes un documento. Adicionalmente, puedes correr el siguiente comando para verificar que tu código esté correctamente formateado.
pnpm run lint
- En caso de encontrar algún error en el formateo, puedes ejecutar el siguiente comando.
pnpm run lint:fix
Tu código estará ahora correctamente formateado. Contempla siempre formatear tu código antes de mandar algún cambio al repositorio.
Control de cambios
| Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
|---|---|---|---|---|---|
| v 1.0 | Creación de la guía | N/A | Arturo Díaz | Ian Padrón | 23/04/2024 |
| v 1.1 | Cambio en el nombre | Actualizar para continuar con la secuencia de IDs | Sergio Garnica | Denisse Domínguez | 24/04/2024 |