@codacy/analysis-runner 0.1.1 → 0.2.1

package/dist/index.d.ts

@@ -34,6 +34,18 @@ interface AnalyzeOptions {
     /** Target execution environment. "local" = developer machine, "container" = Codacy Docker runner.
      *  Phase 9 implements the actual container path; this field is accepted but currently ignored. */
     runner?: "local" | "container";
+    /**
+     * Git-aware file scope. Mutually exclusive options:
+     * - `"staged"` — analyze only files in the git staging area
+     * - `{ diff: string | true }` — analyze files changed vs a base ref (true = auto-detect)
+     * - `"pr"` — analyze files in the current pull request
+     *
+     * Resolved files are intersected with `files` if both are provided.
+     * If the resolved set is empty, analysis returns immediately with zero issues.
+     */
+    gitScope?: "staged" | {
+        diff: string | true;
+    } | "pr";
     /** Logger for pipeline progress messages (install status, etc.). Defaults to no-op. */
     logger?: Logger;
     /** Called when a tool starts executing. */
@@ -278,6 +290,32 @@ declare function resolveEngineToAdapter(engineName: string, adapters: Readonly<T
  */
 declare function applyCodacyYamlExcludes(config: CodacyConfig, yamlConfig: CodacyYamlConfig, adapters: Readonly<ToolAdapter>[], logger?: Logger): CodacyConfig;
 
+/**
+ * File discovery and routing — finds files in a repository, applies exclusion
+ * layers (.gitignore, global exclude, per-tool exclude), and routes files to
+ * the appropriate tool adapters based on file patterns.
+ */
+
+/**
+ * Returns files changed in the git staging area (index), excluding deleted files.
+ * Used by `--staged` to analyze only what's about to be committed.
+ */
+declare function listStagedFiles(repositoryRoot: string): string[];
+/**
+ * Returns files changed between a base ref and HEAD, excluding deleted files.
+ * Uses the three-dot diff (`base...HEAD`) to show only changes since divergence.
+ *
+ * If `base` is omitted, auto-detects the default branch via `detectDefaultBranch()`.
+ */
+declare function listDiffFiles(repositoryRoot: string, base?: string): string[];
+/**
+ * Returns files changed in the current pull request.
+ *
+ * Tries `gh pr view` first for accuracy (handles renames, squash merges).
+ * Falls back to git merge-base diff when gh is unavailable or not in a PR context.
+ */
+declare function listPrFiles(repositoryRoot: string): string[];
+
 /**
  * Codacy API client — thin wrappers around the generated OpenAPI client.
  *
@@ -361,4 +399,4 @@ declare function rotateLogFiles(logsDir: string, maxFiles: number): void;
  */
 declare function createLogger(options?: LoggerOptions): Logger;
 
-export { type AnalyzeOptions, type CodacyYamlConfig, type CodacyYamlEngineConfig, type ExecutionMode, type InitDefaultStats, type InitLocalStats, type InitRemoteStats, type LoggerOptions, analyze, applyCodacyYamlExcludes, buildToolConfig, clearAdapters, configureApiToken, createCodacyConfig, createLogger, detectLanguages, formatOutput, formatTextSummary, getRegisteredAdapters, initContainerConfig, initDefaultConfig, initLocalConfig, initRemoteConfig, readCodacyConfig, readCodacyYaml, registerAdapter, resolveEngineToAdapter, rotateLogFiles, validateApiToken, writeCodacyConfig };
+export { type AnalyzeOptions, type CodacyYamlConfig, type CodacyYamlEngineConfig, type ExecutionMode, type InitDefaultStats, type InitLocalStats, type InitRemoteStats, type LoggerOptions, analyze, applyCodacyYamlExcludes, buildToolConfig, clearAdapters, configureApiToken, createCodacyConfig, createLogger, detectLanguages, formatOutput, formatTextSummary, getRegisteredAdapters, initContainerConfig, initDefaultConfig, initLocalConfig, initRemoteConfig, listDiffFiles, listPrFiles, listStagedFiles, readCodacyConfig, readCodacyYaml, registerAdapter, resolveEngineToAdapter, rotateLogFiles, validateApiToken, writeCodacyConfig };

package/dist/index.js

@@ -45,6 +45,9 @@ __export(index_exports, {
   initDefaultConfig: () => initDefaultConfig,
   initLocalConfig: () => initLocalConfig,
   initRemoteConfig: () => initRemoteConfig,
+  listDiffFiles: () => listDiffFiles,
+  listPrFiles: () => listPrFiles,
+  listStagedFiles: () => listStagedFiles,
   readCodacyConfig: () => readCodacyConfig,
   readCodacyYaml: () => readCodacyYaml,
   registerAdapter: () => registerAdapter,
@@ -92,11 +95,25 @@ async function readCodacyConfig(repositoryRoot) {
   const configPath = import_path.default.join(repositoryRoot, CODACY_DIR, CONFIG_FILE);
   try {
     const raw = await import_promises.default.readFile(configPath, "utf-8");
-    return JSON.parse(raw);
+    const config = JSON.parse(raw);
+    coerceParameterValues(config);
+    return config;
   } catch {
     return null;
   }
 }
+function coerceParameterValues(config) {
+  for (const tool of config.tools) {
+    for (const pattern of tool.patterns) {
+      if (!pattern.parameters) continue;
+      for (const [key, value] of Object.entries(pattern.parameters)) {
+        if (typeof value !== "string") {
+          pattern.parameters[key] = String(value);
+        }
+      }
+    }
+  }
+}
 async function writeCodacyConfig(repositoryRoot, config) {
   const codacyDir = import_path.default.join(repositoryRoot, CODACY_DIR);
   await import_promises.default.mkdir(codacyDir, { recursive: true });
@@ -207,6 +224,91 @@ function routeFilesToTool(files, adapter, toolConfig) {
     );
   });
 }
+function listStagedFiles(repositoryRoot) {
+  try {
+    const output = (0, import_child_process.execSync)("git diff --cached --name-only --diff-filter=d", {
+      cwd: repositoryRoot,
+      encoding: "utf-8",
+      maxBuffer: 10 * 1024 * 1024
+    }).trim();
+    return output ? output.split("\n").filter(Boolean).sort() : [];
+  } catch {
+    throw new Error("Cannot list staged files: not inside a git repository");
+  }
+}
+function listDiffFiles(repositoryRoot, base) {
+  const baseBranch = base ?? detectDefaultBranch(repositoryRoot);
+  try {
+    const output = (0, import_child_process.execFileSync)(
+      "git",
+      ["diff", "--name-only", "--diff-filter=d", `${baseBranch}...HEAD`],
+      { cwd: repositoryRoot, encoding: "utf-8", maxBuffer: 10 * 1024 * 1024 }
+    ).trim();
+    return output ? output.split("\n").filter(Boolean).sort() : [];
+  } catch {
+    throw new Error(
+      `Cannot diff against "${baseBranch}": ref not found or not inside a git repository. Specify a base explicitly with --diff <base>.`
+    );
+  }
+}
+function listPrFiles(repositoryRoot) {
+  try {
+    const output = (0, import_child_process.execSync)("gh pr view --json files --jq '.files[].path'", {
+      cwd: repositoryRoot,
+      encoding: "utf-8",
+      maxBuffer: 10 * 1024 * 1024,
+      timeout: 15e3
+    }).trim();
+    if (output) {
+      return output.split("\n").filter(Boolean).sort();
+    }
+  } catch {
+  }
+  const baseBranch = detectDefaultBranch(repositoryRoot);
+  try {
+    const mergeBase = (0, import_child_process.execFileSync)("git", ["merge-base", "HEAD", baseBranch], {
+      cwd: repositoryRoot,
+      encoding: "utf-8"
+    }).trim();
+    const output = (0, import_child_process.execFileSync)(
+      "git",
+      ["diff", "--name-only", "--diff-filter=d", `${mergeBase}...HEAD`],
+      { cwd: repositoryRoot, encoding: "utf-8", maxBuffer: 10 * 1024 * 1024 }
+    ).trim();
+    return output ? output.split("\n").filter(Boolean).sort() : [];
+  } catch {
+    throw new Error(
+      `Cannot determine PR files: gh CLI unavailable and git merge-base with "${baseBranch}" failed. Use --diff <base> instead.`
+    );
+  }
+}
+function detectDefaultBranch(repositoryRoot) {
+  try {
+    const ref = (0, import_child_process.execSync)("git rev-parse --abbrev-ref origin/HEAD", {
+      cwd: repositoryRoot,
+      encoding: "utf-8",
+      stdio: ["pipe", "pipe", "pipe"]
+    }).trim();
+    if (ref && ref !== "origin/HEAD") {
+      return ref;
+    }
+  } catch {
+  }
+  for (const branch of ["origin/main", "origin/master"]) {
+    try {
+      (0, import_child_process.execFileSync)("git", ["rev-parse", "--verify", branch], {
+        cwd: repositoryRoot,
+        encoding: "utf-8",
+        stdio: ["pipe", "pipe", "pipe"]
+      });
+      return branch;
+    } catch {
+    }
+  }
+  throw new Error(
+    "Cannot auto-detect default branch: no origin/HEAD, origin/main, or origin/master found. Specify a base explicitly with --diff <base>."
+  );
+}
 function filterByTargetFiles(allFiles, targetPatterns) {
   if (targetPatterns.length === 0) return allFiles;
   const normalized = targetPatterns.map((p) => p.replace(/^\.\//, ""));
@@ -551,6 +653,20 @@ async function analyze(options) {
   const globalExclude = codacyConfig?.exclude || [];
   let allFiles = listRepoFiles(options.repositoryRoot);
   logger.debug("File discovery", { totalFiles: allFiles.length });
+  if (options.gitScope) {
+    const scopeFiles = resolveGitScope(options.repositoryRoot, options.gitScope);
+    logger.debug("Git scope resolved", {
+      scope: typeof options.gitScope === "string" ? options.gitScope : "diff",
+      fileCount: scopeFiles.length
+    });
+    if (scopeFiles.length === 0) {
+      logger.info("Git scope resolved to zero files, skipping analysis");
+      return buildResult(startedAt, options.repositoryRoot, mode, capability, [], [], []);
+    }
+    const scopeSet = new Set(scopeFiles);
+    allFiles = allFiles.filter((f) => scopeSet.has(f));
+    logger.debug("After git scope intersection", { fileCount: allFiles.length });
+  }
   if (options.files && options.files.length > 0) {
     allFiles = filterByTargetFiles(allFiles, options.files);
     logger.debug("Filtered by target files", { afterFilter: allFiles.length });
@@ -641,6 +757,12 @@ function normalizeIssues(issues) {
     return issue;
   });
 }
+function resolveGitScope(repositoryRoot, scope) {
+  if (scope === "staged") return listStagedFiles(repositoryRoot);
+  if (scope === "pr") return listPrFiles(repositoryRoot);
+  const base = scope.diff === true ? void 0 : scope.diff;
+  return listDiffFiles(repositoryRoot, base);
+}
 function buildResult(startedAt, repositoryRoot, mode, capability, issues, errors, toolResults) {
   const completedAt = /* @__PURE__ */ new Date();
   return {
@@ -4853,9 +4975,19 @@ async function initContainerConfig(repositoryRoot, adapters2) {
         for (const p of entry["patterns"]) {
           if (typeof p === "object" && p !== null && typeof p["patternId"] === "string") {
             const pe = p;
+            const rawParams = pe["parameters"];
+            let params;
+            if (rawParams && typeof rawParams === "object" && !Array.isArray(rawParams)) {
+              params = Object.fromEntries(
+                Object.entries(rawParams).map(([k, v]) => [
+                  k,
+                  String(v)
+                ])
+              );
+            }
             patterns.push({
               patternId: pe["patternId"],
-              ...pe["parameters"] && typeof pe["parameters"] === "object" ? { parameters: pe["parameters"] } : {}
+              ...params ? { parameters: params } : {}
             });
           }
         }
@@ -4988,6 +5120,9 @@ function createLogger(options = {}) {
   initDefaultConfig,
   initLocalConfig,
   initRemoteConfig,
+  listDiffFiles,
+  listPrFiles,
+  listStagedFiles,
   readCodacyConfig,
   readCodacyYaml,
   registerAdapter,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codacy/analysis-runner",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Core orchestration engine for Codacy analysis",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,11 +12,11 @@
     "cli-table3": "^0.6",
     "minimatch": "10.2.4",
     "yaml": "^2.6.0",
-    "@codacy/tooling": "0.1.1"
+    "@codacy/tooling": "0.2.1"
   },
   "devDependencies": {
     "@codacy/openapi-typescript-codegen": "0.0.9",
-    "@codacy/tools-dummy-1": "0.1.1"
+    "@codacy/tools-dummy-1": "0.2.1"
   },
   "license": "MIT",
   "author": "Codacy <support@codacy.com> (https://www.codacy.com)",