pr-checkmate 1.0.6 → 1.0.8

package/README.md

@@ -1,107 +1,96 @@
 # 🔍 PR CheckMate
+> **PR CheckMate** is an npm package for automating Pull Request checks.  
+> It helps teams maintain code quality by automatically validating linting, formatting, dependencies, and spelling before merging to `main`.
 
-> **PR CheckMate** is a public npm package for automating Pull Request checks. It helps teams maintain code quality by validating linting, formatting, dependency changes, and spelling before merging to the main branch.
-
----
 
 ## ⚡ Why PR CheckMate?
+* ✅ Automatic checks on every PR without extra setup.  
+* ✅ No need to install ESLint, Prettier, or cspell in your project — all included.  
+* ✅ Enforces a unified code style across repositories.  
+* ✅ Checks `package.json` / `package-lock.json` for dependency changes.  
+* ✅ Spellcheck for code, documentation, and JSON files.  
 
-When a PR is opened, it's essential that the code follows project standards. PR CheckMate automatically checks:
-
-* ✅ **Linting** — TypeScript/JavaScript code compliance with ESLint rules
-* ✅ **Prettier Auto-Format** — automatically formats code and commits changes if needed
-* ✅ **Dependency Changes** — checks for updates in `package.json`/`package-lock.json` and warns about potential risks
-* ✅ **Spellcheck** — checks spelling in code, documentation, and JSON files using `cspell`
-
----
 
 ## 🛠 How It Works
-
-### 1. Install via npm
+### 1. Install
 
 ```bash
-npm install --save-dev pr_checkmate
+npm install --save-dev pr-checkmate
 ```
 
-### 2. Run as a CLI command
+### 2. Initialize
+```
+npx pr-checkmate init
+```
+This creates a pr-checkmate.json config file, where you can specify the source code path.
 
-```bash
-npx pr-checks <job>
+### 3. Run Checks
+```
+npx pr-checkmate <job>
 ```
 
-**`<job>` options:**
+#### ⚡ Jobs
+| Job        | Description |
+|------------|-------------|
+| `all`      | Run all checks: ESLint, dependency check, Prettier, spellcheck |
+| `lint`     | Lint code using ESLint |
+| `prettier` | Format code using Prettier |
+| `deps`     | Check project dependencies |
+| `spellcheck` | Run spellcheck via cspell |
+<br>
 
-| Job | Description |
-|-----|-------------|
-| `lint` | Lint code using ESLint |
-| `prettier` | Format code with Prettier and push changes |
-| `deps` | Check for dependency changes |
-| `spellcheck` | Run spellcheck on source and documentation |
+## 📦 Example GitHub Actions Workflow
 
-### 3. Use in GitHub Actions
+![pipeline](./assets/pipelineex.png)
 
-Automatically check PRs by adding to your workflow:
 
 ```yaml
+name: PR CheckMate Quality Checks
+
+on:
+  pull_request:
+
 jobs:
   pr-checks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+        
