pr-checkmate 1.19.10 → 1.19.19

package/README.md

@@ -4,17 +4,17 @@
 
 
 # ♟️ PR CheckMate
-> **PR CheckMate** is an npm package for automating Pull Request checks.  
+> **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`.
 
 ## 🔍 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.  
+* ✅ 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 with multilingual support (EN, RU, UK, HE, FR).
 * ✅ Package Vulnerabilities Check
-* ✅ Scans for secrets using
+* ✅ Scans for secrets using gitleaks
 
 <br>
 > ⚠️ **Note:** Currently, PR CheckMate only supports **Node.js projects**.
@@ -23,10 +23,10 @@
 - [PR CheckMate](https://www.npmjs.com/package/pr-checkmate) – Zero-config CLI that automates ESLint, Prettier, spellcheck, dependency checks, and npm audit for pull requests.
 
 ## 🚀 Zero-Config by Default
-You don’t need to install or configure:
+You don't need to install or configure:
 - ESLint
 - Prettier
-- cspell
+- cspell (with multilingual dictionaries)
 - Security scanning tools
 
 > Everything works out of the box.
@@ -47,7 +47,7 @@ User configuration is stored in:
 <br>
 
 ### ⚙️ Example: pr-checkmate.json
-```
+```json
 {
   "sourcePath": "src",
   "commands": {
@@ -91,77 +91,130 @@ npm install --save-dev pr-checkmate
 ```
 
 ### 2. Initialize
-```
+```bash
 npx pr-checkmate init
 ```
-> This creates a pr-checkmate.json config file, where you can specify the source code path.
+> This creates:
+> - `pr-checkmate.json` - Configuration file where you can specify the source code path and customize rules
+> - `.github/workflows/pr-checkmate.yml` - GitHub Actions workflow for automated PR checks with auto-commit support
 
 ### 3. Run Checks
-```
+```bash
 npx pr-checkmate <job>
 ```
 
 #### ⚡ Jobs
 | Job        | Description |
 |------------|-------------|
-| `all`      | Run all checks: ESLint, dependency check, Prettier, spellcheck |
+| `all`      | Run all checks: ESLint, dependency check, Prettier, spellcheck, security scan |
 | `lint`     | Lint code using ESLint |
 | `prettier` | Format code using Prettier |
 | `deps`     | Check project dependencies |
 | `security` | Run security scan for secrets |
-| `spellcheck` | Run spellcheck via cspell |
+| `spellcheck` | Run spellcheck via cspell (supports EN, RU, UK, HE, FR) |
 | `audit`      | Run `npm audit --audit-level=moderate` to check for vulnerable packages |
 
 <br>
 
