@gaunt-sloth/review 0.0.1

package/README.md

@@ -0,0 +1,31 @@
+# @gaunt-sloth/review
+
+Review and question-answering functionality for Gaunt Sloth.
+
+## Contents
+
+- Review module (`reviewModule`) — diff and content review orchestration
+- Question answering module (`questionAnsweringModule`)
+- Command utilities (`commandUtils`)
+- Content and requirement sources: `file`, `text`, `ghPrDiff`, `ghIssue`, `jiraIssue`, `jiraIssueLegacy`
+- Jira client
+- Review rate middleware
+
+## CLI
+
+The package ships a standalone binary `gaunt-sloth-review` for CI-friendly reviews that does not depend on `commander`. This makes it suitable for embedding in pipelines where a minimal footprint is preferred.
+
+## Dependencies
+
+- `@gaunt-sloth/core` (required)
+- `@gaunt-sloth/tools` (optional peer dependency)
+
+No MCP, no A2A, no commander. This is intentional to keep the package lightweight for CI use.
+
+## Exports
+
+```js
+import { reviewModule } from '@gaunt-sloth/review/reviewModule.js';
+import { questionAnsweringModule } from '@gaunt-sloth/review/questionAnsweringModule.js';
+import { commandUtils } from '@gaunt-sloth/review/commandUtils.js';
+```

