tz-clean 2.0.2 → 2.1.0

package/README-USER.md

@@ -9,17 +9,21 @@ This guide provides instructions on how to install and use the `tz-clean` CLI to
 
 ## Installation
 
-You can install this package globally using npm to use it across all your projects:
+Install globally using npm to use it across all your projects:
 
 ```bash
 npm install -g tz-clean
 ```
 
-_(Note: If published under a scoped name, the command might be `npm install -g @your-username/tz-clean`)_
+To update to the latest version:
+
+```bash
+npm install -g tz-clean@latest
+```
 
 ## Usage
 
-Navigate to any project directory where you want to clean your code and simply run:
+Navigate to any project directory and run:
 
 ```bash
 tz-clean
@@ -27,30 +31,75 @@ tz-clean
 
 ### Skipping Specific Tools
 
-You can selectively disable any of the integrated tools by passing the corresponding flag:
-
-- `--no-prettier`: Disables auto-formatting with Prettier.
-- `--no-eslint`: Disables linting and auto-fixing with ESLint.
-- `--no-typecheck`: Disables TypeScript validation.
+Disable any of the integrated tools with the corresponding flag:
 
-**Example:**
+| Flag | Description |
+|---|---|
+| `--no-prettier` | Disables auto-formatting with Prettier |
+| `--no-eslint` | Disables linting and auto-fixing with ESLint |
+| `--no-typecheck` | Disables TypeScript validation |
 
 ```bash
 tz-clean --no-prettier --no-typecheck
 ```
 
-### What it does:
+### Including Specific Paths
+
+Use `--include` to run the tools only on specific files or directories (comma-separated):
+
+```bash
+# Analyze only the src folder
+tz-clean --include src
+
+# Analyze multiple folders
+tz-clean --include src,app,lib
+```
+
+### Excluding Specific Paths
+
+Use `--exclude` to skip files or directories (comma-separated):
+
+```bash
+# Exclude a single folder
+tz-clean --exclude js/libs
+
+# Exclude multiple folders
+tz-clean --exclude js/libs,dist,vendor
+```
+
+### Combining Options
+
+All flags can be combined freely:
+
+```bash
+# Analyze only src, skip typecheck
+tz-clean --include src --no-typecheck
+
+# Exclude generated files, skip prettier
+tz-clean --exclude dist,vendor --no-prettier
+
+# Include specific folder and exclude a subfolder within it
+tz-clean --include src --exclude src/generated
+```
+
+### What It Does
+
+The tool runs the following tasks sequentially (unless disabled):
+
+1. **Prettier** — Formats your code for consistent styling.
+2. **ESLint** — Lints and auto-fixes fixable issues.
+3. **TypeScript Validation** — Runs `tsc --noEmit` to check for type errors.
 
-The tool will sequentially run the following tasks on your project (unless disabled):
+Files in the following locations are always skipped automatically:
 
-1. **Prettier**: Formats your code to ensure consistent styling.
-2. **ESLint**: Lints your code and automatically fixes fixable issues.
-3. **TypeScript Validation**: Runs `tsc --noEmit` to check for type errors.
+- `node_modules/`
+- `dist/`, `build/`, `vendor/`, `libs/`
+- Any file matching `*.min.js` or `*.min.cjs`
 
 ### Viewing the Report
 
-After analysis, you will be prompted to choose how you want to view the results:
+After analysis, you will be prompted to choose how to view the results:
 
-1. **Terminal Summary**: A quick overview printed directly in your terminal, including a list of auto-fixed files and detailed error logs.
-2. **UI Dashboard (Browser)**: Generates a beautiful HTML report and automatically opens it in your default web browser.
-3. **UI Dashboard (Hosted)**: Spawns a local server on port `8080` to host the HTML report, and opens `http://localhost:8080` in your browser.
+1. **Terminal Summary** — A quick overview printed in your terminal, including auto-fixed files and detailed error logs.
+2. **UI Dashboard (Browser)** — Generates an HTML report and opens it automatically in your default browser.
+3. **UI Dashboard (Hosted)** — Starts a local server on port `8080` and opens `http://localhost:8080` in your browser.

package/eslint.config.mjs

