pull-request-split-advisor 3.1.2

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "pull-request-split-advisor",
+  "version": "3.1.2",
+  "description": "CLI that analyses your Git working tree and suggests how to split changes into smaller, reviewable pull requests and commits.",
+  "keywords": [
+    "git",
+    "pull-request",
+    "pr",
+    "cli",
+    "code-review",
+    "branch",
+    "commit",
+    "workflow",
+    "developer-tools",
+    "typescript",
+    "static-analysis",
+    "diff",
+    "refactoring",
+    "monorepo",
+    "productivity",
+    "devtools",
+    "pr-split",
+    "commit-planner"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "type": "module",
+  "bin": {
+    "pr-split-advisor": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "scripts/postinstall.cjs"
+  ],
+  "scripts": {
+    "build:styles": "node scripts/compile-styles.cjs",
+    "build": "npm run build:styles && tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "dev": "tsx src/cli.ts",
+    "start": "node dist/cli.js",
+    "clean": "rimraf dist",
+    "rebuild": "npm run clean && npm run build",
+    "postinstall": "node scripts/postinstall.cjs",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "optionalDependencies": {
+    "js-yaml": "^4.1.0"
+  },
+  "dependencies": {
+    "boxen": "^8.0.1",
+    "chalk": "^5.3.0",
+    "cli-table3": "^0.6.5",
+    "commander": "^12.1.0",
+    "isbinaryfile": "^5.0.7"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.10.1",
+    "@vitest/coverage-v8": "^4.1.2",
+    "rimraf": "^6.0.1",
+    "sass": "^1.99.0",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "vitest": "^4.1.2"
+  },
+  "engines": {
+    "node": ">=18",
+    "npm": ">=8"
+  },
+  "bundleDependencies": [
+    "boxen",
+    "chalk",
+    "cli-table3",
+    "commander",
+    "isbinaryfile"
+  ]
+}

package/scripts/postinstall.cjs

@@ -0,0 +1,122 @@
+/**
+ * postinstall.cjs — Script ejecutado automáticamente tras `npm install`.
+ *
+ * Crea `pr-split-advisor.config.json` en la raíz del proyecto consumidor
+ * si el archivo aún no existe. Si ya existe, no lo modifica.
+ *
+ * ### Fuente única de verdad
+ * Los valores por defecto NO están hardcodeados aquí. Se cargan dinámicamente
+ * desde `../dist/config/default-config.js` (el TypeScript compilado que se
+ * publica en el package). Así, editar `src/config/default-config.ts` es
+ * suficiente para actualizar el JSON generado; no hay que tocar este script.
+ *
+ * ### Por qué async
+ * `dist/config/default-config.js` es un módulo ESM (el proyecto usa
+ * `"type": "module"`). CJS no puede hacer `require()` de un módulo ESM,
+ * pero sí puede usar `import()` dinámico dentro de una función async.
+ *
+ * ### Directorio destino
+ * Usa INIT_CWD (directorio donde se ejecutó npm install) en lugar de
+ * process.cwd() (que dentro de postinstall apunta al package instalado).
+ * Si INIT_CWD no está disponible (instalación global, yarn, etc.) usa
+ * process.cwd() como fallback.
+ */
+
+const { existsSync, writeFileSync, readFileSync, appendFileSync } = require("fs");
+const { join, resolve } = require("path");
+
+async function main() {
+  const packageDir = resolve(__dirname, "..");
+  const targetDir  = resolve(process.env.INIT_CWD || process.cwd());
+
+  // Evitar crear el archivo dentro del propio repo de desarrollo
+  if (targetDir === packageDir) return;
+
+  const configPath = join(targetDir, "pr-split-advisor.config.json");
+
+  if (existsSync(configPath)) {
+    console.log(
+      "[pr-split-advisor] pr-split-advisor.config.json ya existe — no se sobreescribe."
+    );
+    return;
+  }
+
+  // ── Cargar defaultConfig y RUNTIME_ONLY_FIELDS desde el módulo compilado ──
+  // dist/config/default-config.js siempre está presente al instalar el package
+  // (está declarado en el campo "files" del package.json junto a este script).
+  let rawDefaults;
+  let runtimeOnlyFields;
+  try {
+    const mod = await import("../dist/config/default-config.js");
+    rawDefaults       = mod.defaultConfig;
+    runtimeOnlyFields = mod.RUNTIME_ONLY_FIELDS ?? [];
+  } catch (err) {
+    console.error(
+      "[pr-split-advisor] No se pudieron cargar los defaults compilados: " + err.message +
+      "\n  Asegúrate de que dist/ existe (npm run build) antes de publicar."
+    );
+    // No exit(1): no interrumpir npm install del proyecto consumidor
+    return;
+  }
+
+  // ── Eliminar campos solo-runtime que no deben aparecer en el JSON del usuario
+  // La lista canónica se importa directamente de default-config.ts compilado.
+  // Para añadir/quitar campos excluidos basta con editar RUNTIME_ONLY_FIELDS
+  // en src/config/default-config.ts — sin tocar este script.
+  const userConfig = Object.fromEntries(
+    Object.entries(rawDefaults).filter(([key]) => !runtimeOnlyFields.includes(key))
+  );
+
+  // ── Escribir el archivo de configuración ────────────────────────────────
+  try {
+    writeFileSync(configPath, JSON.stringify(userConfig, null, 2) + "\n", "utf-8");
+    console.log(
+      "[pr-split-advisor] ✔ Creado pr-split-advisor.config.json en " + targetDir
+    );
+    console.log(
+      "[pr-split-advisor]   Edita el archivo para ajustar el análisis a tu proyecto."
+    );
+  } catch (err) {
+    // Fallo silencioso: no interrumpir el proceso de instalación del proyecto consumidor
+    console.warn(
+      "[pr-split-advisor] No se pudo crear el archivo de configuración: " + err.message
+    );
+  }
+
+  // ── Añadir la entrada al .gitignore del proyecto consumidor ─────────────
+  // La config es local por equipo/desarrollador y no debe versionarse.
+  const gitignorePath  = join(targetDir, ".gitignore");
+  const gitignoreEntry = "pr-split-advisor.config.json";
+
+  try {
+    const currentContent = existsSync(gitignorePath)
+      ? readFileSync(gitignorePath, "utf-8")
+      : "";
+
+    const alreadyIgnored = currentContent
+      .split("\n")
+      .map((l) => l.trim())
+      .includes(gitignoreEntry);
+
+    if (!alreadyIgnored) {
+      const block =
+        (currentContent.length && !currentContent.endsWith("\n") ? "\n" : "") +
+        "\n# pr-split-advisor — config local (no compartir en el repositorio)\n" +
+        gitignoreEntry + "\n";
+
+      appendFileSync(gitignorePath, block, "utf-8");
+      console.log(
+        "[pr-split-advisor] ✔ Añadido pr-split-advisor.config.json al .gitignore"
+      );
+    }
+  } catch (err) {
+    console.warn(
+      "[pr-split-advisor] No se pudo actualizar el .gitignore: " + err.message
+    );
+  }
+}
+
+main().catch((err) => {
+  // Fallo silencioso: un error en postinstall no debe bloquear npm install
+  console.warn("[pr-split-advisor] Error en postinstall: " + err.message);
+});