+      - name: 🔧 Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: 20
-      - run: npm ci
-      - run: npx pr-checks lint
-      - run: npx pr-checks prettier
-      - run: npx pr-checks deps
-      - run: npx pr-checks spellcheck
+        
+      - name: 📦 Install project dependencies
+        run: npm ci
+      
+      - name: 🔍 Run PR CheckMate
+        run: npx pr-checkmate all
 ```
+>  Fully automated process: no need to install ESLint, Prettier, or cspell in your repository.
 
----
-
-## 🧰 Tech Stack
-
-* **Node.js 20** — executes scripts
-* **TypeScript** — fully typed code
-* **ESLint + @typescript-eslint** — code linting
-* **Prettier** — auto-formatting
-* **cspell** — spellchecking
-* **execa** — running CLI commands from Node.js
-
----
 
-## 📦 Features
+## 📌 Benefits
 
-* ✅ Works locally and in CI/CD pipelines (GitHub Actions, GitLab CI, etc.)
-* ✅ Uses a built-in `logger` for console output
-* ✅ Automatically detects the current Git branch and pushes commits after auto-formatting
-* ✅ Self-contained package — no external environment variables required
+* ✅ Self-contained — the package handles all checks internally  
+* ✅ Works locally and in CI/CD (GitHub Actions, GitLab CI, etc.)  
+* ✅ Enforces a unified code style across repositories  
+* ✅ Automatic formatting and commits when needed  
+* ✅ Minimal setup — just `init` and `npx pr-checkmate all`
 
----
 
-## 💻 Example Usage in Node.js
-
-```javascript
-import { 
-  runLint, 
-  runDependencyCheck,
-  runPrettier,
-  runSpellcheck
-} from 'pr_checkmate';
-
-async function runAllChecks() {
-  await runLint();
-  await runPrettier();
-  await runDependencyCheck();
-  await runSpellcheck();
-}
-
-runAllChecks();
-```
+## 🧰 Tech Stack
 
----
+* **Node.js 20** — executes CLI scripts  
+* **TypeScript** — fully typed code  
+* **ESLint + @typescript-eslint** — code linting  
+* **Prettier** — auto-formatting  
+* **cspell** — spellchecking  
+* **execa** — running CLI commands from Node.js 
 
-## 📜 License
 
-LicenseRef Proprietary © 2025
+##  📜 License
+LicenseRef Proprietary © 2025

package/dist/scripts/dependency-check.js

@@ -26,5 +26,5 @@ async function runDependencyCheck() {
         utils_1.logger.warn(`Source folder "${config_1.SOURCE_PATH}" not found — skipping deeper checks`);
         return;
     }
-    utils_1.logger.info('Dependencies OK');
+    utils_1.logger.info('✅ Dependencies OK');
 }

package/dist/scripts/index.js

@@ -6,40 +6,44 @@ const prettier_autoformat_1 = require("./prettier-autoformat");
 const spellcheck_1 = require("./spellcheck");
 const utils_1 = require("../utils");
 const lint_1 = require("./lint");
-/**
- * CLI entry point for PR CheckMate.
- *
- * Usage:
- *   npx pr-checks <job>
- *
- * Available jobs:
- *   all         - Run ESLint + Dependency check + Prettier + spellcheck
- *   lint        - Run ESLint
- *   deps        - Check for dependency changes
- *   prettier    - Run Prettier auto-format
- *   spellcheck  - Run cspell spellcheck
- */
 async function runJob(jobName) {
-    switch (jobName) {
-        case 'all':
-            await (0, lint_1.runLint)();
-            await (0, dependency_check_1.runDependencyCheck)();
-            await (0, prettier_autoformat_1.runPrettier)();
-            await (0, spellcheck_1.runSpellcheck)();
-            break;
-        case 'lint':
-            await (0, lint_1.runLint)();
-            break;
-        case 'deps':
-            await (0, dependency_check_1.runDependencyCheck)();
-            break;
-        case 'prettier':
-            await (0, prettier_autoformat_1.runPrettier)();
-            break;
-        case 'spellcheck':
-            await (0, spellcheck_1.runSpellcheck)();
-            break;
-        default:
-            utils_1.logger.log('[runJob]: Available jobs: lint, deps, prettier, spellcheck');
+    utils_1.logger.info(`🚀 Running job: ${jobName}`);
+    try {
+        switch (jobName) {
+            case 'all':
+                await (0, lint_1.runLint)();
+                await (0, dependency_check_1.runDependencyCheck)();
+                try {
+                    await (0, prettier_autoformat_1.runPrettier)();
+                }
+                catch {
+                    utils_1.logger.warn('⚠️ Prettier failed, continuing...');
+                }
+                try {
+                    await (0, spellcheck_1.runSpellcheck)();
+                }
+                catch {
+                    utils_1.logger.warn('⚠️ Spellcheck failed, continuing...');
+                }
+                break;
+            case 'lint':
+                await (0, lint_1.runLint)();
+                break;
+            case 'deps':
+                await (0, dependency_check_1.runDependencyCheck)();
+                break;
+            case 'prettier':
+                await (0, prettier_autoformat_1.runPrettier)();
+                break;
+            case 'spellcheck':
+                await (0, spellcheck_1.runSpellcheck)();
+                break;
+            default:
+                utils_1.logger.warn(`[runJob]: Unknown job "${jobName}". Available: all, lint, deps, prettier, spellcheck`);
+        }
+    }
+    catch (err) {
+        utils_1.logger.error(`❌ Job "${jobName}" failed: ${err}`);
+        throw err;
     }
 }

package/dist/scripts/lint.js

@@ -10,7 +10,7 @@ const config_1 = require("../config");
 const utils_1 = require("../utils");
 /**
  * Run ESLint on the project.
- * Uses local ESLint configuration if available; otherwise defaults to SOURCE_PATH.
+ * Ignores node_modules, dist, and .git automatically.
  *
  * @throws Will throw an error if ESLint detects issues that cannot be fixed automatically.
  */
@@ -19,15 +19,22 @@ async function runLint() {
     const hasLocalConfig = node_fs_1.default.existsSync('eslint.config.mjs') ||
         node_fs_1.default.existsSync('.eslintrc.js') ||
         node_fs_1.default.existsSync('.eslintrc.json');
-    const args = hasLocalConfig
-        ? ['eslint', '.', '--ext', '.ts,.tsx', '--fix']
-        : ['eslint', config_1.SOURCE_PATH, '--ext', '.ts,.tsx', '--fix'];
+    const basePath = hasLocalConfig ? '.' : config_1.SOURCE_PATH;
+    const ignorePatterns = ['**/node_modules/**', '**/dist/**', '**/.git/**'];
+    const args = [
+        'eslint',
+        basePath,
+        '--ext',
+        '.ts,.tsx',
+        '--fix',
+        ...ignorePatterns.flatMap(p => ['--ignore-pattern', p]),
+    ];
     try {
         await (0, execa_1.execa)('npx', args, { stdio: 'inherit' });
-        utils_1.logger.info('ESLint passed');
+        utils_1.logger.info('✅ ESLint passed');
     }
     catch (err) {
-        utils_1.logger.warn('ESLint issues found');
+        utils_1.logger.warn('⚠️ ESLint issues found');
         throw err;
     }
 }

package/dist/scripts/prettier-autoformat.js

@@ -10,7 +10,7 @@ const config_1 = require("../config");
 const utils_1 = require("../utils");
 /**
  * Run Prettier to auto-format project files.
- * If a Prettier config file exists, it runs on the whole project; otherwise on SOURCE_PATH.
+ * Ignores node_modules, dist, and .git folders automatically.
  *
  * @throws Will throw an error if Prettier fails.
  */
@@ -19,17 +19,18 @@ async function runPrettier() {
     const hasConfig = node_fs_1.default.existsSync('.prettierrc') ||
         node_fs_1.default.existsSync('.prettierrc.json') ||
         node_fs_1.default.existsSync('prettier.config.js');
+    // Run on whole project if config exists, otherwise only SOURCE_PATH
     const pattern = hasConfig
-        ? '.' // run on whole project if config exists
-        : `${config_1.SOURCE_PATH}/**/*.{ts,tsx,js,jsx,json,md}`; // otherwise only supported extensions
+        ? '**/*.{ts,tsx,js,jsx,json,md}'
+        : `${config_1.SOURCE_PATH}/**/*.{ts,tsx,js,jsx,json,md}`;
+    // Prettier ignore patterns
+    const ignorePatterns = ['**/node_modules/**', '**/dist/**', '**/.git/**'];
     try {
-        await (0, execa_1.execa)('npx', ['prettier', '--write', pattern], {
-            stdio: 'inherit',
-        });
-        utils_1.logger.info('Prettier completed');
+        await (0, execa_1.execa)('npx', ['prettier', '--write', pattern, ...ignorePatterns.flatMap(p => ['--ignore-path', p])], { stdio: 'inherit' });
+        utils_1.logger.info('✅ Prettier completed');
     }
     catch (err) {
-        utils_1.logger.error('Prettier failed');
+        utils_1.logger.error('❌ Prettier failed');
         throw err;
     }
 }

package/dist/scripts/spellcheck.js

@@ -2,23 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runSpellcheck = runSpellcheck;
 const execa_1 = require("execa");
-const utils_1 = require("../utils");
 const config_1 = require("../config");
+const utils_1 = require("../utils");
 /**
- * Run spellcheck using cspell on the project source files.
- * Only runs on SOURCE_PATH.
+ * Run cspell to check spelling in project files.
+ * Ignores node_modules, dist, and .git folders automatically.
  *
- * @throws Will throw an error if cspell detects spelling issues.
+ * @throws Will throw an error if spelling issues are detected.
  */
 async function runSpellcheck() {
     utils_1.logger.info('Running spellcheck...');
     const pattern = `${config_1.SOURCE_PATH}/**/*`;
+    const ignorePatterns = ['**/node_modules/**', '**/dist/**', '**/.git/**'];
     try {
-        await (0, execa_1.execa)('npx', ['cspell', pattern], { stdio: 'inherit' });
-        utils_1.logger.info('Spellcheck passed');
+        await (0, execa_1.execa)('npx', ['cspell', pattern, ...ignorePatterns.flatMap(p => ['--ignore', p])], {
+            stdio: 'inherit',
+        });
+        utils_1.logger.info('✅ Spellcheck passed');
     }
     catch (err) {
-        utils_1.logger.warn('Spellcheck found issues');
+        utils_1.logger.warn('⚠️ Spellcheck found issues');
         throw err;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.0.6",
+    "version": "1.0.8",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",