-## 📦 Example GitHub Actions Workflow
+## 🤖 GitHub Actions Workflow (Auto-Generated)
+
+When you run `npx pr-checkmate init`, it automatically creates `.github/workflows/pr-checkmate.yml`:
 
 ```yaml
-name: PR CheckMate Quality Checks
+name: PR Checkmate Quality Checks
 
 on:
   pull_request:
+    branches: [main, master, develop]
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: write
+  pull-requests: write
 
 jobs:
-  pr-checks:
+  pr-checkmate-all:
+    name: PR Checkmate All Checks
     runs-on: ubuntu-latest
     steps:
-      - name: 📥 Checkout code
+      - name: Checkout code
         uses: actions/checkout@v4
         with:
+          ref: ${{ github.head_ref }}
           fetch-depth: 0
-        
-      - name: 🔧 Setup Node.js
+
+      - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 20
-        
-      - name: 📦 Install project dependencies
+
+      - name: Install dependencies
         run: npm ci
-      
-      - name: 🔍 Run PR CheckMate
+
+      - name: Run PR Checkmate All Checks
         run: npx pr-checkmate all
+        continue-on-error: true
+
+      - name: Auto-commit formatting changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add -A
+          if ! git diff --cached --quiet; then
+            git commit -m "style: auto-format code with Prettier"
+            git push origin HEAD:${{ github.head_ref }}
+            echo "Formatting changes committed and pushed"
+          else
+            echo "No formatting changes needed"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
->  Fully automated process: no need to install ESLint, Prettier, or cspell in your repository.
 
+### ⚙️ GitHub Actions Permissions
+
+For the auto-commit feature to work, ensure your repository has the correct permissions:
+
+1. Go to **Settings** → **Actions** → **General** → **Workflow permissions**
+2. Select **"Read and write permissions"**
+3. Save changes
+
+> The workflow will automatically commit Prettier formatting fixes directly to your PR branch.
+
+<br>
+
+## 🌍 Multilingual Spellcheck Support
+
+PR CheckMate includes built-in dictionaries for:
+- 🇬🇧 English (en)
+- 🇷🇺 Russian (ru)
+- 🇺🇦 Ukrainian (uk)
+- 🇮🇱 Hebrew (he)
+- 🇫🇷 French (fr)
+
+No additional configuration needed - just use `npx pr-checkmate spellcheck` and it will check spelling in all supported languages!
+
+<br>
 
 ## 📌 Benefits
 
-* ✅ 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  
+* ✅ 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
+* ✅ Multilingual spellcheck support out of the box
 * ✅ Minimal setup — just `init` and `npx pr-checkmate all`
 
 
 ## 🧰 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 
+* **Node.js 20** — executes CLI scripts
+* **TypeScript** — fully typed code
+* **ESLint + @typescript-eslint** — code linting
+* **Prettier** — auto-formatting
+* **cspell** — spellchecking with multilingual dictionaries
+* **execa** — running CLI commands from Node.js
+* **gitleaks** — secret scanning
 
 
 ##  📜 License

package/cspell.json

@@ -1,6 +1,12 @@
 {
   "version": "0.2",
-  "language": "en",
+  "language": "en,ru,uk,he,fr",
+  "import": [
+    "./node_modules/@cspell/dict-ru_ru/cspell-ext.json",
+    "./node_modules/@cspell/dict-uk-ua/cspell-ext.json",
+    "./node_modules/@cspell/dict-he/cspell-ext.json",
+    "./node_modules/@cspell/dict-fr-fr/cspell-ext.json"
+  ],
   "words": [
     "Artur",
     "Polishchuk",
@@ -20,7 +26,30 @@
     "pycache",
     "wdio",
     "htmlcov",
-    "mochawesome"
+    "mochawesome",
+    "dont",
+    "appinstalled",
+    "beforeinstallprompt",
+    "nav",
+    "navs",
+    "pr",
+    "recaptcha",
+    "tsconfig",
+    "vite",
+    "vitejs",
+    "Mavox",
+    "sultansadikov",
+    "Appi",
+    "Validatable",
+    "Osek",
+    "Patur",
+    "Mursheh",
+    "Hevra",
+    "Baam",
+    "Amuta",
+    "Sachir",
+    "gitleaks",
+    "mybono"
   ],
   "ignorePaths": [
     "**/node_modules/**",

package/dist/init.js

@@ -60,8 +60,23 @@ async function init() {
         };
         fs_1.default.writeFileSync(exports.CONFIG_FILE, JSON.stringify(config, null, 2));
         utils_1.logger.info(`[init]: ✅ Created pr-checkmate.json with sourcePath: ${sourcePath}`);
-        utils_1.logger.info(`[init]: 💡 You can now customize ESLint rules, Prettier settings, 
+        utils_1.logger.info(`[init]: 💡 You can now customize ESLint rules, Prettier settings,
       and cspell words in pr-checkmate.json`);
+        // Copy workflow file to .github/workflows/
+        const workflowSource = path_1.default.join(__dirname, 'config', 'pr-checkmate-workflow.yml');
+        const workflowDir = path_1.default.join(root, '.github', 'workflows');
+        const workflowDest = path_1.default.join(workflowDir, 'pr-checkmate.yml');
+        if (fs_1.default.existsSync(workflowSource)) {
+            if (!fs_1.default.existsSync(workflowDir)) {
+                fs_1.default.mkdirSync(workflowDir, { recursive: true });
+            }
+            fs_1.default.copyFileSync(workflowSource, workflowDest);
+            utils_1.logger.info('[init]: ✅ Created .github/workflows/pr-checkmate.yml');
+            utils_1.logger.info('[init]: 🚀 GitHub Actions workflow is ready for your PRs!');
+        }
+        else {
+            utils_1.logger.warn('[init]: ⚠️ Workflow template not found, skipping workflow setup');
+        }
         const tsconfigPath = path_1.default.join(root, 'tsconfig.json');
         if (!fs_1.default.existsSync(tsconfigPath)) {
             const newTsConfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.19.10",
+    "version": "1.19.19",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",
@@ -24,6 +24,7 @@
         ".prettierrc",
         ".eslintignore",
         "cspell.json",
+        "src/config/pr-checkmate-workflow.yml",
         "LICENSE"
     ],
     "scripts": {
@@ -56,6 +57,10 @@
     "author": "Artur Polishchuk",
     "license": "LicenseRef-Proprietary",
     "dependencies": {
+        "@cspell/dict-fr-fr": "^2.2.2",
+        "@cspell/dict-he": "^4.0.2",
+        "@cspell/dict-ru_ru": "^2.2.1",
+        "@cspell/dict-uk-ua": "^4.0.0",
         "@typescript-eslint/eslint-plugin": "^8.47.0",
         "@typescript-eslint/parser": "^8.47.0",
         "cspell": "^9.3.2",
@@ -65,7 +70,7 @@
         "eslint-plugin-import": "^2.29.0",
         "eslint-plugin-prettier": "^5.5.4",
         "execa": "^9.6.0",
-        "gitleaks-secret-scanner": "^1.2.2",
+        "gitleaks-secret-scanner": "^2.1.1",
         "inquirer": "^13.0.1",
         "prettier": ">=3.0.0",
         "ts-node": "^10.9.1",
@@ -77,5 +82,8 @@
     "peerDependencies": {
         "eslint": ">=8.0.0",
         "prettier": ">=3.0.0"
+    },
+    "overrides": {
+        "tar": "^7.5.7"
     }
 }

package/src/config/.eslintignore

@@ -0,0 +1,72 @@
+# Dependencies
+node_modules/
+
+# Build outputs
+dist/
+build/
+out/
+.next/
+.nuxt/
+
+# Test reports & artifacts
+allure-report/
+allure-results/
+reports/
+report/
+test-reports/
+test-report/
+test-output/
+test-results/
+results/
+result/
+coverage/
+.coverage/
+htmlcov/
+
+# Jest
+jest-html-reporters-*/
+jest-stare/
+jest.config.js
+
+# Cypress
+cypress/reports/
+cypress/videos/
+cypress/screenshots/
+
+# Playwright
+playwright-report/
+test-results/
+
+# WebdriverIO
+.wdio/
+wdio-logs/
+
+# Mocha/Mochawesome
+mochawesome-report/
+mochawesome-reports/
+
+# Maven/JUnit
+target/
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+
+# Python
+__pycache__/
+.pytest_cache/
+.venv/
+venv/
+
+# Git
+.git/
+
+# Config files
+*.config.js
+*.config.ts
+jest.config.*
+wdio.config.*
+playwright.config.*
+cypress.config.*

package/src/config/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "printWidth": 100
+}

