threadlines 0.2.6 → 0.2.9

package/dist/utils/context.js

@@ -1,190 +1,10 @@
 "use strict";
 /**
- * Review Context Detection
+ * Review Context Types
  *
- * Determines what type of code review context we're in:
- * - PR/MR: Multiple commits comparing two branches
- * - Branch: All commits on a branch vs base branch
- * - Commit: Single commit changes
+ * Type definitions for the different code review contexts:
+ * - PR/MR: Comparing source branch vs target branch (branch-level diff)
+ * - Commit: Single commit changes (any push without PR/MR)
  * - Local: Staged/unstaged changes in working directory
- *
- * Context detection is environment-specific - each CI platform
- * provides different environment variables.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectContext = detectContext;
-/**
- * Detects the review context based on the environment.
- *
- * Each environment has different environment variables available,
- * so detection logic is environment-specific.
- */
-function detectContext(environment) {
-    switch (environment) {
-        case 'github':
-            return detectGitHubContext();
-        case 'gitlab':
-            return detectGitLabContext();
-        case 'bitbucket':
-            return detectBitbucketContext();
-        case 'vercel':
-            return detectVercelContext();
-        case 'local':
-            return { type: 'local' };
-        default:
-            return { type: 'local' };
-    }
-}
-/**
- * GitHub Actions context detection
- *
- * Environment Variables:
- * - PR: GITHUB_EVENT_NAME='pull_request', GITHUB_BASE_REF, GITHUB_HEAD_REF, GITHUB_EVENT_NUMBER
- * - Branch: GITHUB_REF_NAME
- * - Commit: GITHUB_SHA
- */
-function detectGitHubContext() {
-    // 1. Check for PR context
-    if (process.env.GITHUB_EVENT_NAME === 'pull_request') {
-        const targetBranch = process.env.GITHUB_BASE_REF;
-        const sourceBranch = process.env.GITHUB_HEAD_REF;
-        const prNumber = process.env.GITHUB_EVENT_PULL_REQUEST_NUMBER || process.env.GITHUB_EVENT_NUMBER;
-        if (targetBranch && sourceBranch && prNumber) {
-            return {
-                type: 'pr',
-                prNumber,
-                sourceBranch,
-                targetBranch
-            };
-        }
-    }
-    // 2. Check for branch context
-    if (process.env.GITHUB_REF_NAME) {
-        return {
-            type: 'branch',
-            branchName: process.env.GITHUB_REF_NAME
-        };
-    }
-    // 3. Check for commit context
-    if (process.env.GITHUB_SHA) {
-        return {
-            type: 'commit',
-            commitSha: process.env.GITHUB_SHA
-        };
-    }
-    // 4. Fallback to local
-    return { type: 'local' };
-}
-/**
- * GitLab CI context detection
- *
- * Environment Variables:
- * - MR: CI_MERGE_REQUEST_IID, CI_MERGE_REQUEST_TARGET_BRANCH_NAME, CI_MERGE_REQUEST_SOURCE_BRANCH_NAME, CI_MERGE_REQUEST_TITLE
- * - Branch: CI_COMMIT_REF_NAME
- * - Commit: CI_COMMIT_SHA
- */
-function detectGitLabContext() {
-    // 1. Check for MR context
-    if (process.env.CI_MERGE_REQUEST_IID) {
-        const targetBranch = process.env.CI_MERGE_REQUEST_TARGET_BRANCH_NAME;
-        const sourceBranch = process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME;
-        const mrNumber = process.env.CI_MERGE_REQUEST_IID;
-        const mrTitle = process.env.CI_MERGE_REQUEST_TITLE;
-        if (targetBranch && sourceBranch && mrNumber) {
-            return {
-                type: 'mr',
-                mrNumber,
-                sourceBranch,
-                targetBranch,
-                prTitle: mrTitle || undefined
-            };
-        }
-    }
-    // 2. Check for branch context
-    if (process.env.CI_COMMIT_REF_NAME) {
-        return {
-            type: 'branch',
-            branchName: process.env.CI_COMMIT_REF_NAME
-        };
-    }
-    // 3. Check for commit context
-    if (process.env.CI_COMMIT_SHA) {
-        return {
-            type: 'commit',
-            commitSha: process.env.CI_COMMIT_SHA
-        };
-    }
-    // 4. Fallback to local
-    return { type: 'local' };
-}
-/**
- * Vercel context detection
- *
- * Environment Variables:
- * - Branch: VERCEL_GIT_COMMIT_REF
- * - Commit: VERCEL_GIT_COMMIT_SHA
- *
- * Vercel Limitation:
- * Vercel performs shallow clones of the repository, typically fetching only the
- * specific commit being deployed. The git repository in Vercel's build environment
- * does not contain the full git history or remote branch references (e.g., origin/main).
- * This means branch-based diff operations (comparing feature branch against base branch)
- * are not possible because the base branch refs are not available in the repository.
- *
- * Solution:
- * We hardcode commit context for Vercel, using VERCEL_GIT_COMMIT_SHA to get a
- * commit-based diff (comparing the commit against its parent). This works within
- * Vercel's constraints since we only need the commit SHA, not branch references.
- */
-function detectVercelContext() {
-    // Hardcode commit context for Vercel due to shallow clone limitations
-    // Vercel's git repository doesn't have base branch refs available
-    if (process.env.VERCEL_GIT_COMMIT_SHA) {
-        return {
-            type: 'commit',
-            commitSha: process.env.VERCEL_GIT_COMMIT_SHA
-        };
-    }
-    // Fallback to local
-    return { type: 'local' };
-}
-/**
- * Bitbucket Pipelines context detection
- *
- * Environment Variables (all tested 2026-01-18):
- * - Branch: BITBUCKET_BRANCH
- * - Commit: BITBUCKET_COMMIT
- * - PR: BITBUCKET_PR_ID, BITBUCKET_PR_DESTINATION_BRANCH
- *
- * Note: Bitbucket does not provide PR title as an environment variable.
- */
-function detectBitbucketContext() {
-    // PR context
-    const prId = process.env.BITBUCKET_PR_ID;
-    const prDestinationBranch = process.env.BITBUCKET_PR_DESTINATION_BRANCH;
-    const sourceBranch = process.env.BITBUCKET_BRANCH;
-    if (prId && prDestinationBranch && sourceBranch) {
-        return {
-            type: 'pr',
-            prNumber: prId,
-            sourceBranch,
-            targetBranch: prDestinationBranch
-        };
-    }
-    // Branch context
-    if (process.env.BITBUCKET_BRANCH) {
-        return {
-            type: 'branch',
-            branchName: process.env.BITBUCKET_BRANCH
-        };
-    }
-    // Commit context
-    if (process.env.BITBUCKET_COMMIT) {
-        return {
-            type: 'commit',
-            commitSha: process.env.BITBUCKET_COMMIT
-        };
-    }
-    // Fallback to local
-    return { type: 'local' };
-}

