tz-clean 2.3.1 → 2.3.3

package/README-USER.md

@@ -1,105 +1,105 @@
-# User Guide: tz-clean 📖
-
-This guide provides instructions on how to install and use the `tz-clean` CLI tool in your projects.
-
-## Prerequisites
-
-- **Node.js** installed on your machine.
-- A `tsconfig.json` file must exist in the root of the project where you run this tool (required for the typechecking step).
-
-## Installation
-
-Install globally using npm to use it across all your projects:
-
-```bash
-npm install -g tz-clean
-```
-
-To update to the latest version:
-
-```bash
-npm install -g tz-clean@latest
-```
-
-## Usage
-
-Navigate to any project directory and run:
-
-```bash
-tz-clean
-```
-
-### Skipping Specific Tools
-
-Disable any of the integrated tools with the corresponding flag:
-
-| 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
-```
-
-### 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.
-
-Files in the following locations are always skipped automatically:
-
-- `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 to view the results:
-
-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.
+# User Guide: tz-clean 📖
+
+This guide provides instructions on how to install and use the `tz-clean` CLI tool in your projects.
+
+## Prerequisites
+
+- **Node.js** installed on your machine.
+- A `tsconfig.json` file must exist in the root of the project where you run this tool (required for the typechecking step).
+
+## Installation
+
+Install globally using npm to use it across all your projects:
+
+```bash
+npm install -g tz-clean
+```
+
+To update to the latest version:
+
+```bash
+npm install -g tz-clean@latest
+```
+
+## Usage
+
+Navigate to any project directory and run:
+
+```bash
+tz-clean
+```
+
+### Skipping Specific Tools
+
+Disable any of the integrated tools with the corresponding flag:
+
+| 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
+```
+
+### 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.
+
+Files in the following locations are always skipped automatically:
+
+- `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 to view the results:
+
+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/README.md

@@ -1,16 +1,16 @@
-# tz-clean 🧹
-
-A global command-line utility to enforce consistent code quality across your projects. It automatically formats your code with **Prettier**, lints and fixes it with **ESLint**, and performs typechecking with **TypeScript**.
-
-## Features
-
-- **Prettier**: Formats all supported files in the target directory.
-- **ESLint**: Lints and automatically fixes errors using the bundled configuration.
-- **TypeScript**: Performs a type check (`tsc --noEmit`) to ensure type safety.
-
-## Documentation
-
-For more detailed information, please refer to the specific guides:
-
-- 📖 **[User Guide](./README-USER.md)**: Installation, prerequisites, and usage instructions for end-users.
-- 🛠️ **[Developer Guide](./README-DEV.md)**: Instructions for contributing, local testing, and publishing.
+# tz-clean 🧹
+
+A global command-line utility to enforce consistent code quality across your projects. It automatically formats your code with **Prettier**, lints and fixes it with **ESLint**, and performs typechecking with **TypeScript**.
+
+## Features
+
+- **Prettier**: Formats all supported files in the target directory.
+- **ESLint**: Lints and automatically fixes errors using the bundled configuration.
+- **TypeScript**: Performs a type check (`tsc --noEmit`) to ensure type safety.
+
+## Documentation
+
+For more detailed information, please refer to the specific guides:
+
+- 📖 **[User Guide](./README-USER.md)**: Installation, prerequisites, and usage instructions for end-users.
+- 🛠️ **[Developer Guide](./README-DEV.md)**: Instructions for contributing, local testing, and publishing.

package/__tests__/cli.test.js

@@ -1,8 +1,8 @@
-import { describe, expect, it } from 'vitest';
-
-describe('tz-clean CLI environment', () => {
-  it('should have Vitest configured correctly', () => {
-    const tools = ['Prettier', 'ESLint'];
-    expect(tools.includes('ESLint')).toBe(true);
-  });
-});
+import { describe, expect, it } from 'vitest';
+
+describe('tz-clean CLI environment', () => {
+  it('should have Vitest configured correctly', () => {
+    const tools = ['Prettier', 'ESLint'];
+    expect(tools.includes('ESLint')).toBe(true);
+  });
+});

package/commitlint.config.js

@@ -1 +1 @@
-export default { extends: ['@commitlint/config-conventional'] };
+export default { extends: ['@commitlint/config-conventional'] };

package/cspell.json