package/src/config/cspell.json

@@ -0,0 +1,75 @@
+{
+  "version": "0.2",
+  "language": "en,ru,uk,he,fr",
+  "import": [
+    "./node_modules/@cspell/dict-ru_ru/cspell-ext.json",
+    "./node_modules/@cspell/dict-uk-ua/cspell-ext.json",
+    "./node_modules/@cspell/dict-he/cspell-ext.json",
+    "./node_modules/@cspell/dict-fr-fr/cspell-ext.json"
+  ],
+  "words": [
+    "Artur",
+    "Polishchuk",
+    "uiautomator",
+    "UiAutomator2",
+    "checkmate",
+    "eslint",
+    "prettier",
+    "cspell",
+    "typescript",
+    "execa",
+    "playwright",
+    "pytest",
+    "creds",
+    "UITM",
+    "venv",
+    "pycache",
+    "wdio",
+    "htmlcov",
+    "mochawesome",
+    "dont",
+    "appinstalled",
+    "beforeinstallprompt",
+    "nav",
+    "navs",
+    "pr",
+    "recaptcha",
+    "tsconfig",
+    "vite",
+    "vitejs",
+    "Mavox",
+    "sultansadikov",
+    "Appi",
+    "Validatable",
+    "Osek",
+    "Patur",
+    "Mursheh",
+    "Hevra",
+    "Baam",
+    "Amuta",
+    "Sachir",
+    "gitleaks",
+    "mybono"
+  ],
+  "ignorePaths": [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/.git/**",
+    "**/build/**",
+    "**/coverage/**",
+    "**/.next/**",
+    "**/.nuxt/**",
+    "**/out/**",
+    "**/__pycache__/**",
+    "**/.pytest_cache/**",
+    "**/.venv/**",
+    "**/venv/**",
+    "**/package-lock.json",
+    "**/yarn.lock",
+    "**/pnpm-lock.yaml",
+    "**/*.min.js",
+    "**/*.min.css"
+  ],
+  "enableFiletypes": ["typescript", "javascript", "markdown", "json"],
+  "ignoreRegExpList": ["/https?:\\/\\/[^\\s]+/g", "/\\b[0-9a-f]{7,40}\\b/gi"]
+}

package/src/config/eslint.config.mjs

