vtex-css-sanitizer-cli 1.0.7 → 1.1.0

package/.github/workflows/release.yml

@@ -41,6 +41,7 @@ jobs:
 
       - name: Sync version from tag
         working-directory: gui
+        shell: bash
         run: npm version "${GITHUB_REF_NAME#v}" --no-git-tag-version
 
       - name: Build & Package

package/PUBLISHING.md

@@ -1,65 +1,81 @@
 # Guía de Publicación y Releases
 
-Este repositorio actúa como un monorepo que contiene 3 proyectos independientes que conviven juntos. Cada uno tiene su propio flujo de publicación y distribución:
+Este repositorio actúa como un monorepo que contiene 2 proyectos independientes que conviven juntos:
 
 1. **CLI (Línea de comandos)**: Publicado en el registro de `npm`.
 2. **GUI (Aplicación de Escritorio)**: Compilado y publicado en GitHub Releases a través de GitHub Actions.
 
-A continuación se detalla cómo trabajar con cada uno de ellos cuando hay cambios.
+A continuación se detallan los 3 escenarios posibles de publicación.
 
+> **Nota sobre la versión de la GUI:** No es necesario actualizar manualmente la versión en `gui/package.json`. El workflow de GitHub Actions la sincroniza automáticamente desde el tag de Git antes de compilar.
 
-## 1. CLI (NPM Package)
+---
+
+## Escenario 1: Cambios en CLI y GUI
+
+Cuando hay cambios en ambos proyectos, una sola secuencia de comandos publica todo:
+
+```bash
+# 1. Compilar el CLI
+npm run build
+
+# 2. Bump de versión (genera commit + tag automáticamente)
+npm version patch   # o minor / major según corresponda
 
-La versión de línea de comandos se encuentra en la raíz del proyecto (`/src`) y se distribuye a través del registro de `npm` (`vtex-css-sanitizer-cli`).
+# 3. Publicar CLI en npm
+npm publish
 
-**Cómo publicar una nueva versión:**
+# 4. Push de todo (el tag v*.*.* dispara el build de la GUI)
+git push origin main --follow-tags
+```
 
-1. Realiza tus cambios o correcciones en la carpeta `/src`.
-2. Asegúrate de compilar el código TypeScript:
-   ```bash
-   npm run build
-   ```
-3. Actualiza la versión en el `package.json` de la raíz del proyecto. Puedes usar el comando de npm para que te genere el commit y el tag automáticamente:
-   ```bash
-   npm version patch # Para fixes menores (ej: 1.0.4 -> 1.0.5)
-   npm version minor # Para nuevas funciones (ej: 1.0.4 -> 1.1.0)
-   npm version major # Para cambios que rompen compatibilidad (ej: 1.0.4 -> 2.0.0)
-   ```
-4. Publica el paquete en npm (requiere estar logueado previamente con `npm login` si no lo estás):
-   ```bash
-   npm publish
-   ```
-5. Empuja los commits y tags generados al repositorio remoto:
-   ```bash
-   git push origin main --follow-tags
-   ```
+El `npm version` crea el tag `v*.*.*` que automáticamente dispara la GitHub Action para compilar y publicar la GUI.
 
 ---
 
-## 2. GUI (Aplicación de Escritorio)
+## Escenario 2: Solo cambios en la GUI
 
-La aplicación con interfaz gráfica y Electron se encuentra completamente autocontenida en la carpeta `/gui`. Las actualizaciones de esta aplicación se distribuyen a través de la pestaña de **Releases** en GitHub.
+Cuando los cambios fueron exclusivamente dentro de `/gui` y no hay nada nuevo en el CLI:
 
-Los botones de "Descargar para Windows" o "Descargar para Linux" en la Landing Page siempre apuntan al tag especial genérico de `/releases/latest` en GitHub, garantizando que los usuarios siempre descarguen la versión más reciente publicada.
+```bash
+# 1. Commit de los cambios
+git add gui/
+git commit -m "feat(gui): descripción del cambio"
 
-**Cómo generar y publicar una nueva versión de la GUI:**
+# 2. Crear tag manualmente (la versión del tag se inyecta en gui/package.json durante el build)
+git tag v1.0.8   # usar la versión que corresponda
+
+# 3. Push de todo (el tag dispara el build de la GUI)
+git push origin main --follow-tags
+```
+
+> No se ejecuta `npm publish` porque no hay cambios en el CLI.
+
+---
 
-1. Realiza y prueba tus cambios dentro de la carpeta `/gui`.
-2. Haz commit y push de los cambios a la rama `main`:
-   ```bash
-   git add gui/
-   git commit -m "feat(gui): nueva funcionalidad"
-   git push origin main
-   ```
-3. **Dispara la creación del Release en GitHub creando un tag Git:**
-   Debes crear un tag en Git que comience con la letra `v` apuntando a la versión que quieres publicar:
-   ```bash
-   git tag v1.0.7
-   git push origin v1.0.7
-   ```
-   *(También puedes empujar tus tags de una vez usando `git push origin main --tags`)*
+## Escenario 3: Solo cambios en el CLI
+
+Cuando los cambios fueron exclusivamente en `/src` y no hay nada nuevo en la GUI:
+
+```bash
+# 1. Compilar el CLI
+npm run build
+
+# 2. Bump de versión
+npm version patch   # o minor / major según corresponda
+
+# 3. Publicar en npm
+npm publish
+
+# 4. Push de commits (sin --follow-tags para NO disparar el build de la GUI)
+git push origin main
+```
+
+> **Importante:** Se usa `git push origin main` (sin `--follow-tags`) para evitar que el tag dispare un release innecesario de la GUI. Si en el futuro querés generar un release de la GUI con esta misma versión, podés hacer `git push origin v*.*.*` manualmente.
+
+---
 