@@ -1,33 +1,33 @@
-{
-  "version": "0.2",
-  "language": "en",
-  "words": [
-    "terzogenito",
-    "vitest",
-    "depcruise",
-    "typecheck",
-    "jsdoc",
-    "eslint",
-    "prettier",
-    "husky",
-    "sonarjs",
-    "tseslint",
-    "commitlint",
-    "cjs",
-    "mjs",
-    "prompts",
-    "ecma",
-    "typeof",
-    "argv"
-  ],
-  "ignorePaths": [
-    "node_modules",
-    ".git",
-    "package-lock.json",
-    "coverage",
-    ".tz-clean-report.html",
-    ".husky",
-    "dist",
-    "**/*.md"
-  ]
-}
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "terzogenito",
+    "vitest",
+    "depcruise",
+    "typecheck",
+    "jsdoc",
+    "eslint",
+    "prettier",
+    "husky",
+    "sonarjs",
+    "tseslint",
+    "commitlint",
+    "cjs",
+    "mjs",
+    "prompts",
+    "ecma",
+    "typeof",
+    "argv"
+  ],
+  "ignorePaths": [
+    "node_modules",
+    ".git",
+    "package-lock.json",
+    "coverage",
+    ".tz-clean-report.html",
+    ".husky",
+    "dist",
+    "**/*.md"
+  ]
+}

package/eslint.config.mjs

@@ -1,71 +1,72 @@
-import js from '@eslint/js';
-import jsdoc from 'eslint-plugin-jsdoc';
-import noComments from 'eslint-plugin-no-comments';
-import perfectionist from 'eslint-plugin-perfectionist';
-import projectStructure from 'eslint-plugin-project-structure';
-import sonarjs from 'eslint-plugin-sonarjs';
-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,
-  jsdoc.configs['flat/recommended'],
-  perfectionist.configs['recommended-natural'],
-  {
-    linterOptions: {
-      reportUnusedDisableDirectives: 'error',
-    },
-    languageOptions: {
-      ecmaVersion: 2022,
-      globals: {
-        ...globals.browser,
-        ...globals.node,
-        ...globals.jquery,
-        console: 'readonly',
-        document: 'readonly',
-        module: 'readonly',
-        window: 'readonly',
-      },
-      sourceType: 'module',
-    },
-    plugins: {
-      'no-comments': noComments,
-      'project-structure': projectStructure,
-    },
-    rules: {
-      '@typescript-eslint/naming-convention': [
-        'error',
-        { format: ['camelCase'], selector: 'default' },
-        { format: ['camelCase', 'UPPER_CASE'], leadingUnderscore: 'allow', selector: 'variable' },
-        { format: ['camelCase'], leadingUnderscore: 'allow', selector: 'parameter' },
-        { format: ['PascalCase'], selector: 'typeLike' },
-        { format: null, selector: 'objectLiteralProperty' },
-      ],
-      complexity: ['warn', { max: 15 }],
-      'jsdoc/require-jsdoc': 'warn',
-      'jsdoc/require-param': 'warn',
-      'jsdoc/require-returns': 'warn',
-      'no-comments/disallowComments': 'warn',
-      'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0, maxEOF: 0 }],
-      'no-redeclare': 'off',
-      'no-undef': 'off',
-      'no-unused-vars': ['error', { args: 'none', vars: 'local' }],
-      'no-useless-assignment': 'off',
-      'no-useless-escape': 'off',
-    },
-  },
-];
+import js from '@eslint/js';
+import noComments from 'eslint-plugin-no-comments';
+import perfectionist from 'eslint-plugin-perfectionist';
+import projectStructure from 'eslint-plugin-project-structure';
+import sonarjs from 'eslint-plugin-sonarjs';
+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,
+  perfectionist.configs['recommended-natural'],
+  {
+    files: ['index.js'],
+    rules: {
+      'no-comments/disallowComments': 'off',
+    },
+  },
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.jquery,
+        console: 'readonly',
+        document: 'readonly',
+        module: 'readonly',
+        window: 'readonly',
+      },
+      sourceType: 'module',
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: 'error',
+    },
+    plugins: {
+      'no-comments': noComments,
+      'project-structure': projectStructure,
+    },
+    rules: {
+      '@typescript-eslint/naming-convention': [
+        'error',
+        { format: ['camelCase'], selector: 'default' },
+        { format: ['camelCase', 'UPPER_CASE'], leadingUnderscore: 'allow', selector: 'variable' },
+        { format: ['camelCase'], leadingUnderscore: 'allow', selector: 'parameter' },
+        { format: ['PascalCase'], selector: 'typeLike' },
+        { format: null, selector: 'objectLiteralProperty' },
+      ],
+      complexity: ['warn', { max: 15 }],
+      'no-comments/disallowComments': 'warn',
+      'no-multiple-empty-lines': ['warn', { max: 1, maxBOF: 0, maxEOF: 0 }],
+      'no-redeclare': 'off',
+      'no-undef': 'off',
+      'no-unused-vars': ['error', { args: 'none', vars: 'local' }],
+      'no-useless-assignment': 'off',
+      'no-useless-escape': 'off',
+    },
+  },
+];