@@ -0,0 +1,140 @@
+import fs from 'fs';
+import path from 'path';
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import prettierPlugin from 'eslint-plugin-prettier';
+
+/**
+ * Default ESLint rules - can be exported for use in init.ts
+ */
+export const defaultRules = {
+  'no-console': 'warn',
+  'no-debugger': 'error',
+  'prefer-const': 'error',
+  'eqeqeq': ['error', 'always'],
+  '@typescript-eslint/no-unused-vars': [
+    'error',
+    { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+  ],
+  '@typescript-eslint/explicit-function-return-type': ['warn'],
+  '@typescript-eslint/no-explicit-any': ['warn'],
+  '@typescript-eslint/no-floating-promises': ['error'],
+  'space-before-function-paren': 'off',
+  'operator-linebreak': 'off',
+  'max-len': ['warn', { code: 100 }],
+  'semi': ['error', 'always'],
+  'quotes': ['error', 'single', { avoidEscape: true }],
+  'object-curly-spacing': ['error', 'always'],
+  'space-infix-ops': 'error',
+  'keyword-spacing': ['error', { before: true, after: true }],
+  'padding-line-between-statements': [
+    'error',
+    { blankLine: 'always', prev: 'block', next: '*' },
+    { blankLine: 'always', prev: '*', next: 'return' },
+  ],
+  'prettier/prettier': [
+    'error',
+    {
+      semi: true,
+      singleQuote: true,
+      bracketSpacing: true,
+      arrowParens: 'avoid',
+      printWidth: 100,
+    },
+  ],
+};
+
+/**
+ * Default ignore patterns
+ */
+const defaultIgnores = [
+  '**/node_modules/**',
+  '**/dist/**',
+  '**/.git/**',
+  '**/build/**',
+  '**/coverage/**',
+];
+
+/**
+ * Load user's pr-checkmate.json from project root
+ * Works both when developing the package and when installed in node_modules
+ */
+function loadUserConfig() {
+  let currentDir = process.cwd();
+  let configPath = path.join(currentDir, 'pr-checkmate.json');
+  
+  // If running from node_modules, find project root
+  if (currentDir.includes('node_modules')) {
+    const parts = currentDir.split(path.sep);
+    const nodeModulesIndex = parts.lastIndexOf('node_modules');
+    if (nodeModulesIndex > 0) {
+      currentDir = parts.slice(0, nodeModulesIndex).join(path.sep);
+      configPath = path.join(currentDir, 'pr-checkmate.json');
+    }
+  }
+  
+  if (fs.existsSync(configPath)) {
+    try {
+      const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+      console.log(`[loadUserConfig]: ✅ Loaded user config from: ${configPath}`);
+      return config;
+    } catch (err) {
+      console.warn(`[loadUserConfig]: ⚠️ Failed to parse ${configPath}:`, err.message);
+    }
+  } else {
+    console.log(`[loadUserConfig]: ℹ️ No pr-checkmate.json found, using defaults`);
+  }
+  
+  return { sourcePath: 'src', eslint: {} };
+}
+
+const userConfig = loadUserConfig();
+const SRC = userConfig.sourcePath || 'src';
+
+// Merge default rules with user-defined rules
+const mergedRules = {
+  ...defaultRules,
+  ...(userConfig.eslint?.rules || {}),
+};
+
+// Merge default ignores with user-defined ignores
+const mergedIgnores = [
+  ...defaultIgnores,
+  ...(userConfig.eslint?.ignorePatterns || []),
+];
+
+// Log customization info
+const customRulesCount = Object.keys(userConfig.eslint?.rules || {}).length;
+const customIgnoresCount = (userConfig.eslint?.ignorePatterns || []).length;
+
+if (customRulesCount > 0) {
+  console.log(`🔧 Applied ${customRulesCount} custom ESLint rules`);
+}
+if (customIgnoresCount > 0) {
+  console.log(`🚫 Applied ${customIgnoresCount} custom ignore patterns`);
+}
+
+console.log(`📋 ESLint checking: ${SRC}/**/*.{ts,tsx,js,jsx}`);
+
+export default [
+  {
+    files: [`${SRC}/**/*.{ts,tsx,js,jsx}`],
+    ignores: mergedIgnores,
+
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: 'module',
+        project: './tsconfig.json',
+      },
+    },
+
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+      prettier: prettierPlugin,
+    },
+
+    rules: mergedRules,
+  },
+];

package/src/config/pr-checkmate-workflow.yml

@@ -0,0 +1,147 @@
+name: PR Checkmate Quality Checks
+
+on:
+  pull_request:
+    branches: [main, master, develop]
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  pr-checkmate-all:
+    name: PR Checkmate All Checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run PR Checkmate All Checks
+        run: npx pr-checkmate all
+        continue-on-error: true
+
+      - name: Auto-commit formatting changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add -A
+          if ! git diff --cached --quiet; then
+            git commit -m "style: auto-format code with Prettier"
+            git push origin HEAD:${{ github.head_ref }}
+            echo "Formatting changes committed and pushed"
+          else
+            echo "No formatting changes needed"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  lint:
+    name: ESLint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npx pr-checkmate lint
+        continue-on-error: true
+
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Prettier
+        run: npx pr-checkmate prettier
+        continue-on-error: true
+
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Spellcheck
+        run: npx pr-checkmate spellcheck
+        continue-on-error: true
+
+  security:
+    name: Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Security Scan
+        run: npx pr-checkmate security
+        continue-on-error: true
+
+  dependency-check:
+    name: Dependency Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Dependency Check
+        run: npx pr-checkmate dependencies
+        continue-on-error: true