package/dist/utils/logger.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+exports.enableDebug = enableDebug;
+exports.isDebugEnabled = isDebugEnabled;
+const chalk_1 = __importDefault(require("chalk"));
+/**
+ * Global debug flag - set when --debug is passed to CLI
+ */
+let debugEnabled = false;
+/**
+ * Enable debug logging (called when --debug flag is set)
+ */
+function enableDebug() {
+    debugEnabled = true;
+}
+/**
+ * Check if debug logging is enabled
+ */
+function isDebugEnabled() {
+    return debugEnabled;
+}
+/**
+ * Logger utility for CLI output
+ *
+ * - debug/info: Only shown when --debug flag is set
+ * - warn/error: Always shown (critical information)
+ */
+exports.logger = {
+    /**
+     * Debug-level log (technical details, internal state)
+     * Only shown with --debug flag
+     */
+    debug: (message) => {
+        if (debugEnabled) {
+            console.log(chalk_1.default.gray(`[DEBUG] ${message}`));
+        }
+    },
+    /**
+     * Info-level log (what's happening, progress updates)
+     * Only shown with --debug flag
+     */
+    info: (message) => {
+        if (debugEnabled) {
+            console.log(chalk_1.default.blue(`[INFO] ${message}`));
+        }
+    },
+    /**
+     * Warning (non-fatal issues, recommendations)
+     * Always shown
+     */
+    warn: (message) => {
+        console.log(chalk_1.default.yellow(`⚠️  ${message}`));
+    },
+    /**
+     * Error (failures, problems)
+     * Always shown
+     */
+    error: (message) => {
+        console.error(chalk_1.default.red(`❌ ${message}`));
+    }
+};

package/dist/validators/experts.js

