ui-code-health-check 0.0.0

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "none",
+  "printWidth": 100,
+  "tabWidth": 2
+}

package/README.md

@@ -0,0 +1,88 @@
+# TESTING NEW PACKAGE, NOT FOR USE YET
+
+# UI Code Health Check
+
+**UI Code Health Check** is a CLI tool that helps you maintain high code quality in your TypeScript projects. It automates common checks such as linting, testing, spell checking, type checking, and building, running only the steps that are configured in your project.
+
+## Features
+
+- **Linting**: Runs ESLint to enforce code style and best practices.
+- **Testing**: Executes your project's test suite (if defined).
+- **Spell Checking**: Uses cspell to catch spelling mistakes (if defined).
+- **TypeScript Checking**: Runs TypeScript type checks (if defined).
+- **Build**: Executes your build script (if defined).
+- **Smart Skipping**: Automatically skips any step if the corresponding script is missing in your `package.json`.
+
+## Installation
+
+Add this package as a dev dependency:
+
+```bash
+npm install --save-dev ui-code-health-check
+# or
+pnpm add -D ui-code-health-check
+# or
+yarn add -D ui-code-health-check
+```
+
+## Usage
+
+After installation, you can run the health check from your project root:
+
+```bash
+npx ui-code-health-check
+```
+
+Or add it as a script in your `package.json`:
+
+```json
+{
+  "scripts": {
+    "health-check": "ui-code-health-check"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run health-check
+```
+
+## How It Works
+
+The tool checks your `package.json` for the following scripts and runs them in order if they exist:
+
+1. `lint`
+2. `test`
+3. `cspell`
+4. `typecheck`
+5. `build`
+
+If a script is missing, that step is skipped.
+
+## Configuration
+
+- **ESLint**: Ensure you have a `lint` script in your `package.json` (e.g., `"lint": "eslint ."`).
+- **Testing**: Add a `test` script (e.g., `"test": "jest"`).
+- **Spell Checking**: Add a `cspell` script (e.g., `"cspell": "cspell '**'"`).
+- **Type Checking**: Add a `typecheck` script (e.g., `"typecheck": "tsc --noEmit"`).
+- **Build**: Add a `build` script (e.g., `"build": "tsc"` or your build tool).
+
+## Example `package.json` Scripts
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "test": "jest",
+    "cspell": "cspell '**'",
+    "typecheck": "tsc --noEmit",
+    "build": "tsc"
+  }
+}
+```
+
+## License
+
+MIT

package/dist/index.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const steps = [
+    { name: 'Lint', cmd: 'npm run lint', script: 'lint' },
+    { name: 'Test', cmd: 'npm run test', script: 'test' },
+    { name: 'CSpell', cmd: 'npm run cspell', script: 'cspell' },
+    { name: 'TypeScript Check', cmd: 'npm run ts-check', script: 'ts-check' },
+    { name: 'Build', cmd: 'npm run build', script: 'build' }
+];
+const start = Date.now();
+console.log(chalk_1.default.bgBlue.white.bold('\n========== Starting UI Code Health Check ==========\n'));
+console.log(chalk_1.default.white.bold('Version: 1.0.0\n' +
+    'Developed by: IF | Janis Dregeris \n' +
+    'Date: 2026/01\n' +
+    `Run: ${new Date().getFullYear()}/${String(new Date().getMonth() + 1).padStart(2, '0')}\n`));
+// Read package.json scripts
+let scripts = {};
+try {
+    const pkg = JSON.parse((0, node_fs_1.readFileSync)('package.json', 'utf-8'));
+    scripts = pkg.scripts || {};
+}
+catch (_a) {
+    console.log(chalk_1.default.red('❌ Could not read package.json.'));
+    process.exit(1);
+}
+for (const step of steps) {
+    if (!scripts[step.script]) {
+        console.log(chalk_1.default.yellow(`⚠️  Skipping "${step.name}" — missing "${step.script}" script in package.json.`));
+        continue;
+    }
+    const stepStart = Date.now();
+    try {
+        console.log(chalk_1.default.blueBright(`\n▶ ${step.name}...`));
+        (0, node_child_process_1.execSync)(step.cmd, { stdio: 'inherit' });
+        const stepTime = ((Date.now() - stepStart) / 1000).toFixed(2);
+        console.log(chalk_1.default.green(`✔ ${step.name} finished in ${stepTime}s`));
+    }
+    catch (error) {
+        console.log(chalk_1.default.red(`❌ ${step.name} failed, ${chalk_1.default.bold.bgBlackBright(error)}. Please fix the issues above and try again. Before committing, make sure all checks pass.\n`));
+        console.log(chalk_1.default.yellow([
+            `ℹ️  lint-staged will prevent committing if any of these errors are present.`,
+            `You can run ${chalk_1.default.bold.bgBlackBright('npm run ch')} to catch errors before committing.`,
+            `\nDetected errors may include:`,
+            `- Linting issues (code style, formatting, best practices)`,
+            `- Failing tests`,
+            `- Spelling mistakes`,
+            `- TypeScript type errors`,
+            `- Build errors`,
+            `\n⚠️  Note: This code health check will stop executing further commands as soon as an error is detected.`,
+            `If you get errors from one command, errors from subsequent commands will only appear after you fix the current errors and re-run the script.`,
+            `It will not show all errors from all commands at once; you need to resolve issues step by step.`,
+            `You need to run ${chalk_1.default.bold.bgBlackBright('npm run ch')} again after fixing each errors group, until all steps succeed.`,
+            `\n❗ Please resolve all reported issues to ensure a successful commit.\n`
+        ].join('\n')));
+        process.exit(1);
+    }
+}
+const totalTime = ((Date.now() - start) / 1000).toFixed(2);
+console.log(chalk_1.default.green(`\n🏁 All steps finished in ${totalTime}s\n`));
+console.log(chalk_1.default.bold.green('All checks passed! Now you can make a commit. 🚀 \n'));

package/eslint.config.cjs

@@ -0,0 +1,23 @@
+const { defineConfig } = require('eslint/config')
+const tsPlugin = require('@typescript-eslint/eslint-plugin')
+const tsParser = require('@typescript-eslint/parser')
+
+module.exports = defineConfig([
+  { ignores: ['node_modules/**', 'dist/**'] },
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: './tsconfig.json',
+        sourceType: 'module'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': tsPlugin
+    },
+    rules: {
+      ...tsPlugin.configs.recommended.rules
+    }
+  }
+])

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "ui-code-health-check",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/juandrepanther/ui-code-health-check.git"
+  },
+  "version": "0.0.0",
+  "description": "A package to perform a series of code quality checks including linting, testing, spell checking, TypeScript checking, and building.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "ui-code-health-check": "dist/index.js"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "build": "tsc",
+    "ch": "node dist/index.js",
+    "prettier": "prettier --write \"src/**/*.{ts,tsx}\""
+  },
+  "dependencies": {
+    "chalk": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "cspell": "^9.4.0",
+    "eslint": "^9.39.2",
+    "prettier": "^3.8.0",
+    "typescript": "^5.9.3"
+  },
+  "keywords": [
+    "code",
+    "health",
+    "check",
+    "lint",
+    "test",
+    "typescript"
+  ],
+  "author": "juandrepanther",
+  "license": "MIT"
+}

package/src/index.ts

@@ -0,0 +1,81 @@
+import chalk from 'chalk'
+import { execSync } from 'node:child_process'
+import { readFileSync } from 'node:fs'
+
+const steps = [
+  { name: 'Lint', cmd: 'npm run lint', script: 'lint' },
+  { name: 'Test', cmd: 'npm run test', script: 'test' },
+  { name: 'CSpell', cmd: 'npm run cspell', script: 'cspell' },
+  { name: 'TypeScript Check', cmd: 'npm run ts-check', script: 'ts-check' },
+  { name: 'Build', cmd: 'npm run build', script: 'build' }
+]
+
+const start = Date.now()
+
+console.log(chalk.bgBlue.white.bold('\n========== Starting UI Code Health Check ==========\n'))
+console.log(
+  chalk.white.bold(
+    'Version: 1.0.0\n' +
+      'Developed by: IF | Janis Dregeris \n' +
+      'Date: 2026/01\n' +
+      `Run: ${new Date().getFullYear()}/${String(new Date().getMonth() + 1).padStart(2, '0')}\n`
+  )
+)
+
+// Read package.json scripts
+let scripts: Record<string, string> = {}
+try {
+  const pkg = JSON.parse(readFileSync('package.json', 'utf-8'))
+  scripts = pkg.scripts || {}
+} catch {
+  console.log(chalk.red('❌ Could not read package.json.'))
+  process.exit(1)
+}
+
+for (const step of steps) {
+  if (!scripts[step.script]) {
+    console.log(
+      chalk.yellow(`⚠️  Skipping "${step.name}" — missing "${step.script}" script in package.json.`)
+    )
+    continue
+  }
+
+  const stepStart = Date.now()
+
+  try {
+    console.log(chalk.blueBright(`\n▶ ${step.name}...`))
+    execSync(step.cmd, { stdio: 'inherit' })
+    const stepTime = ((Date.now() - stepStart) / 1000).toFixed(2)
+    console.log(chalk.green(`✔ ${step.name} finished in ${stepTime}s`))
+  } catch (error) {
+    console.log(
+      chalk.red(
+        `❌ ${step.name} failed, ${chalk.bold.bgBlackBright(error)}. Please fix the issues above and try again. Before committing, make sure all checks pass.\n`
+      )
+    )
+    console.log(
+      chalk.yellow(
+        [
+          `ℹ️  lint-staged will prevent committing if any of these errors are present.`,
+          `You can run ${chalk.bold.bgBlackBright('npm run ch')} to catch errors before committing.`,
+          `\nDetected errors may include:`,
+          `- Linting issues (code style, formatting, best practices)`,
+          `- Failing tests`,
+          `- Spelling mistakes`,
+          `- TypeScript type errors`,
+          `- Build errors`,
+          `\n⚠️  Note: This code health check will stop executing further commands as soon as an error is detected.`,
+          `If you get errors from one command, errors from subsequent commands will only appear after you fix the current errors and re-run the script.`,
+          `It will not show all errors from all commands at once; you need to resolve issues step by step.`,
+          `You need to run ${chalk.bold.bgBlackBright('npm run ch')} again after fixing each errors group, until all steps succeed.`,
+          `\n❗ Please resolve all reported issues to ensure a successful commit.\n`
+        ].join('\n')
+      )
+    )
+    process.exit(1)
+  }
+}
+
+const totalTime = ((Date.now() - start) / 1000).toFixed(2)
+console.log(chalk.green(`\n🏁 All steps finished in ${totalTime}s\n`))
+console.log(chalk.bold.green('All checks passed! Now you can make a commit. 🚀 \n'))

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
+}