package/cli.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+
+/**
+ * Simple CLI for gaunt-sloth-review
+ * Usage: gaunt-sloth-review [pr-number-or-content] [requirements...]
+ *
+ * When called with a PR number, reviews the specified PR using the configured content provider.
+ * When called without arguments, reads diff from stdin via the configured content provider.
+ */
+
+import { setEntryPoint } from '@gaunt-sloth/core/utils/systemUtils.js';
+setEntryPoint(import.meta.url);
+
+import { initConfig } from '@gaunt-sloth/core/config.js';
+import { review } from '#src/modules/reviewModule.js';
+import { displayError } from '@gaunt-sloth/core/utils/consoleUtils.js';
+import { getContentFromSource, getRequirementsFromSource } from '#src/commands/commandUtils.js';
+import { buildSystemMessages } from '@gaunt-sloth/core/utils/llmUtils.js';
+
+const args = process.argv.slice(2);
+
+async function main() {
+  try {
+    const config = await initConfig({});
+
+    // First arg is content (e.g. PR number), rest are requirements
+    const contentArg = args[0];
+    const requirementArgs = args.slice(1);
+
+    // Get content (e.g. PR diff)
+    const contentSource = config.commands?.pr?.contentSource || config.contentSource || 'github';
+    const content = await getContentFromSource(contentSource, contentArg, config);
+
+    // Get requirements if provided
+    let requirements = '';
+    if (requirementArgs.length > 0) {
+      const reqSource =
+        config.commands?.pr?.requirementSource || config.requirementSource || 'github';
+      for (const reqArg of requirementArgs) {
+        const req = await getRequirementsFromSource(reqSource, reqArg, config);
+        if (req) requirements += req + '\n';
+      }
+    }
+
+    // Build preamble from system messages
+    const preamble = buildSystemMessages(config, 'pr');
+    const preambleText = preamble
+      .map((m) => (typeof m.content === 'string' ? m.content : ''))
+      .join('\n');
+
+    // Combine requirements and content for the review
+    const diffWithReqs = requirements
+      ? `Requirements:\n${requirements}\nDiff:\n${content}`
+      : content;
+
+    await review('pr-review', preambleText, diffWithReqs, config, 'pr');
+  } catch (error) {
+    displayError(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+}
+
+main();

package/dist/commands/commandUtils.d.ts

@@ -0,0 +1,33 @@
+import type { GthConfig } from '@gaunt-sloth/core/config.js';
+/**
+ * Requirements sources. Expected to be in `.sources/` dir.
+ * Aliases are mapped to actual sources in this file
+ */
+export declare const REQUIREMENTS_PROVIDERS: {
+    readonly 'jira-legacy': "jiraIssueLegacySource.js";
+    readonly jira: "jiraIssueSource.js";
+    readonly github: "ghIssueSource.js";
+    readonly text: "textSource.js";
+    readonly file: "fileSource.js";
+};
+export type RequirementsProviderType = keyof typeof REQUIREMENTS_PROVIDERS;
+/**
+ * Content sources. Expected to be in `.sources/` dir.
+ * Aliases are mapped to actual sources in this file
+ */
+export declare const CONTENT_PROVIDERS: {
+    readonly github: "ghPrDiffSource.js";
+    readonly text: "textSource.js";
+    readonly file: "fileSource.js";
+};
+export type ContentProviderType = keyof typeof CONTENT_PROVIDERS;
+export declare function getRequirementsFromSource(requirementsProvider: RequirementsProviderType | undefined, requirementsId: string | undefined, config: GthConfig): Promise<string>;
+export declare function getContentFromSource(contentProvider: ContentProviderType | undefined, contentId: string | undefined, config: GthConfig): Promise<string>;
+/**
+ * @deprecated Use getRequirementsFromSource instead
+ */
+export declare const getRequirementsFromProvider: typeof getRequirementsFromSource;
+/**
+ * @deprecated Use getContentFromSource instead
+ */
+export declare const getContentFromProvider: typeof getContentFromSource;

package/dist/commands/commandUtils.js

@@ -0,0 +1,59 @@
+import { displayError } from '@gaunt-sloth/core/utils/consoleUtils.js';
+import { wrapContent } from '@gaunt-sloth/core/utils/llmUtils.js';
+/**
+ * Requirements sources. Expected to be in `.sources/` dir.
+ * Aliases are mapped to actual sources in this file
+ */
+export const REQUIREMENTS_PROVIDERS = {
+    'jira-legacy': 'jiraIssueLegacySource.js',
+    jira: 'jiraIssueSource.js',
+    github: 'ghIssueSource.js',
+    text: 'textSource.js',
+    file: 'fileSource.js',
+};
+/**
+ * Content sources. Expected to be in `.sources/` dir.
+ * Aliases are mapped to actual sources in this file
+ */
+export const CONTENT_PROVIDERS = {
+    github: 'ghPrDiffSource.js',
+    text: 'textSource.js',
+    file: 'fileSource.js',
+};
+export async function getRequirementsFromSource(requirementsProvider, requirementsId, config) {
+    const requirements = await getFromProvider(requirementsProvider, requirementsId, (config?.requirementsProviderConfig ?? {})[requirementsProvider], REQUIREMENTS_PROVIDERS);
+    return wrapContent(requirements, requirementsProvider, 'requirements');
+}
+export async function getContentFromSource(contentProvider, contentId, config) {
+    const content = await getFromProvider(contentProvider, contentId, (config?.contentProviderConfig ?? {})[contentProvider], CONTENT_PROVIDERS);
+    return wrapContent(content, contentProvider, contentProvider === 'github' ? 'GitHub diff' : 'content');
+}
+/**
+ * @deprecated Use getRequirementsFromSource instead
+ */
+export const getRequirementsFromProvider = getRequirementsFromSource;
+/**
+ * @deprecated Use getContentFromSource instead
+ */
+export const getContentFromProvider = getContentFromSource;
+async function getFromProvider(provider, id, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+config, legitPredefinedProviders) {
+    if (typeof provider === 'string') {
+        // Use one of the predefined providers
+        if (legitPredefinedProviders[provider]) {
+            const providerPath = `#src/sources/${legitPredefinedProviders[provider]}`;
+            const { get } = await import(providerPath);
+            return await get(config, id);
+        }
+        else {
+            displayError(`Unknown provider: ${provider}. Continuing without it.`);
+        }
+    }
+    else if (typeof provider === 'function') {
+        // Type assertion to handle function call
+        return await provider(id);
+    }
+    return '';
+}
+//# sourceMappingURL=commandUtils.js.map

package/dist/commands/commandUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandUtils.js","sourceRoot":"","sources":["../../src/commands/commandUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAElE;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,aAAa,EAAE,0BAA0B;IACzC,IAAI,EAAE,oBAAoB;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,eAAe;CACb,CAAC;AAIX;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,mBAAmB;IAC3B,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,eAAe;CACb,CAAC;AAIX,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,oBAA0D,EAC1D,cAAkC,EAClC,MAAiB;IAEjB,MAAM,YAAY,GAAG,MAAM,eAAe,CACxC,oBAAoB,EACpB,cAAc,EACd,CAAC,MAAM,EAAE,0BAA0B,IAAI,EAAE,CAAC,CAAC,oBAA8B,CAAC,EAC1E,sBAAsB,CACvB,CAAC;IACF,OAAO,WAAW,CAAC,YAAY,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,eAAgD,EAChD,SAA6B,EAC7B,MAAiB;IAEjB,MAAM,OAAO,GAAG,MAAM,eAAe,CACnC,eAAe,EACf,SAAS,EACT,CAAC,MAAM,EAAE,qBAAqB,IAAI,EAAE,CAAC,CAAC,eAAyB,CAAC,EAChE,iBAAiB,CAClB,CAAC;IACF,OAAO,WAAW,CAChB,OAAO,EACP,eAAe,EACf,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CACzD,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAC;AAE3D,KAAK,UAAU,eAAe,CAC5B,QAAoE,EACpE,EAAsB;AACtB,8DAA8D;AAC9D,MAAW,EACX,wBAAkF;IAElF,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,sCAAsC;QACtC,IAAI,wBAAwB,CAAC,QAAiD,CAAC,EAAE,CAAC;YAChF,MAAM,YAAY,GAAG,gBAAgB,wBAAwB,CAAC,QAAiD,CAAC,EAAE,CAAC;YACnH,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;YAC3C,OAAO,MAAM,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,qBAAqB,QAAQ,0BAA0B,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC1C,yCAAyC;QACzC,OAAO,MAAO,QAAwD,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1 @@
+export * from '@gaunt-sloth/core/config.js';

package/dist/config.js

@@ -0,0 +1,2 @@
+export * from '@gaunt-sloth/core/config.js';
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC"}

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export * from '@gaunt-sloth/core/constants.js';

package/dist/constants.js

@@ -0,0 +1,2 @@
+export * from '@gaunt-sloth/core/constants.js';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC"}

package/dist/core/GthAgentRunner.d.ts

@@ -0,0 +1 @@
+export { GthAgentRunner } from '@gaunt-sloth/core/core/GthAgentRunner.js';

package/dist/core/GthAgentRunner.js

@@ -0,0 +1,2 @@
+export { GthAgentRunner } from '@gaunt-sloth/core/core/GthAgentRunner.js';
+//# sourceMappingURL=GthAgentRunner.js.map

package/dist/core/GthAgentRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GthAgentRunner.js","sourceRoot":"","sources":["../../src/core/GthAgentRunner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC"}

package/dist/core/types.d.ts

@@ -0,0 +1 @@
+export * from '@gaunt-sloth/core/core/types.js';

package/dist/core/types.js

@@ -0,0 +1,2 @@
+export * from '@gaunt-sloth/core/core/types.js';
+//# sourceMappingURL=types.js.map

package/dist/core/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC"}

package/dist/helpers/jira/jiraClient.d.ts

@@ -0,0 +1,11 @@
+import type { JiraConfig } from '#src/sources/types.js';
+export interface ResolvedJiraCredentials {
+    cloudId: string;
+    username?: string;
+    token?: string;
+    fullBase64Token?: string;
+    displayUrl?: string;
+}
+export declare function getJiraCredentials(config: Partial<JiraConfig> | null): ResolvedJiraCredentials;
+export declare function getJiraHeaders(config: ResolvedJiraCredentials): Record<string, string>;
+export declare function jiraRequest<T>(config: ResolvedJiraCredentials, endpoint: string, options?: RequestInit, showProgress?: boolean): Promise<T>;

package/dist/helpers/jira/jiraClient.js

@@ -0,0 +1,83 @@
+import { env } from '@gaunt-sloth/core/utils/systemUtils.js';
+import { ProgressIndicator } from '@gaunt-sloth/core/utils/ProgressIndicator.js';
+export function getJiraCredentials(config) {
+    if (!config) {
+        throw new Error('No Jira config provided');
+    }
+    const cloudId = env.JIRA_CLOUD_ID || config.cloudId;
+    if (!cloudId) {
+        throw new Error('Missing JIRA Cloud ID. The Cloud ID can be defined as JIRA_CLOUD_ID environment variable or as "cloudId" in config.');
+    }
+    const fullBase64Token = env.JIRA_FULL_BASE64_TOKEN || config.fullBase64Token;
+    if (fullBase64Token) {
+        return {
+            cloudId,
+            fullBase64Token,
+            displayUrl: config.displayUrl,
+        };
+    }
+    const username = env.JIRA_USERNAME || config.username;
+    if (!username) {
+        throw new Error('Missing JIRA username. The username can be defined as JIRA_USERNAME environment variable or as "username" in config.');
+    }
+    const token = env.JIRA_API_PAT_TOKEN || config.token;
+    if (!token) {
+        throw new Error('Missing JIRA PAT token. The token can be defined as JIRA_API_PAT_TOKEN environment variable or as "token" in config.');
+    }
+    return {
+        cloudId,
+        username,
+        token,
+        displayUrl: config.displayUrl,
+    };
+}
+export function getJiraHeaders(config) {
+    const authHeader = config.fullBase64Token
+        ? `Basic ${config.fullBase64Token}`
+        : `Basic ${Buffer.from(`${config.username}:${config.token}`).toString('base64')}`;
+    return {
+        Authorization: authHeader,
+        Accept: 'application/json; charset=utf-8',
+        'Accept-Language': 'en-US,en;q=0.9',
+        'Content-Type': 'application/json',
+    };
+}
+export async function jiraRequest(config, endpoint, options = {}, showProgress = true) {
+    const apiUrl = `https://api.atlassian.com/ex/jira/${config.cloudId}${endpoint}`;
+    const headers = getJiraHeaders(config);
+    let progressIndicator;
+    if (showProgress) {
+        progressIndicator = new ProgressIndicator(`${options.method || 'GET'} ${apiUrl.replace(/^https?:\/\//, '')}`);
+    }
+    try {
+        const response = await fetch(apiUrl, {
+            ...options,
+            headers: {
+                ...headers,
+                ...options.headers,
+            },
+        });
+        if (progressIndicator) {
+            progressIndicator.stop();
+        }
+        if (!response.ok) {
+            let errorMessage = `Failed to fetch from Jira: ${response.statusText}`;
+            try {
+                const errorData = await response.json();
+                errorMessage += ` - ${JSON.stringify(errorData)}`;
+            }
+            catch {
+                // If we can't parse JSON error, use the basic message
+            }
+            throw new Error(errorMessage);
+        }
+        return response.json();
+    }
+    catch (error) {
+        if (progressIndicator) {
+            progressIndicator.stop();
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=jiraClient.js.map

package/dist/helpers/jira/jiraClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jiraClient.js","sourceRoot":"","sources":["../../../src/helpers/jira/jiraClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,wCAAwC,CAAC;AAG7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAC;AAUjF,MAAM,UAAU,kBAAkB,CAAC,MAAkC;IACnE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,IAAI,MAAM,CAAC,OAAO,CAAC;IACpD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,qHAAqH,CACtH,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAAG,GAAG,CAAC,sBAAsB,IAAI,MAAM,CAAC,eAAe,CAAC;IAC7E,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO;YACL,OAAO;YACP,eAAe;YACf,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,GAAG,CAAC,aAAa,IAAI,MAAM,CAAC,QAAQ,CAAC;IACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,sHAAsH,CACvH,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,kBAAkB,IAAI,MAAM,CAAC,KAAK,CAAC;IACrD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,sHAAsH,CACvH,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO;QACP,QAAQ;QACR,KAAK;QACL,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAA+B;IAC5D,MAAM,UAAU,GAAG,MAAM,CAAC,eAAe;QACvC,CAAC,CAAC,SAAS,MAAM,CAAC,eAAe,EAAE;QACnC,CAAC,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;IAEpF,OAAO;QACL,aAAa,EAAE,UAAU;QACzB,MAAM,EAAE,iCAAiC;QACzC,iBAAiB,EAAE,gBAAgB;QACnC,cAAc,EAAE,kBAAkB;KACnC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAA+B,EAC/B,QAAgB,EAChB,UAAuB,EAAE,EACzB,YAAY,GAAG,IAAI;IAEnB,MAAM,MAAM,GAAG,qCAAqC,MAAM,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;IAChF,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAEvC,IAAI,iBAAgD,CAAC;IACrD,IAAI,YAAY,EAAE,CAAC;QACjB,iBAAiB,GAAG,IAAI,iBAAiB,CACvC,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,EAAE,CACnE,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE;YACnC,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,GAAG,OAAO,CAAC,OAAO;aACnB;SACF,CAAC,CAAC;QAEH,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,YAAY,GAAG,8BAA8B,QAAQ,CAAC,UAAU,EAAE,CAAC;YACvE,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,YAAY,IAAI,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACpD,CAAC;YAAC,MAAM,CAAC;gBACP,sDAAsD;YACxD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAgB,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from '@gaunt-sloth/core/config.js';
+export * from '#src/modules/reviewModule.js';
+export * from '#src/modules/questionAnsweringModule.js';
+export * from '#src/commands/commandUtils.js';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from '@gaunt-sloth/core/config.js';
+export * from '#src/modules/reviewModule.js';
+export * from '#src/modules/questionAnsweringModule.js';
+export * from '#src/commands/commandUtils.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC"}

package/dist/middleware/reviewRateMiddleware.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @packageDocumentation
+ * Middleware responsible for generating review ratings after the agent finishes.
+ *
+ * The middleware runs an additional model call that summarizes the review outcome
+ * and stores the structured result inside the global artifact store.
+ */
+import { type AgentMiddleware } from 'langchain';
+import * as z from 'zod';
+import type { GthConfig, RatingConfig } from '@gaunt-sloth/core/config.js';
+/**
+ * Schema describing the result of the review rating step.
+ */
+export declare const RateSchema: z.ZodObject<{
+    rate: z.ZodNumber;
+    comment: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Type representing a review rating response.
+ */
+export type RateResponse = z.infer<typeof RateSchema>;
+export interface ReviewRatingArtifact extends RateResponse {
+    passThreshold: number;
+    minRating: number;
+    maxRating: number;
+}
+export declare const REVIEW_RATE_ARTIFACT_KEY = "gsloth.review.rate";
+interface NormalizedRatingConfig {
+    minRating: number;
+    maxRating: number;
+    passThreshold: number;
+}
+export type ReviewRateMiddlewareSettings = RatingConfig & {
+    name?: 'review-rate';
+};
+export declare function normalizeRatingConfig(config: RatingConfig | undefined): NormalizedRatingConfig;
+export declare function createReviewRateMiddleware(settings: ReviewRateMiddlewareSettings, gthConfig: GthConfig): Promise<AgentMiddleware>;
+export {};

package/dist/middleware/reviewRateMiddleware.js

@@ -0,0 +1,103 @@
+/**
+ * @packageDocumentation
+ * Middleware responsible for generating review ratings after the agent finishes.
+ *
+ * The middleware runs an additional model call that summarizes the review outcome
+ * and stores the structured result inside the global artifact store.
+ */
+import { HumanMessage } from '@langchain/core/messages';
+import { tool } from '@langchain/core/tools';
+import { createAgent, createMiddleware } from 'langchain';
+import * as z from 'zod';
+import { setArtifact, deleteArtifact } from '@gaunt-sloth/core/state/artifactStore.js';
+import { debugLog, debugLogError } from '@gaunt-sloth/core/utils/debugUtils.js';
+import { getNewRunnableConfig } from '@gaunt-sloth/core/utils/llmUtils.js';
+/**
+ * Schema describing the result of the review rating step.
+ */
+export const RateSchema = z.object({
+    rate: z.number().min(0).max(10).describe('Review rating from 0 to 10'),
+    comment: z.string().describe('Comment explaining the rating'),
+});
+export const REVIEW_RATE_ARTIFACT_KEY = 'gsloth.review.rate';
+const DEFAULT_MIN_RATING = 0;
+const DEFAULT_MAX_RATING = 10;
+const DEFAULT_PASS_THRESHOLD = 6;
+export function normalizeRatingConfig(config) {
+    const min = config?.minRating ?? DEFAULT_MIN_RATING;
+    const max = config?.maxRating ?? DEFAULT_MAX_RATING;
+    const [minRating, maxRating] = min <= max ? [min, max] : [max, min];
+    const threshold = config?.passThreshold ?? DEFAULT_PASS_THRESHOLD;
+    return {
+        minRating,
+        maxRating,
+        passThreshold: clamp(threshold, minRating, maxRating),
+    };
+}
+const REVIEW_RATE_TOOL_NAME = 'gth_review_rate';
+export function createReviewRateMiddleware(settings, gthConfig) {
+    const normalizedConfig = normalizeRatingConfig(settings);
+    const rateTool = tool((input) => {
+        const artifact = {
+            ...input,
+            ...normalizedConfig,
+        };
+        setArtifact(REVIEW_RATE_ARTIFACT_KEY, artifact);
+        return `Stored rating ${input.rate}/${normalizedConfig.maxRating}`;
+    }, {
+        name: REVIEW_RATE_TOOL_NAME,
+        description: 'Stores the final review rating and summary comment.',
+        schema: RateSchema,
+    });
+    const ratingAgent = createAgent({
+        model: gthConfig.llm,
+        tools: [rateTool],
+    });
+    return Promise.resolve(createMiddleware({
+        name: 'review-rate',
+        afterAgent: async (state) => {
+            if (!Array.isArray(state.messages) || state.messages.length === 0) {
+                return state;
+            }
+            deleteArtifact(REVIEW_RATE_ARTIFACT_KEY);
+            const ratingPrompt = buildRatingInstructions(normalizedConfig);
+            debugLog('ReviewRateMiddleware: requesting rating evaluation');
+            try {
+                const ratingMessages = [...state.messages, new HumanMessage(ratingPrompt)];
+                await ratingAgent.invoke({
+                    messages: ratingMessages,
+                }, getNewRunnableConfig());
+            }
+            catch (error) {
+                debugLogError('ReviewRateMiddleware.invoke', error);
+            }
+            return state;
+        },
+    }));
+}
+function buildRatingInstructions(config) {
+    const formattedThreshold = formatScore(config.passThreshold);
+    const formattedMax = formatScore(config.maxRating);
+    const formattedMin = formatScore(config.minRating);
+    const middle = formatScore((config.passThreshold + config.maxRating) / 2);
+    return [
+        'A reviewer just finished assessing a code change.',
+        'Your job is to inspect the entire conversation above, focus on the code being discussed (not the review quality),',
+        'and call the ' + REVIEW_RATE_TOOL_NAME + ' tool exactly once.',
+        `Assign a score between ${formattedMin}-${formattedMax} that reflects the code quality only.`,
+        `Pass threshold is ${formattedThreshold}, everything below will be considered a fail.`,
+        '',
+        'Additional guidelines:',
+        `- Never give ${formattedThreshold}/${formattedMax} or more to code which would explode with syntax error.`,
+        `- Rate excellent code as ${formattedMax}/${formattedMax}`,
+        `- Rate code needing improvements as ${middle}/${formattedMax}`,
+        '- Use the comment field of the tool call for a concise summary referencing the code state.',
+    ].join('\n');
+}
+function clamp(value, min, max) {
+    return Math.min(Math.max(value, min), max);
+}
+function formatScore(value) {
+    return Number.isInteger(value) ? String(value) : value.toFixed(1);
+}
+//# sourceMappingURL=reviewRateMiddleware.js.map

package/dist/middleware/reviewRateMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewRateMiddleware.js","sourceRoot":"","sources":["../../src/middleware/reviewRateMiddleware.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAwB,MAAM,WAAW,CAAC;AAChF,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACtE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;CAC9D,CAAC,CAAC;AAaH,MAAM,CAAC,MAAM,wBAAwB,GAAG,oBAAoB,CAAC;AAE7D,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,sBAAsB,GAAG,CAAC,CAAC;AAYjC,MAAM,UAAU,qBAAqB,CAAC,MAAgC;IACpE,MAAM,GAAG,GAAG,MAAM,EAAE,SAAS,IAAI,kBAAkB,CAAC;IACpD,MAAM,GAAG,GAAG,MAAM,EAAE,SAAS,IAAI,kBAAkB,CAAC;IACpD,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,MAAM,EAAE,aAAa,IAAI,sBAAsB,CAAC;IAElE,OAAO;QACL,SAAS;QACT,SAAS;QACT,aAAa,EAAE,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;KACtD,CAAC;AACJ,CAAC;AAED,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEhD,MAAM,UAAU,0BAA0B,CACxC,QAAsC,EACtC,SAAoB;IAEpB,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAEzD,MAAM,QAAQ,GAAG,IAAI,CACnB,CAAC,KAAmB,EAAE,EAAE;QACtB,MAAM,QAAQ,GAAyB;YACrC,GAAG,KAAK;YACR,GAAG,gBAAgB;SACpB,CAAC;QACF,WAAW,CAAC,wBAAwB,EAAE,QAAQ,CAAC,CAAC;QAEhD,OAAO,iBAAiB,KAAK,CAAC,IAAI,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;IACrE,CAAC,EACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EAAE,qDAAqD;QAClE,MAAM,EAAE,UAAU;KACnB,CACF,CAAC;IAEF,MAAM,WAAW,GAAG,WAAW,CAAC;QAC9B,KAAK,EAAE,SAAS,CAAC,GAAG;QACpB,KAAK,EAAE,CAAC,QAAQ,CAAC;KAClB,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CACpB,gBAAgB,CAAC;QACf,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClE,OAAO,KAAK,CAAC;YACf,CAAC;YAED,cAAc,CAAC,wBAAwB,CAAC,CAAC;YAEzC,MAAM,YAAY,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;YAE/D,QAAQ,CAAC,oDAAoD,CAAC,CAAC;YAE/D,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;gBAE3E,MAAM,WAAW,CAAC,MAAM,CACtB;oBACE,QAAQ,EAAE,cAAc;iBACzB,EACD,oBAAoB,EAAE,CACvB,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,aAAa,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;YACtD,CAAC;YAED,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,MAA8B;IAC7D,MAAM,kBAAkB,GAAG,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,MAAM,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAE1E,OAAO;QACL,mDAAmD;QACnD,mHAAmH;QACnH,eAAe,GAAG,qBAAqB,GAAG,qBAAqB;QAC/D,0BAA0B,YAAY,IAAI,YAAY,uCAAuC;QAC7F,qBAAqB,kBAAkB,+CAA+C;QACtF,EAAE;QACF,wBAAwB;QACxB,gBAAgB,kBAAkB,IAAI,YAAY,yDAAyD;QAC3G,4BAA4B,YAAY,IAAI,YAAY,EAAE;QAC1D,uCAAuC,MAAM,IAAI,YAAY,EAAE;QAC/D,4FAA4F;KAC7F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW;IACpD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC"}

package/dist/modules/questionAnsweringModule.d.ts

@@ -0,0 +1,9 @@
+import type { GthConfig } from '@gaunt-sloth/core/config.js';
+import type { AgentResolvers } from '@gaunt-sloth/core/core/types.js';
+/**
+ * Ask a question and get an answer from the LLM
+ * @param source - The source of the question (used for file naming)
+ * @param preamble - The preamble to send to the LLM
+ * @param content - The content of the question
+ */
+export declare function askQuestion(source: string, preamble: string, content: string, config: GthConfig, resolvers?: AgentResolvers): Promise<void>;

package/dist/modules/questionAnsweringModule.js

@@ -0,0 +1,49 @@
+import { defaultStatusCallback, display, displayError, displaySuccess, flushSessionLog, initSessionLogging, stopSessionLogging, } from '@gaunt-sloth/core/utils/consoleUtils.js';
+import { getCommandOutputFilePath } from '#src/utils/fileUtils.js';
+import { GthAgentRunner } from '@gaunt-sloth/core/core/GthAgentRunner.js';
+import { MemorySaver } from '@langchain/langgraph';
+import { HumanMessage, SystemMessage } from '@langchain/core/messages';
+import { ProgressIndicator } from '@gaunt-sloth/core/utils/ProgressIndicator.js';
+/**
+ * Ask a question and get an answer from the LLM
+ * @param source - The source of the question (used for file naming)
+ * @param preamble - The preamble to send to the LLM
+ * @param content - The content of the question
+ */
+export async function askQuestion(source, preamble, content, config, resolvers) {
+    const progressIndicator = config.streamOutput ? undefined : new ProgressIndicator('Thinking.');
+    const messages = [new SystemMessage(preamble), new HumanMessage(content)];
+    // Resolve output path and initialize session logging if enabled
+    const filePath = getCommandOutputFilePath(config, source);
+    if (filePath) {
+        initSessionLogging(filePath, config.streamSessionInferenceLog);
+    }
+    // Run via Agent Runner (consistent with interactive session)
+    const runner = new GthAgentRunner(defaultStatusCallback, resolvers);
+    try {
+        await runner.init('ask', config, new MemorySaver());
+        await runner.processMessages(messages);
+    }
+    catch (err) {
+        displayError(`Failed to get answer: ${err instanceof Error ? err.message : String(err)}`);
+    }
+    finally {
+        await runner.cleanup();
+    }
+    progressIndicator?.stop();
+    if (config.writeOutputToFile === false) {
+        display('\n'); // something going on in some terminals, they swallow last line of output
+    }
+    if (filePath) {
+        try {
+            flushSessionLog();
+            stopSessionLogging();
+            displaySuccess(`\n\nThis report can be found in ${filePath}`);
+        }
+        catch (error) {
+            displayError(`Failed to write answer to file: ${filePath}`);
+            displayError(error instanceof Error ? error.message : String(error));
+        }
+    }
+}
+//# sourceMappingURL=questionAnsweringModule.js.map

package/dist/modules/questionAnsweringModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"questionAnsweringModule.js","sourceRoot":"","sources":["../../src/modules/questionAnsweringModule.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACrB,OAAO,EACP,YAAY,EACZ,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8CAA8C,CAAC;AAGjF;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,MAAc,EACd,QAAgB,EAChB,OAAe,EACf,MAAiB,EACjB,SAA0B;IAE1B,MAAM,iBAAiB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAC/F,MAAM,QAAQ,GAAG,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAE1E,gEAAgE;IAChE,MAAM,QAAQ,GAAG,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1D,IAAI,QAAQ,EAAE,CAAC;QACb,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,yBAAyB,CAAC,CAAC;IACjE,CAAC;IAED,6DAA6D;IAC7D,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC;IACpE,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,WAAW,EAAE,CAAC,CAAC;QACpD,MAAM,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,YAAY,CAAC,yBAAyB,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAED,iBAAiB,EAAE,IAAI,EAAE,CAAC;IAE1B,IAAI,MAAM,CAAC,iBAAiB,KAAK,KAAK,EAAE,CAAC;QACvC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,yEAAyE;IAC1F,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,IAAI,CAAC;YACH,eAAe,EAAE,CAAC;YAClB,kBAAkB,EAAE,CAAC;YACrB,cAAc,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,YAAY,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;YAC5D,YAAY,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/modules/reviewModule.d.ts

@@ -0,0 +1,3 @@
+import type { GthConfig } from '@gaunt-sloth/core/config.js';
+import type { AgentResolvers } from '@gaunt-sloth/core/core/types.js';
+export declare function review(source: string, preamble: string, diff: string, config: GthConfig, command?: 'pr' | 'review', resolvers?: AgentResolvers): Promise<void>;