-**¿Qué ocurre después de pushear el tag en Git?**
+## ¿Qué ocurre después de pushear un tag?
 
 1. GitHub intercepta el tag `v*.*.*` y automáticamente arranca la [GitHub Action programada](.github/workflows/release.yml).
 2. La Action levanta dos entornos virtuales en los servidores de GitHub (uno con Windows y otro con Ubuntu).

package/dist/commands/fix.js

@@ -35,8 +35,16 @@ async function fixCommand(projectPath) {
     const totalFiles = cssFiles.length;
     for (let fileIndex = 0; fileIndex < totalFiles; fileIndex++) {
         const filePath = cssFiles[fileIndex];
-        const originalContent = await promises_1.default.readFile(filePath, 'utf-8');
-        const root = postcss_1.default.parse(originalContent);
+        let originalContent;
+        let root;
+        try {
+            originalContent = await promises_1.default.readFile(filePath, 'utf-8');
+            root = postcss_1.default.parse(originalContent);
+        }
+        catch (error) {
+            console.error(`❌ Error leyendo/parseando ${path_1.default.relative(projectPath, filePath)}: ${error}`);
+            continue;
+        }
         const candidates = (0, css_processor_1.identifyRulesForDeletion)(root, unusedSuffixes);
         if (candidates.length === 0) {
             continue;
@@ -50,7 +58,7 @@ async function fixCommand(projectPath) {
             const rule = candidates[i];
             const relativePath = path_1.default.relative(projectPath, filePath);
             const ruleAsString = rule.toString();
-            console.clear();
+            console.log('\n==================================================================');
             console.log(`[ Progreso: Archivo ${fileIndex + 1} de ${totalFiles} ]`);
             console.log(`------------------------------------------------------------------`);
             console.log(`Revisando Archivo: ${relativePath}`);
@@ -98,7 +106,7 @@ async function fixCommand(projectPath) {
         deletedRules.push(...fileDeletedRules);
         keptRules.push(...fileKeptRules);
     }
-    console.clear();
+    console.log('\n==================================================================');
     if (totalRulesRemoved > 0) {
         console.log(`\n✅ Proceso completado. Se eliminaron un total de ${totalRulesRemoved} reglas CSS.`);
     }

package/dist/utils/report-generator.js

@@ -13,13 +13,15 @@ async function ensureReportDirectory(projectPath) {
     await promises_1.default.mkdir(reportDir, { recursive: true }); // recursive: true evita errores si el dir ya existe
     return reportDir;
 }
-// --- Helper para obtener la fecha en formato YYYY-MM-DD ---
+// --- Helper para obtener la fecha en formato YYYY-MM-DD_HHmm ---
 function getFormattedDate() {
     const date = new Date();
     const year = date.getFullYear();
     const month = (date.getMonth() + 1).toString().padStart(2, '0');
     const day = date.getDate().toString().padStart(2, '0');
-    return `${year}-${month}-${day}`;
+    const hours = date.getHours().toString().padStart(2, '0');
+    const minutes = date.getMinutes().toString().padStart(2, '0');
+    return `${year}-${month}-${day}_${hours}${minutes}`;
 }
 // --- Generador para el informe de 'analyze' ---
 async function generateAnalysisReport(projectPath, unusedCss, unusedBlockClasses, usedCssSuffixesMap, declaredBlockClassesMap) {

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "vtex-css-sanitizer-cli",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "Herramienta CLI para eliminar CSS y blockClass no utilizados en proyectos VTEX IO.",
   "main": "dist/index.js",
   "bin": {
     "vtex-css-sanitizer": "dist/index.js"
   },
   "scripts": {
-    "build": "npx tsc",
+    "build": "tsc",
     "start": "ts-node src/index.ts",
-    "dev": "npm run build && node dist/index.js"
+    "dev": "npm run build && node dist/index.js",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "vtex",
@@ -20,7 +21,6 @@
   "author": "Elias Daniel Emanuele",
   "license": "ISC",
   "dependencies": {
-    "@types/glob": "^8.1.0",
     "commander": "^11.0.0",
     "glob": "^8.1.0",
     "jsonc-parser": "^3.2.0",
@@ -28,6 +28,7 @@
     "prompts": "^2.4.2"
   },
   "devDependencies": {
+    "@types/glob": "^8.1.0",
     "@types/node": "^20.5.7",
     "@types/prompts": "^2.4.9",
     "ts-node": "^10.9.1",