tz-clean 1.0.0

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120,
+  "tabWidth": 2,
+  "bracketSameLine": true,
+  "htmlWhitespaceSensitivity": "ignore"
+}

package/README-DEV.md

@@ -0,0 +1,56 @@
+# Developer Guide: tz-clean 🛠️
+
+This guide is for developers who want to contribute to the `tz-clean` project, test it locally, or publish it to the npm registry.
+
+## Local Development (For Contributors)
+
+If you are modifying this tool and want to test it locally, clone the repository and install dependencies:
+
+```bash
+npm install
+```
+
+### Available Scripts
+
+You can run the individual scripts locally within this repository:
+
+- `npm run format`: Runs Prettier.
+- `npm run lint`: Runs ESLint without auto-fixing.
+- `npm run lint:fix`: Runs ESLint with auto-fixing.
+- `npm run typecheck`: Runs TypeScript type validation.
+- `npm run fix`: Runs format, lint:fix, and typecheck sequentially.
+
+## Testing the CLI Locally
+
+Before publishing, you should test the global CLI command locally on your computer.
+
+1. Open a terminal inside this project folder (`tz-clean`).
+2. Run this command to install your package globally from the local folder:
+   ```bash
+   npm install -g .
+   ```
+   _(Alternatively, you can use `npm link`)_
+3. Open another folder/repo in your terminal, and type the command:
+   ```bash
+   tz-clean
+   ```
+   If it runs successfully, your configuration is correct.
+
+## Publishing to the NPM Registry
+
+To make the package available via `npm install -g tz-clean` on any computer, you must publish it to the NPM Registry.
+
+1. **Create an NPM account**: If you don't have one, register at [npmjs.com](https://www.npmjs.com/).
+2. **Login via Terminal**: Run `npm login` and enter your account credentials.
+3. **Publish**: Run the `npm publish` command inside your project folder.
+
+### Important Note on Package Names
+
+The package name `tz-clean` is very common and likely already taken in the NPM registry. If it is, `npm publish` will fail with a `403 Forbidden` or `Conflict` error.
+
+If this happens, use a **Scoped Package**:
+
+1. Change `"name"` in `package.json` to `@your-npm-username/tz-clean` (example: `@terzogenito/tz-clean`).
+2. Run `npm publish --access public`.
+3. The install command will become `npm install -g @your-username/tz-clean`.
+4. The executable command in the terminal will remain `tz-clean`, as defined in the `"bin"` property of `package.json`.

package/README-USER.md

@@ -0,0 +1,34 @@
+# 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
+
+You can install this package 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`)_
+
+## Usage
+
+Navigate to any project directory where you want to clean your code and simply run:
+
+```bash
+tz-clean
+```
+
+### What it does:
+
+The tool will sequentially run the following tasks on your project:
+
+1. **Prettier**: Formats your code to ensure consistent styling.
+2. **ESLint**: Lints your code and automatically fixes fixable issues (with auto-fix).
+3. **TypeScript Validation**: Runs `tsc --noEmit` to check for type errors without compiling files.

package/README.md

@@ -0,0 +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.

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+import noCommentsPlugin from 'eslint-plugin-no-comments';
+import js from '@eslint/js';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default [
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'script',
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.jquery,
+        document: 'readonly',
+        window: 'readonly',
+        console: 'readonly',
+        module: 'readonly',
+      },
+    },
+    plugins: {
+      'no-comments': noCommentsPlugin,
+    },
+    rules: {
+      'no-comments/disallowComments': 'error',
+      'no-undef': 'off',
+      'no-unused-vars': ['error', { vars: 'local', args: 'none' }],
+      'no-useless-escape': 'off',
+      'no-useless-assignment': 'off',
+      'no-redeclare': 'off',
+    },
+  },
+];

package/index.js

@@ -0,0 +1,33 @@
+import { execSync } from 'child_process';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const configDir = __dirname;
+const targetDir = process.cwd();
+
+console.log('🧹 Running tz-clean (Prettier, ESLint & Typecheck)...');
+
+try {
+  console.log('\n✨ Running Prettier...');
+  execSync(`npx prettier --write . --config "${path.join(configDir, '.prettierrc')}" --ignore-unknown`, {
+    stdio: 'inherit',
+  });
+
+  console.log('\n🔍 Running ESLint (with --fix)...');
+  execSync(`npx eslint . --fix -c "${path.join(configDir, 'eslint.config.mjs')}"`, { stdio: 'inherit' });
+
+  console.log('\n⚙️ Running Typecheck (tsc)...');
+  if (fs.existsSync(path.join(targetDir, 'tsconfig.json'))) {
+    execSync(`npx tsc --noEmit`, { stdio: 'inherit' });
+  } else {
+    console.log('⚠️ No tsconfig.json found in the target directory. Skipping typecheck.');
+  }
+
+  console.log('\n✅ tz-clean completed successfully!');
+} catch {
+  console.error('\n❌ tz-clean failed to execute.');
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "tz-clean",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "bin": {
+    "tz-clean": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write . --ignore-unknown",
+    "typecheck": "tsc --noEmit",
+    "fix": "npm run format && npm run lint:fix && npm run typecheck"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/terzogenito/text-editor.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/terzogenito/text-editor/issues"
+  },
+  "homepage": "https://github.com/terzogenito/text-editor#readme",
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.6.0",
+    "eslint-plugin-no-comments": "^1.2.1",
+    "globals": "^17.7.0",
+    "prettier": "^3.9.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.63.0"
+  }
+}