@@ -38,6 +38,7 @@ exports.validateThreadline = validateThreadline;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const yaml = __importStar(require("js-yaml"));
+const logger_1 = require("../utils/logger");
 const REQUIRED_FIELDS = ['id', 'version', 'patterns'];
 /**
  * Find and validate all threadlines in the threadlines folder.
@@ -61,7 +62,7 @@ async function findThreadlines(searchRoot, gitRoot) {
             threadlines.push(result.threadline);
         }
         else {
-            console.warn(`⚠️  Skipping ${file}: ${result.errors?.join(', ')}`);
+            logger_1.logger.warn(`Skipping ${file}: ${result.errors?.join(', ')}`);
         }
     }
     return threadlines;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "threadlines",
-  "version": "0.2.6",
+  "version": "0.2.9",
   "description": "Threadlines CLI - AI-powered linter based on your natural language documentation",
   "main": "dist/index.js",
   "bin": {

package/dist/git/repo.js

@@ -1,253 +0,0 @@
-"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGitHubRepoName = getGitHubRepoName;
-exports.getVercelRepoName = getVercelRepoName;
-exports.getLocalRepoName = getLocalRepoName;
-exports.getGitHubBranchName = getGitHubBranchName;
-exports.getVercelBranchName = getVercelBranchName;
-exports.getLocalBranchName = getLocalBranchName;
-exports.getGitLabRepoName = getGitLabRepoName;
-exports.getGitLabBranchName = getGitLabBranchName;
-exports.getDefaultBranchName = getDefaultBranchName;
-const simple_git_1 = __importDefault(require("simple-git"));
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-/**
- * GitHub Actions: Get repository name
- *
- * Uses GITHUB_REPOSITORY environment variable (format: "owner/repo").
- * This is the ONLY method for GitHub - no fallbacks, no alternatives.
- */
-async function getGitHubRepoName(_repoRoot) {
-    const githubRepo = process.env.GITHUB_REPOSITORY;
-    if (!githubRepo) {
-        throw new Error('GitHub Actions: GITHUB_REPOSITORY environment variable is not set. ' +
-            'This should be automatically provided by GitHub Actions.');
-    }
-    const serverUrl = process.env.GITHUB_SERVER_URL || 'https://github.com';
-    return `${serverUrl}/${githubRepo}.git`;
-}
-/**
- * Vercel: Get repository name
- *
- * Uses VERCEL_GIT_REPO_OWNER and VERCEL_GIT_REPO_SLUG environment variables.
- * This is the ONLY method for Vercel - no fallbacks, no alternatives.
- */
-async function getVercelRepoName(_repoRoot) {
-    const owner = process.env.VERCEL_GIT_REPO_OWNER;
-    const slug = process.env.VERCEL_GIT_REPO_SLUG;
-    if (!owner || !slug) {
-        throw new Error('Vercel: VERCEL_GIT_REPO_OWNER or VERCEL_GIT_REPO_SLUG environment variable is not set. ' +
-            'This should be automatically provided by Vercel CI.');
-    }
-    return `https://github.com/${owner}/${slug}.git`;
-}
-/**
- * Local: Get repository name
- *
- * Uses git command to get origin remote URL.
- * This is the ONLY method for local - no fallbacks, no alternatives.
- * Git should always be available in local development.
- */
-async function getLocalRepoName(repoRoot) {
-    const git = (0, simple_git_1.default)(repoRoot);
-    // Check if we're in a git repo
-    const isRepo = await git.checkIsRepo();
-    if (!isRepo) {
-        throw new Error('Local: Not a git repository. Threadline requires a git repository.');
-    }
-    try {
-        const remotes = await git.getRemotes(true);
-        const origin = remotes.find(r => r.name === 'origin');
-        if (!origin || !origin.refs?.fetch) {
-            throw new Error('Local: No origin remote found. ' +
-                'Please configure an origin remote: git remote add origin <url>');
-        }
-        return origin.refs.fetch;
-    }
-    catch (error) {
-        // If it's already our error, re-throw it
-        if (error instanceof Error && error.message.includes('Local:')) {
-            throw error;
-        }
-        // Otherwise, wrap it
-        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-        throw new Error(`Local: Failed to get repository name from git: ${errorMessage}`);
-    }
-}
-/**
- * GitHub Actions: Get branch name
- *
- * Uses GITHUB_REF_NAME environment variable.
- * This is the ONLY method for GitHub - no fallbacks, no alternatives.
- */
-async function getGitHubBranchName(_repoRoot) {
-    const refName = process.env.GITHUB_REF_NAME;
-    if (!refName) {
-        throw new Error('GitHub Actions: GITHUB_REF_NAME environment variable is not set. ' +
-            'This should be automatically provided by GitHub Actions.');
-    }
-    return refName;
-}
-/**
- * Vercel: Get branch name
- *
- * Uses VERCEL_GIT_COMMIT_REF environment variable.
- * This is the ONLY method for Vercel - no fallbacks, no alternatives.
- */
-async function getVercelBranchName(_repoRoot) {
-    const branchName = process.env.VERCEL_GIT_COMMIT_REF;
-    if (!branchName) {
-        throw new Error('Vercel: VERCEL_GIT_COMMIT_REF environment variable is not set. ' +
-            'This should be automatically provided by Vercel CI.');
-    }
-    return branchName;
-}
-/**
- * Local: Get branch name
- *
- * Uses git command to get current branch name.
- * This is the ONLY method for local - no fallbacks, no alternatives.
- * Git should always be available in local development.
- */
-async function getLocalBranchName(repoRoot) {
-    const git = (0, simple_git_1.default)(repoRoot);
-    // Check if we're in a git repo
-    const isRepo = await git.checkIsRepo();
-    if (!isRepo) {
-        throw new Error('Local: Not a git repository. Threadline requires a git repository.');
-    }
-    try {
-        const branchName = await git.revparse(['--abbrev-ref', 'HEAD']);
-        if (!branchName || branchName.trim() === '') {
-            throw new Error('Local: Could not determine branch name. ' +
-                'This might be a brand new repository with no commits. ' +
-                'Make at least one commit before running threadlines check.');
-        }
-        // Handle detached HEAD state
-        if (branchName === 'HEAD') {
-            throw new Error('Local: Currently in detached HEAD state. ' +
-                'Please checkout a branch before running threadlines check.');
-        }
-        return branchName.trim();
-    }
-    catch (error) {
-        // If it's already our error, re-throw it
-        if (error instanceof Error && error.message.includes('Local:')) {
-            throw error;
-        }
-        // Otherwise, wrap it
-        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-        throw new Error(`Local: Failed to get branch name from git: ${errorMessage}`);
-    }
-}
-/**
- * GitLab CI: Get repository name
- *
- * Uses CI_PROJECT_URL environment variable.
- * This is the ONLY method for GitLab - no fallbacks, no alternatives.
- */
-async function getGitLabRepoName(_repoRoot) {
-    const projectUrl = process.env.CI_PROJECT_URL;
-    if (!projectUrl) {
-        throw new Error('GitLab CI: CI_PROJECT_URL environment variable is not set. ' +
-            'This should be automatically provided by GitLab CI.');
-    }
-    // CI_PROJECT_URL is like "https://gitlab.com/owner/repo"
-    // Add .git suffix for consistency with other environments
-    return `${projectUrl}.git`;
-}
-/**
- * GitLab CI: Get branch name
- *
- * Uses CI_COMMIT_REF_NAME environment variable.
- * This is the ONLY method for GitLab - no fallbacks, no alternatives.
- */
-async function getGitLabBranchName(_repoRoot) {
-    const refName = process.env.CI_COMMIT_REF_NAME;
-    if (!refName) {
-        throw new Error('GitLab CI: CI_COMMIT_REF_NAME environment variable is not set. ' +
-            'This should be automatically provided by GitLab CI.');
-    }
-    return refName;
-}
-/**
- * Detects the default branch name of the repository for GitHub Actions.
- *
- * Uses GITHUB_EVENT_PATH JSON (repository.default_branch) - the most authoritative source
- * provided directly by GitHub Actions.
- *
- * This function is ONLY called from GitHub Actions context (github.ts),
- * so GITHUB_EVENT_PATH should always be available. If it's not, we fail with a clear error.
- *
- * Returns the branch name (e.g., "main", "master") without the "origin/" prefix.
- * Throws an error if the default branch cannot be detected.
- */
-async function getDefaultBranchName(_repoRoot) {
-    // GitHub Actions provides GITHUB_EVENT_PATH which contains repository.default_branch
-    const githubEventPath = process.env.GITHUB_EVENT_PATH;
-    if (!githubEventPath) {
-        throw new Error('GITHUB_EVENT_PATH environment variable is not set. ' +
-            'This should be automatically provided by GitHub Actions. ' +
-            'This function should only be called in GitHub Actions context.');
-    }
-    try {
-        const eventPath = path.resolve(githubEventPath);
-        if (!fs.existsSync(eventPath)) {
-            throw new Error(`GITHUB_EVENT_PATH file does not exist: ${eventPath}`);
-        }
-        const eventJson = JSON.parse(fs.readFileSync(eventPath, 'utf8'));
-        const defaultBranch = eventJson.repository?.default_branch;
-        if (!defaultBranch || typeof defaultBranch !== 'string') {
-            throw new Error('Could not find repository.default_branch in GITHUB_EVENT_PATH JSON. ' +
-                'This should be automatically provided by GitHub Actions.');
-        }
-        return defaultBranch;
-    }
-    catch (error) {
-        // If it's already our error, re-throw it
-        if (error instanceof Error && (error.message.includes('GITHUB_EVENT_PATH') || error.message.includes('default_branch'))) {
-            throw error;
-        }
-        // Otherwise, wrap it
-        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-        throw new Error(`Failed to read or parse GITHUB_EVENT_PATH: ${errorMessage}. ` +
-            'This should be automatically provided by GitHub Actions.');
-    }
-}