pr-checkmate 1.0.8 → 1.0.10

package/README.md

@@ -41,9 +41,6 @@ npx pr-checkmate <job>
 
 ## 📦 Example GitHub Actions Workflow
 
-![pipeline](./assets/pipelineex.png)
-
-
 ```yaml
 name: PR CheckMate Quality Checks
 

package/dist/.prettierrc

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

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./scripts/index");
+const scripts_1 = require("./scripts");
 const init_1 = require("./init");
 const utils_1 = require("./utils");
 const cmd = process.argv[2];
@@ -11,7 +11,7 @@ void (async () => {
             await (0, init_1.init)();
             process.exit(0);
         }
-        await (0, index_1.runJob)(cmd ?? 'all');
+        await (0, scripts_1.runJob)(cmd ?? 'all');
         process.exit(0);
     }
     catch (err) {

package/dist/config/constants.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCE_EXTENSIONS = exports.IGNORE_PATTERNS = void 0;
+/**
+ * Common patterns to ignore in all checks
+ */
+exports.IGNORE_PATTERNS = [
+    '**/node_modules/**',
+    '**/dist/**',
+    '**/.git/**',
+    '**/build/**',
+    '**/coverage/**',
+    '**/.next/**',
+    '**/.nuxt/**',
+    '**/out/**',
+    '**/__pycache__/**',
+    '**/.pytest_cache/**',
+    '**/.venv/**',
+    '**/venv/**',
+];
+/**
+ * File extensions to check
+ */
+exports.SOURCE_EXTENSIONS = {
+    typescript: ['.ts', '.tsx'],
+    javascript: ['.js', '.jsx'],
+    markdown: ['.md', '.mdx'],
+    json: ['.json'],
+    all: ['.ts', '.tsx', '.js', '.jsx', '.json', '.md', '.mdx'],
+};

package/dist/config/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCE_PATH = exports.config = exports.CONFIG_FILE = void 0;
+exports.getPackageConfigPath = getPackageConfigPath;
+exports.hasLocalConfig = hasLocalConfig;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+__exportStar(require("./config"), exports);
+__exportStar(require("./constants"), exports);
+exports.CONFIG_FILE = node_path_1.default.resolve(process.cwd(), 'pr-checkmate.json');
+exports.config = node_fs_1.default.existsSync(exports.CONFIG_FILE)
+    ? JSON.parse(node_fs_1.default.readFileSync(exports.CONFIG_FILE, 'utf-8'))
+    : { sourcePath: 'src' };
+exports.SOURCE_PATH = exports.config.sourcePath;
+/**
+ * Get path to package config files
+ */
+function getPackageConfigPath(fileName) {
+    const packageRoot = node_path_1.default.resolve(__dirname, '../..');
+    return node_path_1.default.join(packageRoot, fileName);
+}
+/**
+ * Check if project has local config
+ */
+function hasLocalConfig(configNames) {
+    const projectRoot = process.cwd();
+    return configNames.some(name => node_fs_1.default.existsSync(node_path_1.default.join(projectRoot, name)));
+}

package/dist/cspell.json

@@ -0,0 +1,35 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "checkmate",
+    "eslint",
+    "prettier",
+    "cspell",
+    "typescript",
+    "execa",
+    "playwright",
+    "pytest"
+  ],
+  "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/dist/eslint.config.mjs

@@ -0,0 +1,73 @@
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import prettierPlugin from 'eslint-plugin-prettier';
+
+export default [
+  {
+    files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
+    ignores: [
+      '**/node_modules/**',
+      '**/dist/**',
+      '**/.git/**',
+      '**/build/**',
+      '**/coverage/**',
+      '**/.next/**',
+      '**/.nuxt/**',
+      '**/out/**',
+    ],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: 'module',
+        project: './tsconfig.json',
+      },
+    },
+
+    plugins: {
+      '@typescript-eslint': tsPlugin,
+      prettier: prettierPlugin,
+    },
+
+    rules: {
+      '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 }],
+
+      // Formatting / Style Rules
+      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 integration
+      'prettier/prettier': [
+        'error',
+        {
+          semi: true,
+          singleQuote: true,
+          bracketSpacing: true,
+          arrowParens: 'avoid',
+          printWidth: 100,
+        },
+      ],
+    },
+  },
+];

package/dist/scripts/copy-configs.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyConfigs = copyConfigs;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const utils_1 = require("../utils");
+const configFiles = [
+    {
+        source: 'src/config/eslint.config.mjs',
+        dest: 'eslint.config.mjs',
+    },
+    {
+        source: 'src/config/.prettierrc',
+        dest: '.prettierrc',
+    },
+    {
+        source: 'src/config/cspell.json',
+        dest: 'cspell.json',
+    },
+];
+/**
+ * Copy configuration files from src/config to dist/
+ */
+function copyConfigs() {
+    const projectRoot = node_path_1.default.resolve(__dirname, '../..');
+    const distDir = node_path_1.default.join(projectRoot, 'dist');
+    if (!node_fs_1.default.existsSync(distDir)) {
+        node_fs_1.default.mkdirSync(distDir, { recursive: true });
+    }
+    utils_1.logger.log('📦 Copying configuration files...\n');
+    configFiles.forEach(({ source, dest }) => {
+        const srcPath = node_path_1.default.join(projectRoot, source);
+        const destPath = node_path_1.default.join(distDir, dest);
+        if (node_fs_1.default.existsSync(srcPath)) {
+            node_fs_1.default.copyFileSync(srcPath, destPath);
+            utils_1.logger.log(`✅ Copied ${dest}`);
+        }
+        else {
+            utils_1.logger.warn(`⚠️  File not found: ${source}`);
+        }
+    });
+    utils_1.logger.info('\n✨ Config files copied successfully!\n');
+}
+// Run if called directly
+if (require.main === module) {
+    copyConfigs();
+}

package/dist/scripts/dependency-check.js

@@ -15,16 +15,24 @@ const node_fs_1 = __importDefault(require("node:fs"));
  * @throws Will throw an error if deeper checks are added and fail.
  */
 async function runDependencyCheck() {
-    utils_1.logger.info('Checking dependencies...');
-    const packageJsonPath = node_path_1.default.resolve(process.cwd(), 'package.json');
+    utils_1.logger.info('📦 Checking dependencies...');
+    const projectRoot = process.cwd();
+    const packageJsonPath = node_path_1.default.join(projectRoot, 'package.json');
     if (!node_fs_1.default.existsSync(packageJsonPath)) {
-        utils_1.logger.warn('No package.json — skipping dependency check');
+        utils_1.logger.warn('⚠️ No package.json — skipping dependency check');
         return;
     }
-    const sourceFolder = node_path_1.default.resolve(process.cwd(), config_1.SOURCE_PATH);
+    const sourceFolder = node_path_1.default.join(projectRoot, config_1.SOURCE_PATH);
     if (!node_fs_1.default.existsSync(sourceFolder)) {
-        utils_1.logger.warn(`Source folder "${config_1.SOURCE_PATH}" not found — skipping deeper checks`);
+        utils_1.logger.warn(`⚠️ Source folder "${config_1.SOURCE_PATH}" not found — skipping deeper checks`);
         return;
     }
+    const ignoredInSource = config_1.IGNORE_PATTERNS.some(pattern => {
+        const cleanPattern = pattern.replace(/\*\*/g, '').replace(/\//g, '');
+        return sourceFolder.includes(cleanPattern);
+    });
+    if (ignoredInSource) {
+        utils_1.logger.warn('⚠️ Source path contains ignored directories');
+    }
     utils_1.logger.info('✅ Dependencies OK');
 }

package/dist/scripts/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runJob = runJob;
 const dependency_check_1 = require("./dependency-check");
@@ -6,6 +20,10 @@ const prettier_autoformat_1 = require("./prettier-autoformat");
 const spellcheck_1 = require("./spellcheck");
 const utils_1 = require("../utils");
 const lint_1 = require("./lint");
+__exportStar(require("./dependency-check"), exports);
+__exportStar(require("./lint"), exports);
+__exportStar(require("./prettier-autoformat"), exports);
+__exportStar(require("./spellcheck"), exports);
 async function runJob(jobName) {
     utils_1.logger.info(`🚀 Running job: ${jobName}`);
     try {

package/dist/scripts/lint.js

@@ -1,40 +1,55 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runLint = runLint;
-const execa_1 = require("execa");
-const node_fs_1 = __importDefault(require("node:fs"));
 const config_1 = require("../config");
 const utils_1 = require("../utils");
+const execa_1 = require("execa");
 /**
  * Run ESLint on the project.
- * Ignores node_modules, dist, and .git automatically.
- *
- * @throws Will throw an error if ESLint detects issues that cannot be fixed automatically.
+ * Uses local ESLint configuration if available; otherwise uses packaged config.
  */
 async function runLint() {
-    utils_1.logger.info('Running ESLint...');
-    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 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]),
-    ];
+    utils_1.logger.info('🔍 Running ESLint...');
+    const projectRoot = process.cwd();
+    const hasLocal = (0, config_1.hasLocalConfig)([
+        'eslint.config.mjs',
+        'eslint.config.js',
+        '.eslintrc.js',
+        '.eslintrc.json',
+        '.eslintrc',
+    ]);
+    let args;
+    if (hasLocal) {
+        utils_1.logger.info('📋 Using local ESLint config');
+        args = [
+            'eslint',
+            projectRoot,
+            '--ext',
+            '.ts,.tsx,.js,.jsx',
+            '--fix',
+            ...config_1.IGNORE_PATTERNS.flatMap(pattern => ['--ignore-pattern', pattern]),
+        ];
+    }
+    else {
+        utils_1.logger.info('📦 Using pr-checkmate ESLint config');
+        const configPath = (0, config_1.getPackageConfigPath)('eslint.config.mjs');
+        args = [
+            'eslint',
+            projectRoot,
+            '--ext',
+            '.ts,.tsx,.js,.jsx',
+            '--fix',
+            '--config',
+            configPath,
+            ...config_1.IGNORE_PATTERNS.flatMap(pattern => ['--ignore-pattern', pattern]),
+        ];
+    }
     try {
         await (0, execa_1.execa)('npx', args, { stdio: 'inherit' });
         utils_1.logger.info('✅ ESLint passed');
     }
     catch (err) {
-        utils_1.logger.warn('⚠️ ESLint issues found');
+        utils_1.logger.warn('⚠️ ESLint found issues');
         throw err;
     }
 }

package/dist/scripts/prettier-autoformat.js

@@ -4,33 +4,91 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runPrettier = runPrettier;
-const execa_1 = require("execa");
-const node_fs_1 = __importDefault(require("node:fs"));
 const config_1 = require("../config");
 const utils_1 = require("../utils");
+const execa_1 = require("execa");
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
 /**
- * Run Prettier to auto-format project files.
- * Ignores node_modules, dist, and .git folders automatically.
- *
- * @throws Will throw an error if Prettier fails.
+ * Create temporary .prettierignore file with ignore patterns
  */
+function createTempIgnoreFile() {
+    const tempIgnoreFile = node_path_1.default.join(process.cwd(), '.prettierignore.temp');
+    const ignoreContent = config_1.IGNORE_PATTERNS.join('\n');
+    node_fs_1.default.writeFileSync(tempIgnoreFile, ignoreContent, 'utf-8');
+    return tempIgnoreFile;
+}
+/**
+ * Remove temporary ignore file
+ */
+function cleanupTempIgnoreFile(filePath) {
+    try {
+        if (node_fs_1.default.existsSync(filePath)) {
+            node_fs_1.default.unlinkSync(filePath);
+        }
+    }
+    catch (err) {
+        utils_1.logger.warn(`⚠️ Failed to cleanup temp file: ${filePath}`);
+    }
+}
 async function runPrettier() {
-    utils_1.logger.info('Running Prettier...');
-    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
-        ? '**/*.{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/**'];
+    utils_1.logger.info('🎨 Running Prettier...');
+    const projectRoot = process.cwd();
+    const projectIgnore = node_path_1.default.join(projectRoot, '.prettierignore');
+    const gitignore = node_path_1.default.join(projectRoot, '.gitignore');
+    const hasLocal = (0, config_1.hasLocalConfig)([
+        '.prettierrc',
+        '.prettierrc.json',
+        '.prettierrc.js',
+        'prettier.config.js',
+    ]);
+    let tempIgnoreFile = null;
+    let ignorePath;
+    if (node_fs_1.default.existsSync(projectIgnore)) {
+        ignorePath = projectIgnore;
+    }
+    else if (node_fs_1.default.existsSync(gitignore)) {
+        ignorePath = gitignore;
+    }
+    else {
+        tempIgnoreFile = createTempIgnoreFile();
+        ignorePath = tempIgnoreFile;
+    }
+    let args;
+    if (hasLocal) {
+        utils_1.logger.info('📋 Using local Prettier config');
+        args = [
+            'prettier',
+            '--write',
+            `${projectRoot}/**/*.{ts,tsx,js,jsx,json,md}`,
+            '--ignore-path',
+            ignorePath,
+        ];
+    }
+    else {
+        utils_1.logger.info('📦 Using pr-checkmate Prettier config');
+        const configPath = (0, config_1.getPackageConfigPath)('.prettierrc');
+        args = [
+            'prettier',
+            '--write',
+            `${projectRoot}/**/*.{ts,tsx,js,jsx,json,md}`,
+            '--config',
+            configPath,
+            '--ignore-path',
+            ignorePath,
+        ];
+    }
     try {
-        await (0, execa_1.execa)('npx', ['prettier', '--write', pattern, ...ignorePatterns.flatMap(p => ['--ignore-path', p])], { stdio: 'inherit' });
+        await (0, execa_1.execa)('npx', args, { stdio: 'inherit' });
         utils_1.logger.info('✅ Prettier completed');
     }
     catch (err) {
         utils_1.logger.error('❌ Prettier failed');
         throw err;
     }
+    finally {
+        if (tempIgnoreFile) {
+            cleanupTempIgnoreFile(tempIgnoreFile);
+        }
+    }
 }

package/dist/scripts/spellcheck.js

@@ -1,23 +1,39 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runSpellcheck = runSpellcheck;
 const execa_1 = require("execa");
-const config_1 = require("../config");
+const node_path_1 = __importDefault(require("node:path"));
 const utils_1 = require("../utils");
+const config_1 = require("../config");
 /**
- * Run cspell to check spelling in project files.
- * Ignores node_modules, dist, and .git folders automatically.
- *
- * @throws Will throw an error if spelling issues are detected.
+ * Build glob patterns for spellcheck with ignore patterns
  */
+function buildSpellcheckPatterns(projectRoot, sourcePath) {
+    const basePattern = node_path_1.default.join(projectRoot, sourcePath, '**/*.{ts,tsx,js,jsx,md,mdx,json}');
+    // create ignore glob flags: --exclude "**/node_modules/**"
+    const excludeArgs = config_1.IGNORE_PATTERNS.map(p => `--exclude=${p}`);
+    return [basePattern, ...excludeArgs];
+}
 async function runSpellcheck() {
-    utils_1.logger.info('Running spellcheck...');
-    const pattern = `${config_1.SOURCE_PATH}/**/*`;
-    const ignorePatterns = ['**/node_modules/**', '**/dist/**', '**/.git/**'];
+    utils_1.logger.info('🔤 Running spellcheck...');
+    const projectRoot = process.cwd();
+    const patterns = buildSpellcheckPatterns(projectRoot, config_1.SOURCE_PATH);
+    const hasLocal = (0, config_1.hasLocalConfig)(['cspell.json', '.cspell.json', 'cspell.config.json']);
+    let args;
+    if (hasLocal) {
+        utils_1.logger.info('📋 Using local cspell config');
+        args = ['cspell', ...patterns, '--no-progress'];
+    }
+    else {
+        utils_1.logger.info('📦 Using pr-checkmate cspell config');
+        const configPath = (0, config_1.getPackageConfigPath)('cspell.json');
+        args = ['cspell', ...patterns, '--config', configPath, '--no-progress'];
+    }
     try {
-        await (0, execa_1.execa)('npx', ['cspell', pattern, ...ignorePatterns.flatMap(p => ['--ignore', p])], {
-            stdio: 'inherit',
-        });
+        await (0, execa_1.execa)('npx', args, { stdio: 'inherit' });
         utils_1.logger.info('✅ Spellcheck passed');
     }
     catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.0.8",
+    "version": "1.0.10",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",
@@ -19,11 +19,13 @@
     "files": [
         "dist",
         "README.md",
+        "scripts/copy-configs.js",
         "LICENSE"
     ],
     "scripts": {
         "check": "npm run build && npm run lint && npm run prettier && npm run spellcheck",
-        "build": "npm run clean && tsc && chmod +x dist/cli.js",
+        "build": "npm run clean && tsc && npm run copy-configs && chmod +x dist/cli.js",
+        "copy-configs": "node dist/scripts/copy-configs.js",
         "prepublishOnly": "npm run build",
         "lint": "eslint \"src/**/*.{ts,tsx}\" --fix",
         "prettier": "prettier --write \"src/**/*.{ts,tsx,js,jsx,json,md}\"",