@@ -7,6 +7,18 @@ import globals from 'globals';
 import tseslint from 'typescript-eslint';
 
 export default [
+  {
+    ignores: [
+      '**/node_modules/**',
+      '**/*.min.js',
+      '**/*.min.cjs',
+      '**/*.bundle.js',
+      '**/dist/**',
+      '**/build/**',
+      '**/vendor/**',
+      '**/libs/**',
+    ],
+  },
   js.configs.recommended,
   ...tseslint.configs.recommended,
   sonarjs.configs.recommended,

package/index.js

@@ -47,7 +47,7 @@ function generateHtmlReport(reportData, fixedFiles) {
 
 /**
  * Parses command line arguments to determine which tools to run.
- * @returns {{runEslint: boolean, runPrettier: boolean, runTypecheck: boolean, tools: string[]}} The configuration object.
+ * @returns {{runEslint: boolean, runPrettier: boolean, runTypecheck: boolean, tools: string[], includePaths: string[], excludePaths: string[]}} The configuration object.
  */
 function parseArgs() {
   const args = process.argv.slice(2);
@@ -55,12 +55,25 @@ function parseArgs() {
   const runEslint = !args.includes('--no-eslint');
   const runTypecheck = !args.includes('--no-typecheck');
 
+  const includePaths = [];
+  const excludePaths = [];
+
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === '--include' && args[i + 1]) {
+      args[i + 1].split(',').forEach((p) => includePaths.push(p.trim()));
+      i++;
+    } else if (args[i] === '--exclude' && args[i + 1]) {
+      args[i + 1].split(',').forEach((p) => excludePaths.push(p.trim()));
+      i++;
+    }
+  }
+
   const tools = [];
   if (runPrettier) tools.push('Prettier');
   if (runEslint) tools.push('ESLint');
   if (runTypecheck) tools.push('Typecheck');
 
-  return { runEslint, runPrettier, runTypecheck, tools };
+  return { excludePaths, includePaths, runEslint, runPrettier, runTypecheck, tools };
 }
 
 /**
@@ -114,7 +127,7 @@ function printTerminalSummary(reportData, fixedFiles, totalErrors, totalWarnings
  * @returns {Promise<void>}
  */
 async function run() {
-  const { runEslint, runPrettier, runTypecheck, tools } = parseArgs();
+  const { runEslint, runPrettier, runTypecheck, tools, includePaths, excludePaths } = parseArgs();
 
   if (tools.length === 0) {
     console.log('No tools selected to run.');
@@ -122,11 +135,13 @@ async function run() {
   }
 
   console.log(`🧹 Running tz-clean (${tools.join(', ')})...`);
+  if (includePaths.length > 0) console.log(`📁 Include: ${includePaths.join(', ')}`);
+  if (excludePaths.length > 0) console.log(`🚫 Exclude: ${excludePaths.join(', ')}`);
 
   try {
-    const fixedFiles = runPrettier ? runPrettierTools() : [];
+    const fixedFiles = runPrettier ? runPrettierTools(includePaths, excludePaths) : [];
     const typecheckResult = runTypecheck ? runTypecheckTools() : { error: null, ran: false };
-    const reportData = runEslint ? runEslintTools() : [];
+    const reportData = runEslint ? runEslintTools(includePaths, excludePaths) : [];
     const { totalErrors, totalWarnings } = calculateTotals(reportData);
 
     console.log('\n✅ Analysis complete!');
@@ -170,16 +185,25 @@ async function run() {
 
 /**
  * Executes ESLint to analyze code.
+ * @param {string[]} includePaths - Paths to include in analysis.
+ * @param {string[]} excludePaths - Paths to exclude from analysis.
  * @returns {Array<object>} An array containing the report data from ESLint.
  */
-function runEslintTools() {
+function runEslintTools(includePaths = [], excludePaths = []) {
   let eslintOutput = '';
   let reportData = [];
+
+  const targets = includePaths.length > 0 ? includePaths.map((p) => `"${p}"`).join(' ') : '.';
+  const ignoreFlags = excludePaths.map((p) => `--ignore-pattern "${p}"`).join(' ');
+
   try {
-    eslintOutput = execSync(`npx eslint . --fix -c "${path.join(configDir, 'eslint.config.mjs')}" -f json`, {
-      encoding: 'utf-8',
-      maxBuffer: 1024 * 1024 * 10,
-    });
+    eslintOutput = execSync(
+      `npx eslint ${targets} --fix -c "${path.join(configDir, 'eslint.config.mjs')}" -f json ${ignoreFlags}`,
+      {
+        encoding: 'utf-8',
+        maxBuffer: 1024 * 1024 * 10,
+      },
+    );
   } catch (err) {
     eslintOutput = err.stdout;
   }
@@ -197,13 +221,19 @@ function runEslintTools() {
 
 /**
  * Executes Prettier to format files.
+ * @param {string[]} includePaths - Paths to include in formatting.
+ * @param {string[]} excludePaths - Paths to exclude from formatting.
  * @returns {string[]} An array of files that were fixed.
  */
-function runPrettierTools() {
+function runPrettierTools(includePaths = [], excludePaths = []) {
   let fixedFiles = [];
+
+  const targets = includePaths.length > 0 ? includePaths.map((p) => `"${p}"`).join(' ') : '.';
+  const ignoreFlags = excludePaths.map((p) => `--ignore-path-without-warn "${p}"`).join(' ');
+
   try {
     const prettierOutput = execSync(
-      `npx prettier --write . --config "${path.join(configDir, '.prettierrc')}" --ignore-unknown`,
+      `npx prettier --write ${targets} --config "${path.join(configDir, '.prettierrc')}" --ignore-unknown ${ignoreFlags}`,
       { encoding: 'utf-8' },
     );
     fixedFiles = prettierOutput

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "tz-clean",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "",
   "main": "index.js",
   "bin": {
-    "tz-clean": "./index.js"
+    "tz-clean": "index.js"
   },
   "scripts": {
     "test": "vitest run",