tz-clean 2.0.0 → 2.0.2

package/index.js

@@ -1,261 +1,262 @@
-import { execSync } from 'child_process';
-import fs from 'fs';
-import http from 'http';
-import open from 'open';
-import path from 'path';
-import prompts from 'prompts';
-import { fileURLToPath } from 'url';
-
-const filename = fileURLToPath(import.meta.url);
-const dirname = path.dirname(filename);
-const configDir = dirname;
-const targetDir = process.cwd();
-
-/**
- * Calculates the total number of errors and warnings from the ESLint report data.
- * @param {Array<object>} reportData - The report data from ESLint.
- * @returns {{totalErrors: number, totalWarnings: number}} The calculated totals.
- */
-function calculateTotals(reportData) {
-  let totalErrors = 0;
-  let totalWarnings = 0;
-  reportData.forEach((file) => {
-    totalErrors += file.errorCount;
-    totalWarnings += file.warningCount;
-  });
-  return { totalErrors, totalWarnings };
-}
-
-/**
- * Generates an HTML dashboard report.
- * @param {Array<object>} reportData - The report data from ESLint.
- * @param {string[]} fixedFiles - The list of formatted files.
- * @returns {string} The output path of the generated HTML file.
- */
-function generateHtmlReport(reportData, fixedFiles) {
-  const templatePath = path.join(configDir, 'report-template.html');
-  let html = fs.readFileSync(templatePath, 'utf-8');
-
-  html = html.replace('/* REPORT_DATA_PLACEHOLDER */ null', JSON.stringify(reportData));
-  html = html.replace('/* FIXED_FILES_PLACEHOLDER */ []', JSON.stringify(fixedFiles));
-
-  const outputPath = path.join(targetDir, '.tz-clean-report.html');
-  fs.writeFileSync(outputPath, html);
-  return outputPath;
-}
-
-/**
- * Parses command line arguments to determine which tools to run.
- * @returns {{runEslint: boolean, runPrettier: boolean, runTypecheck: boolean, tools: string[]}} The configuration object.
- */
-function parseArgs() {
-  const args = process.argv.slice(2);
-  const runPrettier = !args.includes('--no-prettier');
-  const runEslint = !args.includes('--no-eslint');
-  const runTypecheck = !args.includes('--no-typecheck');
-
-  const tools = [];
-  if (runPrettier) tools.push('Prettier');
-  if (runEslint) tools.push('ESLint');
-  if (runTypecheck) tools.push('Typecheck');
-
-  return { runEslint, runPrettier, runTypecheck, tools };
-}
-
-/**
- * Prints a summary of the analysis report to the terminal.
- * @param {Array<object>} reportData - The report data from ESLint.
- * @param {string[]} fixedFiles - The list of formatted files.
- * @param {number} totalErrors - Total ESLint errors.
- * @param {number} totalWarnings - Total ESLint warnings.
- * @param {{error: string|null, ran: boolean}} typecheckResult - The typecheck execution result.
- * @returns {void}
- */
-function printTerminalSummary(reportData, fixedFiles, totalErrors, totalWarnings, typecheckResult) {
-  console.log('\n--- 📊 tz-clean Summary ---');
-  console.log(`Files Analyzed: ${reportData.length}`);
-  console.log(`Errors (Critical) : ${totalErrors > 0 ? '❌ ' + totalErrors : '✅ 0'}`);
-  console.log(`Warnings          : ${totalWarnings > 0 ? '⚠️ ' + totalWarnings : '✅ 0'}`);
-
-  if (!typecheckResult.ran) {
-    console.log(`Typecheck         : ⚠️ Skipped`);
-  } else if (typecheckResult.error) {
-    console.log(`Typecheck         : ❌ ${typecheckResult.error}`);
-  } else {
-    console.log(`Typecheck         : ✅ Passed`);
-  }
-  console.log('---------------------------');
-
-  if (fixedFiles.length > 0) {
-    console.log('\n✨ Auto-Fixed (Formatted):');
-    fixedFiles.forEach((file) => console.log(`  - ${file}`));
-  }
-
-  if (totalErrors > 0 || totalWarnings > 0) {
-    console.log('\n📝 Details:');
-    reportData.forEach((file) => {
-      if (file.errorCount > 0 || file.warningCount > 0) {
-        console.log(`\n📂 ${path.relative(targetDir, file.filePath) || file.filePath}`);
-        file.messages.forEach((msg) => {
-          const severity = msg.severity === 2 ? '❌ Error' : '⚠️ Warning';
-          console.log(`   ${severity} [${msg.line || 0}:${msg.column || 0}] ${msg.message} (${msg.ruleId || ''})`);
-        });
-      }
-    });
-    console.log('\n---------------------------\n');
-  } else {
-    console.log('\n');
-  }
-}
-
-/**
- * Orchestrates the overall execution of the CLI.
- * @returns {Promise<void>}
- */
-async function run() {
-  const { runEslint, runPrettier, runTypecheck, tools } = parseArgs();
-
-  if (tools.length === 0) {
-    console.log('No tools selected to run.');
-    process.exit(0);
-  }
-
-  console.log(`🧹 Running tz-clean (${tools.join(', ')})...`);
-
-  try {
-    const fixedFiles = runPrettier ? runPrettierTools() : [];
-    const typecheckResult = runTypecheck ? runTypecheckTools() : { error: null, ran: false };
-    const reportData = runEslint ? runEslintTools() : [];
-    const { totalErrors, totalWarnings } = calculateTotals(reportData);
-
-    console.log('\n✅ Analysis complete!');
-    const response = await prompts({
-      choices: [
-        { description: 'Quick overview in terminal', title: 'Terminal Summary', value: 'terminal' },
-        { description: 'Detailed HTML visual report', title: 'UI Dashboard (Browser)', value: 'ui' },
-        { description: 'Serve on localhost port 8080', title: 'UI Dashboard (Hosted)', value: 'hosted' },
-      ],
-      initial: 0,
-      message: 'How would you like to view the analysis report?',
-      name: 'reportType',
-      type: 'select',
-    });
-
-    if (!response.reportType) {
-      console.log('Operation cancelled.');
-      process.exit(0);
-    }
-
-    if (response.reportType === 'terminal') {
-      printTerminalSummary(reportData, fixedFiles, totalErrors, totalWarnings, typecheckResult);
-    } else if (response.reportType === 'ui') {
-      console.log('⏳ Generating UI Dashboard...');
-      const outputPath = generateHtmlReport(reportData, fixedFiles);
-      console.log(`🚀 Opening report in browser: ${outputPath}`);
-      await open(outputPath);
-    } else if (response.reportType === 'hosted') {
-      console.log('⏳ Generating Hosted UI Dashboard...');
-      const templatePath = path.join(configDir, 'report-template.html');
-      let html = fs.readFileSync(templatePath, 'utf-8');
-      html = html.replace('/* REPORT_DATA_PLACEHOLDER */ null', JSON.stringify(reportData));
-      html = html.replace('/* FIXED_FILES_PLACEHOLDER */ []', JSON.stringify(fixedFiles));
-      serveHostedReport(html);
-    }
-  } catch (globalError) {
-    console.error('\n❌ tz-clean encountered a fatal error:', globalError.message);
-    process.exit(1);
-  }
-}
-
-/**
- * Executes ESLint to analyze code.
- * @returns {Array<object>} An array containing the report data from ESLint.
- */
-function runEslintTools() {
-  let eslintOutput = '';
-  let reportData = [];
-  try {
-    eslintOutput = execSync(`npx eslint . --fix -c "${path.join(configDir, 'eslint.config.mjs')}" -f json`, {
-      encoding: 'utf-8',
-      maxBuffer: 1024 * 1024 * 10,
-    });
-  } catch (err) {
-    eslintOutput = err.stdout;
-  }
-
-  if (eslintOutput) {
-    try {
-      reportData = JSON.parse(eslintOutput);
-    } catch (e) {
-      console.error('❌ Failed to parse ESLint output.', e);
-      process.exit(1);
-    }
-  }
-  return reportData;
-}
-
-/**
- * Executes Prettier to format files.
- * @returns {string[]} An array of files that were fixed.
- */
-function runPrettierTools() {
-  let fixedFiles = [];
-  try {
-    const prettierOutput = execSync(
-      `npx prettier --write . --config "${path.join(configDir, '.prettierrc')}" --ignore-unknown`,
-      { encoding: 'utf-8' },
-    );
-    fixedFiles = prettierOutput
-      .split('\n')
-      .filter((line) => line.trim() && !line.includes('(unchanged)'))
-      .map((line) => line.split(' ')[0]);
-  } catch (err) {
-    if (err.stdout) {
-      fixedFiles = err.stdout
-        .split('\n')
-        .filter((line) => line.trim() && !line.includes('(unchanged)'))
-        .map((line) => line.split(' ')[0]);
-    }
-  }
-  return fixedFiles;
-}
-
-/**
- * Executes TypeScript type checking.
- * @returns {{error: string|null, ran: boolean}} The result of type checking.
- */
-function runTypecheckTools() {
-  let typecheckError = null;
-  let ran = false;
-  if (fs.existsSync(path.join(targetDir, 'tsconfig.json'))) {
-    ran = true;
-    try {
-      execSync(`npx tsc --noEmit`, { stdio: 'ignore' });
-    } catch {
-      typecheckError = 'TypeScript validation failed. Check your types.';
-    }
-  }
-  return { error: typecheckError, ran };
-}
-
-/**
- * Serves the HTML report on localhost.
- * @param {string} html - The HTML string content.
- * @returns {void}
- */
-function serveHostedReport(html) {
-  const port = 8080;
-  const server = http.createServer((req, res) => {
-    res.writeHead(200, { 'Content-Type': 'text/html' });
-    res.end(html);
-  });
-
-  server.listen(port, async () => {
-    const url = `http://localhost:${port}`;
-    console.log(`🚀 Server running at ${url}`);
-    console.log('Press Ctrl+C to stop the server.');
-    await open(url);
-  });
-}
-
-run();
+#!/usr/bin/env node
+import { execSync } from 'child_process';
+import fs from 'fs';
+import http from 'http';
+import open from 'open';
+import path from 'path';
+import prompts from 'prompts';
+import { fileURLToPath } from 'url';
+
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+const configDir = dirname;
+const targetDir = process.cwd();
+
+/**
+ * Calculates the total number of errors and warnings from the ESLint report data.
+ * @param {Array<object>} reportData - The report data from ESLint.
+ * @returns {{totalErrors: number, totalWarnings: number}} The calculated totals.
+ */
+function calculateTotals(reportData) {
+  let totalErrors = 0;
+  let totalWarnings = 0;
+  reportData.forEach((file) => {
+    totalErrors += file.errorCount;
+    totalWarnings += file.warningCount;
+  });
+  return { totalErrors, totalWarnings };
+}
+
+/**
+ * Generates an HTML dashboard report.
+ * @param {Array<object>} reportData - The report data from ESLint.
+ * @param {string[]} fixedFiles - The list of formatted files.
+ * @returns {string} The output path of the generated HTML file.
+ */
+function generateHtmlReport(reportData, fixedFiles) {
+  const templatePath = path.join(configDir, 'report-template.html');
+  let html = fs.readFileSync(templatePath, 'utf-8');
+
+  html = html.replace('/* REPORT_DATA_PLACEHOLDER */ null', JSON.stringify(reportData));
+  html = html.replace('/* FIXED_FILES_PLACEHOLDER */ []', JSON.stringify(fixedFiles));
+
+  const outputPath = path.join(targetDir, '.tz-clean-report.html');
+  fs.writeFileSync(outputPath, html);
+  return outputPath;
+}
+
+/**
+ * Parses command line arguments to determine which tools to run.
+ * @returns {{runEslint: boolean, runPrettier: boolean, runTypecheck: boolean, tools: string[]}} The configuration object.
+ */
+function parseArgs() {
+  const args = process.argv.slice(2);
+  const runPrettier = !args.includes('--no-prettier');
+  const runEslint = !args.includes('--no-eslint');
+  const runTypecheck = !args.includes('--no-typecheck');
+
+  const tools = [];
+  if (runPrettier) tools.push('Prettier');
+  if (runEslint) tools.push('ESLint');
+  if (runTypecheck) tools.push('Typecheck');
+
+  return { runEslint, runPrettier, runTypecheck, tools };
+}
+
+/**
+ * Prints a summary of the analysis report to the terminal.
+ * @param {Array<object>} reportData - The report data from ESLint.
+ * @param {string[]} fixedFiles - The list of formatted files.
+ * @param {number} totalErrors - Total ESLint errors.
+ * @param {number} totalWarnings - Total ESLint warnings.
+ * @param {{error: string|null, ran: boolean}} typecheckResult - The typecheck execution result.
+ * @returns {void}
+ */
+function printTerminalSummary(reportData, fixedFiles, totalErrors, totalWarnings, typecheckResult) {
+  console.log('\n--- 📊 tz-clean Summary ---');
+  console.log(`Files Analyzed: ${reportData.length}`);
+  console.log(`Errors (Critical) : ${totalErrors > 0 ? '❌ ' + totalErrors : '✅ 0'}`);
+  console.log(`Warnings          : ${totalWarnings > 0 ? '⚠️ ' + totalWarnings : '✅ 0'}`);
+
+  if (!typecheckResult.ran) {
+    console.log(`Typecheck         : ⚠️ Skipped`);
+  } else if (typecheckResult.error) {
+    console.log(`Typecheck         : ❌ ${typecheckResult.error}`);
+  } else {
+    console.log(`Typecheck         : ✅ Passed`);
+  }
+  console.log('---------------------------');
+
+  if (fixedFiles.length > 0) {
+    console.log('\n✨ Auto-Fixed (Formatted):');
+    fixedFiles.forEach((file) => console.log(`  - ${file}`));
+  }
+
+  if (totalErrors > 0 || totalWarnings > 0) {
+    console.log('\n📝 Details:');
+    reportData.forEach((file) => {
+      if (file.errorCount > 0 || file.warningCount > 0) {
+        console.log(`\n📂 ${path.relative(targetDir, file.filePath) || file.filePath}`);
+        file.messages.forEach((msg) => {
+          const severity = msg.severity === 2 ? '❌ Error' : '⚠️ Warning';
+          console.log(`   ${severity} [${msg.line || 0}:${msg.column || 0}] ${msg.message} (${msg.ruleId || ''})`);
+        });
+      }
+    });
+    console.log('\n---------------------------\n');
+  } else {
+    console.log('\n');
+  }
+}
+
+/**
+ * Orchestrates the overall execution of the CLI.
+ * @returns {Promise<void>}
+ */
+async function run() {
+  const { runEslint, runPrettier, runTypecheck, tools } = parseArgs();
+
+  if (tools.length === 0) {
+    console.log('No tools selected to run.');
+    process.exit(0);
+  }
+
+  console.log(`🧹 Running tz-clean (${tools.join(', ')})...`);
+
+  try {
+    const fixedFiles = runPrettier ? runPrettierTools() : [];
+    const typecheckResult = runTypecheck ? runTypecheckTools() : { error: null, ran: false };
+    const reportData = runEslint ? runEslintTools() : [];
+    const { totalErrors, totalWarnings } = calculateTotals(reportData);
+
+    console.log('\n✅ Analysis complete!');
+    const response = await prompts({
+      choices: [
+        { description: 'Quick overview in terminal', title: 'Terminal Summary', value: 'terminal' },
+        { description: 'Detailed HTML visual report', title: 'UI Dashboard (Browser)', value: 'ui' },
+        { description: 'Serve on localhost port 8080', title: 'UI Dashboard (Hosted)', value: 'hosted' },
+      ],
+      initial: 0,
+      message: 'How would you like to view the analysis report?',
+      name: 'reportType',
+      type: 'select',
+    });
+
+    if (!response.reportType) {
+      console.log('Operation cancelled.');
+      process.exit(0);
+    }
+
+    if (response.reportType === 'terminal') {
+      printTerminalSummary(reportData, fixedFiles, totalErrors, totalWarnings, typecheckResult);
+    } else if (response.reportType === 'ui') {
+      console.log('⏳ Generating UI Dashboard...');
+      const outputPath = generateHtmlReport(reportData, fixedFiles);
+      console.log(`🚀 Opening report in browser: ${outputPath}`);
+      await open(outputPath);
+    } else if (response.reportType === 'hosted') {
+      console.log('⏳ Generating Hosted UI Dashboard...');
+      const templatePath = path.join(configDir, 'report-template.html');
+      let html = fs.readFileSync(templatePath, 'utf-8');
+      html = html.replace('/* REPORT_DATA_PLACEHOLDER */ null', JSON.stringify(reportData));
+      html = html.replace('/* FIXED_FILES_PLACEHOLDER */ []', JSON.stringify(fixedFiles));
+      serveHostedReport(html);
+    }
+  } catch (globalError) {
+    console.error('\n❌ tz-clean encountered a fatal error:', globalError.message);
+    process.exit(1);
+  }
+}
+
+/**
+ * Executes ESLint to analyze code.
+ * @returns {Array<object>} An array containing the report data from ESLint.
+ */
+function runEslintTools() {
+  let eslintOutput = '';
+  let reportData = [];
+  try {
+    eslintOutput = execSync(`npx eslint . --fix -c "${path.join(configDir, 'eslint.config.mjs')}" -f json`, {
+      encoding: 'utf-8',
+      maxBuffer: 1024 * 1024 * 10,
+    });
+  } catch (err) {
+    eslintOutput = err.stdout;
+  }
+
+  if (eslintOutput) {
+    try {
+      reportData = JSON.parse(eslintOutput);
+    } catch (e) {
+      console.error('❌ Failed to parse ESLint output.', e);
+      process.exit(1);
+    }
+  }
+  return reportData;
+}
+
+/**
+ * Executes Prettier to format files.
+ * @returns {string[]} An array of files that were fixed.
+ */
+function runPrettierTools() {
+  let fixedFiles = [];
+  try {
+    const prettierOutput = execSync(
+      `npx prettier --write . --config "${path.join(configDir, '.prettierrc')}" --ignore-unknown`,
+      { encoding: 'utf-8' },
+    );
+    fixedFiles = prettierOutput
+      .split('\n')
+      .filter((line) => line.trim() && !line.includes('(unchanged)'))
+      .map((line) => line.split(' ')[0]);
+  } catch (err) {
+    if (err.stdout) {
+      fixedFiles = err.stdout
+        .split('\n')
+        .filter((line) => line.trim() && !line.includes('(unchanged)'))
+        .map((line) => line.split(' ')[0]);
+    }
+  }
+  return fixedFiles;
+}
+
+/**
+ * Executes TypeScript type checking.
+ * @returns {{error: string|null, ran: boolean}} The result of type checking.
+ */
+function runTypecheckTools() {
+  let typecheckError = null;
+  let ran = false;
+  if (fs.existsSync(path.join(targetDir, 'tsconfig.json'))) {
+    ran = true;
+    try {
+      execSync(`npx tsc --noEmit`, { stdio: 'ignore' });
+    } catch {
+      typecheckError = 'TypeScript validation failed. Check your types.';
+    }
+  }
+  return { error: typecheckError, ran };
+}
+
+/**
+ * Serves the HTML report on localhost.
+ * @param {string} html - The HTML string content.
+ * @returns {void}
+ */
+function serveHostedReport(html) {
+  const port = 8080;
+  const server = http.createServer((req, res) => {
+    res.writeHead(200, { 'Content-Type': 'text/html' });
+    res.end(html);
+  });
+
+  server.listen(port, async () => {
+    const url = `http://localhost:${port}`;
+    console.log(`🚀 Server running at ${url}`);
+    console.log('Press Ctrl+C to stop the server.');
+    await open(url);
+  });
+}
+
+run();

package/knip.json

@@ -1,5 +1,5 @@
-{
-  "$schema": "https://unpkg.com/knip@5/schema-json.json",
-  "entry": ["index.js", "__tests__/**/*.test.js"],
-  "project": ["**/*.js", "**/*.mjs"]
-}
+{
+  "$schema": "https://unpkg.com/knip@5/schema-json.json",
+  "entry": ["index.js", "__tests__/**/*.test.js"],
+  "project": ["**/*.js", "**/*.mjs"]
+}