gaunt-sloth-assistant 0.1.4 → 0.2.2

package/docs/CONFIGURATION.md

@@ -62,7 +62,7 @@ JSON configuration is simpler but less flexible than JavaScript configuration. I
 {
   "llm": {
     "type": "vertexai",
-    "model": "gemini-2.5-pro-exp-03-25",
+    "model": "gemini-2.5-pro-preview-05-06",
     "temperature": 0
   }
 }
@@ -109,7 +109,7 @@ export async function configure(importFunction, global) {
     const vertexAi = await importFunction('@langchain/google-vertexai');
     return {
         llm: new vertexAi.ChatVertexAI({
-            model: "gemini-2.5-pro-exp-03-25", // Consider checking for latest recommended model versions
+            model: "gemini-2.5-pro-preview-05-06", // Consider checking for latest recommended model versions
             // API Key from AI Studio should also work
             temperature: 0,
             //// Other parameters might be relevant depending on Vertex AI API updates.
@@ -146,16 +146,106 @@ See [Langchain documentation](https://js.langchain.com/docs/tutorials/llm_chain/
 
 ### JIRA
 
+Gaunt Sloth supports two methods to integrate with JIRA:
+
+#### 1. Modern Jira REST API (Scoped Token)
+
+This method uses the Atlassian REST API v3 with a Personal Access Token (PAT). It requires your Atlassian Cloud ID.
+
+**Prerequisites:**
+
+1. **Cloud ID**: You can find your Cloud ID by visiting `https://yourcompany.atlassian.net/_edge/tenant_info` while authenticated.
+
+2. **Personal Access Token (PAT)**: Create a PAT with the appropriate permissions from `Atlassian Account Settings -> Security -> Create and manage API tokens -> [Create API token with scopes]`.
+   - For issue access, the recommended permission is `read:jira-work` (classic)
+   - Alternatively granular access would require: `read:issue-meta:jira`, `read:issue-security-level:jira`, `read:issue.vote:jira`, `read:issue.changelog:jira`, `read:avatar:jira`, `read:issue:jira`, `read:status:jira`, `read:user:jira`, `read:field-configuration:jira`
+
+Refer to JIRA API documentation for more details [https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get)
+
+**Environment Variables Support:**
+
+For better security, you can set the JIRA username, token, and cloud ID using environment variables instead of placing them in the configuration file:
+
+- `JIRA_USERNAME`: Your JIRA username (e.g., `user@yourcompany.com`).
+- `JIRA_API_PAT_TOKEN`: Your JIRA Personal Access Token with scopes.
+- `JIRA_CLOUD_ID`: Your Atlassian Cloud ID.
+
+If these environment variables are set, they will take precedence over the values in the configuration file.
+
+JSON:
+
+```json
+{
+  "llm": {"type": "vertexai", "model": "gemini-2.5-pro-preview-05-06"},
+  "requirementsProvider": "jira",
+  "requirementsProviderConfig": {
+    "jira": {
+      "username": "username@yourcompany.com",
+      "token": "YOUR_JIRA_PAT_TOKEN",
+      "cloudId": "YOUR_ATLASSIAN_CLOUD_ID"
+    }
+  }
+}
+```
+
+Optionally displayUrl can be defined to have a clickable link in the output:
+
+```json
+{
+  "llm": {"type": "vertexai", "model": "gemini-2.5-pro-preview-05-06"},
+  "requirementsProvider": "jira",
+  "requirementsProviderConfig": {
+    "jira": {
+      "displayUrl": "https://yourcompany.atlassian.net/browse/"
+    }
+  }
+}
+```
+
+JavaScript:
+
+```javascript
+export async function configure(importFunction, global) {
+    const vertexAi = await importFunction('@langchain/google-vertexai');
+    return {
+        llm: new vertexAi.ChatVertexAI({
+            model: "gemini-2.5-pro-preview-05-06"
+        }),
+        requirementsProvider: 'jira',
+        requirementsProviderConfig: {
+            'jira': {
+                username: 'username@yourcompany.com', // Your Jira username/email
+                token: 'YOUR_JIRA_PAT_TOKEN',        // Your Personal Access Token
+                cloudId: 'YOUR_ATLASSIAN_CLOUD_ID'    // Your Atlassian Cloud ID
+            }
+        }
+    }
+}
+```
+
+#### 2. Legacy Jira REST API (Unscoped Token)
+
+This uses the Unscoped API token (Aka Legacy API token) method with REST API v2.
+
+A legacy token can be acquired from `Atlassian Account Settings -> Security -> Create and manage API tokens -> [Create API token without scopes]`.
+
 Example configuration setting up JIRA integration using a legacy API token for both `review` and `pr` commands.
 Make sure you use your actual company domain in `baseUrl` and your personal legacy `token`.
 
-A legacy token can be acquired from `Atlassian Account Settings -> Security -> Create and manage API tokens`.
+**Environment Variables Support:**
+
+For better security, you can set the JIRA username and token using environment variables instead of placing them in the configuration file:
+
+- `JIRA_USERNAME`: Your JIRA username (e.g., `user@yourcompany.com`).
+- `JIRA_LEGACY_API_TOKEN`: Your JIRA legacy API token.
+
+If these environment variables are set, they will take precedence over the values in the configuration file.
 
 JSON:
 
 ```json
 {
-  "llm": {"type": "vertexai", "model": "gemini-2.5-pro-exp-03-25"},
+  "llm": {"type": "vertexai", "model": "gemini-2.5-pro-preview-05-06"},
   "requirementsProvider": "jira-legacy",
   "requirementsProviderConfig": {
     "jira-legacy": {
@@ -174,7 +264,7 @@ export async function configure(importFunction, global) {
     const vertexAi = await importFunction('@langchain/google-vertexai');
     return {
         llm: new vertexAi.ChatVertexAI({
-            model: "gemini-2.5-pro-exp-03-25"
+            model: "gemini-2.5-pro-preview-05-06"
         }),
         requirementsProvider: 'jira-legacy',
         requirementsProviderConfig: {
@@ -187,4 +277,3 @@ export async function configure(importFunction, global) {
     }
 }
 ```
-

package/docs/RELEASE-HOWTO.md

@@ -16,7 +16,7 @@ git push --tags
 
 Note the release version and do 
 ```shell
-gh release create --generate-notes
+gh release create --notes "notes"
 ```
 
 Publish to NPM

package/eslint.config.js

@@ -1,38 +1,116 @@
-import js from "@eslint/js";
-import { defineConfig } from "eslint/config";
-import jasmine from "eslint-plugin-jasmine"
-import globals from "globals";
+import jsConfig from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+import tseslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import prettierConfig from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const { setTimeout, setInterval, clearInterval, Buffer, fetch } = globals.node;
+// Get the directory path of the current module
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Global ignores applied to all configurations
+const globalIgnores = ['**/node_modules/**', '**/dist/**', 'coverage/**', '.git/**'];
 
 export default defineConfig([
+  // Ignore files config - applies first
+  {
+    ignores: globalIgnores,
+  },
+  // Base configuration for all JavaScript files
   {
-    files: ["src/**/*.js"],
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+      },
+    },
     plugins: {
-      js,
+      prettier: prettierPlugin,
     },
-    extends: ["js/recommended"],
     rules: {
-      semi: "error",
-      "eol-last": "error"
+      ...jsConfig.configs.recommended.rules,
+      ...prettierConfig.rules,
+      semi: 'error',
+      'eol-last': 'error',
+      'prettier/prettier': 'error',
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
     },
+  },
+  // Source TypeScript files
+  {
+    files: ['src/**/*.ts'],
     languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+        project: path.resolve(__dirname, 'tsconfig.json'),
+      },
       globals: {
-        setTimeout,
-        setInterval,
-        clearInterval,
-        Buffer,
-        fetch
+        ...globals.node,
       },
     },
+    plugins: {
+      '@typescript-eslint': tseslint,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      ...tseslint.configs.recommended.rules,
+      ...prettierConfig.rules,
+      semi: 'error',
+      'eol-last': 'error',
+      'prettier/prettier': 'error',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_', caughtErrorsIgnorePattern: '^_' },
+      ],
+    },
   },
+  // Test TypeScript files with separate project reference
   {
-    files: ["spec/**/*.js"],
-    plugins: { jasmine },
-    extends: ["jasmine/recommended"],
+    files: ['spec/**/*.ts', 'vitest.config.ts'],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+        // No project needed for tests to avoid parser errors
+      },
+      globals: {
+        ...globals.node,
+        describe: 'readonly',
+        it: 'readonly',
+        expect: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+        vi: 'readonly',
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tseslint,
+      prettier: prettierPlugin,
+    },
     rules: {
-      semi: "error",
-      "eol-last": "error",
-    }
+      ...tseslint.configs.recommended.rules,
+      ...prettierConfig.rules,
+      semi: 'error',
+      'eol-last': 'error',
+      'prettier/prettier': 'error',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'off', // Allow any in test files
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ], // Error for unused vars in tests
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }], // For .js test files
+    },
   },
 ]);

package/index.js

@@ -1,31 +1,14 @@
 #!/usr/bin/env node
-import { Command } from 'commander';
-import { dirname } from 'node:path';
-import { fileURLToPath } from "url";
-import { reviewCommand } from "./src/commands/reviewCommand.js";
-import { initCommand } from "./src/commands/initCommand.js";
-import { askCommand } from "./src/commands/askCommand.js";
-import { slothContext } from "./src/config.js";
-import { getSlothVersion, readStdin } from "./src/utils.js";
-import {getCurrentDir, getInstallDir, setInstallDir} from "./src/systemUtils.js";
 
-const program = new Command();
+// This is a minimalistic entry point that sets the installDir in systemUtils
+// and delegates to the compiled TypeScript code in dist/index.js
+import { setEntryPoint } from './dist/systemUtils.js';
 
-setInstallDir(dirname(fileURLToPath(import.meta.url)));
-slothContext.currentDir = getCurrentDir();
-slothContext.installDir = getInstallDir();
+// Set the installation directory in systemUtils
+setEntryPoint(import.meta.url);
 
-program
-    .name('gsloth')
-    .description('Gaunt Sloth Assistant reviewing your PRs')
-    .version(getSlothVersion());
-
-initCommand(program, slothContext);
-
-reviewCommand(program, slothContext)
-
-askCommand(program, slothContext);
-
-// TODO add general interactive chat command
-
-await readStdin(program);
+// Import and run the compiled TypeScript code
+import('./dist/index.js').catch((err) => {
+  console.error('Failed to load application:', err);
+  process.exit(1);
+});

package/package.json

@@ -1,41 +1,52 @@
 {
   "name": "gaunt-sloth-assistant",
-  "version": "0.1.4",
+  "version": "0.2.2",
   "description": "",
   "license": "MIT",
   "author": "Andrew Kondratev",
   "type": "module",
-  "main": "index.js",
+  "main": "dist/index.js",
   "repository": "github:andruhon/gaunt-sloth-assistant",
   "engines": {
     "node": ">=22.0.0",
     "npm": ">=10.9.0"
   },
   "scripts": {
-    "test": "jasmine",
-    "lint": "eslint"
+    "build": "tsc",
+    "test": "npm run build &&vitest run",
+    "lint": "eslint . --ext .js,.ts",
+    "format": "prettier --write 'src/**/*.{js,ts}'",
+    "prepare": "npm run build"
   },
   "bin": {
     "gsloth": "index.js",
     "gth": "index.js"
   },
   "dependencies": {
-    "@langchain/anthropic": "^0.3.18",
-    "@langchain/core": "^0.3.45",
-    "@langchain/google-vertexai": "^0.2.4",
+    "@langchain/anthropic": "^0.3.20",
+    "@langchain/core": "^0.3.55",
+    "@langchain/google-vertexai": "^0.2.8",
     "@langchain/groq": "^0.2.2",
-    "@langchain/langgraph": "^0.2.65",
-    "@types/node": "^22.14.1",
+    "@langchain/langgraph": "^0.2.71",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.25.1",
-    "eslint": "^9.25.1",
-    "eslint-plugin-jasmine": "^4.2.2",
-    "globals": "^16.0.0",
-    "jasmine": "^5.6.0",
-    "testdouble": "^3.20.2"
+    "@eslint/js": "^9.26.0",
+    "@types/node": "^22.15.17",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.32.0",
+    "@typescript-eslint/parser": "^8.32.0",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": "^16.1.0",
+    "prettier": "3.5.3",
+    "typescript": "^5.4.2",
+    "vitest": "^3.1.3"
+  },
+  "imports": {
+    "#src/*.js": "./dist/*.js"
   }
 }

package/src/commands/askCommand.ts

@@ -0,0 +1,34 @@
+import { Command } from 'commander';
+import { readInternalPreamble } from '#src/prompt.js';
+import { readMultipleFilesFromCurrentDir } from '#src/utils.js';
+import { initConfig } from '#src/config.js';
+
+interface AskCommandOptions {
+  file?: string[];
+}
+
+/**
+ * Adds the ask command to the program
+ * @param program - The commander program
+ */
+export function askCommand(program: Command): void {
+  program
+    .command('ask')
+    .description('Ask a question')
+    .argument('<message>', 'A message')
+    .option(
+      '-f, --file [files...]',
+      'Input files. Content of these files will be added BEFORE the message'
+    )
+    // TODO add option consuming extra message as argument
+    .action(async (message: string, options: AskCommandOptions) => {
+      const preamble = [readInternalPreamble()];
+      const content = [message];
+      if (options.file) {
+        content.push(readMultipleFilesFromCurrentDir(options.file));
+      }
+      await initConfig();
+      const { askQuestion } = await import('#src/modules/questionAnsweringModule.js');
+      await askQuestion('sloth-ASK', preamble.join('\n'), content.join('\n'));
+    });
+}

package/src/commands/initCommand.ts

@@ -0,0 +1,19 @@
+import type { ConfigType } from '#src/config.js';
+import { availableDefaultConfigs, createProjectConfig } from '#src/config.js';
+import { Argument, Command } from 'commander';
+
+/**
+ * Adds the init command to the program
+ * @param program - The commander program
+ */
+export function initCommand(program: Command): void {
+  program
+    .command('init')
+    .description(
+      'Initialize the Gaunt Sloth Assistant in your project. This will write necessary config files.'
+    )
+    .addArgument(new Argument('<type>', 'Config type').choices(availableDefaultConfigs))
+    .action(async (config: ConfigType) => {
+      await createProjectConfig(config);
+    });
+}

package/src/commands/reviewCommand.ts

@@ -0,0 +1,209 @@
+import { Command, Option } from 'commander';
+import { USER_PROJECT_REVIEW_PREAMBLE } from '#src/config.js';
+import { readInternalPreamble, readPreamble } from '#src/prompt.js';
+import { readMultipleFilesFromCurrentDir } from '#src/utils.js';
+import { displayError } from '#src/consoleUtils.js';
+import type { SlothContext } from '#src/config.js';
+
+/**
+ * Requirements providers. Expected to be in `.providers/` dir
+ */
+const REQUIREMENTS_PROVIDERS = {
+  'jira-legacy': 'jiraIssueLegacyProvider.js',
+  jira: 'jiraIssueProvider.js',
+  text: 'text.js',
+  file: 'file.js',
+} as const;
+
+type RequirementsProviderType = keyof typeof REQUIREMENTS_PROVIDERS;
+
+/**
+ * Content providers. Expected to be in `.providers/` dir
+ */
+const CONTENT_PROVIDERS = {
+  gh: 'ghPrDiffProvider.js',
+  text: 'text.js',
+  file: 'file.js',
+} as const;
+
+type ContentProviderType = keyof typeof CONTENT_PROVIDERS;
+
+interface ReviewCommandOptions {
+  file?: string[];
+  requirements?: string;
+  requirementsProvider?: RequirementsProviderType;
+  contentProvider?: ContentProviderType;
+  message?: string;
+}
+
+interface PrCommandOptions {
+  file?: string[];
+  requirementsProvider?: RequirementsProviderType;
+}
+
+export function reviewCommand(program: Command, context: SlothContext): void {
+  program
+    .command('review')
+    .description('Review provided diff or other content')
+    .argument(
+      '[contentId]',
+      'Optional content ID argument to retrieve content with content provider'
+    )
+    .alias('r')
+    // TODO add provider to get results of git --no-pager diff
+    .option(
+      '-f, --file [files...]',
+      'Input files. Content of these files will be added BEFORE the diff, but after requirements'
+    )
+    // TODO figure out what to do with this (we probably want to merge it with requirementsId)?
+    .option('-r, --requirements <requirements>', 'Requirements for this review.')
+    .addOption(
+      new Option(
+        '-p, --requirements-provider <requirementsProvider>',
+        'Requirements provider for this review.'
+      ).choices(Object.keys(REQUIREMENTS_PROVIDERS))
+    )
+    .addOption(
+      new Option('--content-provider <contentProvider>', 'Content  provider').choices(
+        Object.keys(CONTENT_PROVIDERS)
+      )
+    )
+    .option('-m, --message <message>', 'Extra message to provide just before the content')
+    .action(async (contentId: string | undefined, options: ReviewCommandOptions) => {
+      const { initConfig } = await import('#src/config.js');
+      await initConfig();
+      const preamble = [readInternalPreamble(), readPreamble(USER_PROJECT_REVIEW_PREAMBLE)];
+      const content: string[] = [];
+      const requirementsId = options.requirements;
+      const requirementsProvider =
+        options.requirementsProvider ??
+        (context.config?.review?.requirementsProvider as RequirementsProviderType | undefined) ??
+        (context.config?.requirementsProvider as RequirementsProviderType | undefined);
+      const contentProvider =
+        options.contentProvider ??
+        (context.config?.review?.contentProvider as ContentProviderType | undefined) ??
+        (context.config?.contentProvider as ContentProviderType | undefined);
+
+      // TODO consider calling these in parallel
+      const requirements = await getRequirementsFromProvider(requirementsProvider, requirementsId);
+      if (requirements) {
+        content.push(requirements);
+      }
+
+      const providedContent = await getContentFromProvider(contentProvider, contentId);
+      if (providedContent) {
+        content.push(providedContent);
+      }
+
+      if (options.file) {
+        content.push(readMultipleFilesFromCurrentDir(options.file));
+      }
+      if (context.stdin) {
+        content.push(context.stdin);
+      }
+      if (options.message) {
+        content.push(options.message);
+      }
+      const { review } = await import('#src/modules/reviewModule.js');
+      await review('sloth-DIFF-review', preamble.join('\n'), content.join('\n'));
+    });
+
+  program
+    .command('pr')
+    .description(
+      'Review provided Pull Request in current directory. ' +
+        'This command is similar to `review`, but default content provider is `gh`. ' +
+        '(assuming that GH cli is installed and authenticated for current project'
+    )
+    .argument('<prId>', 'Pull request ID to review.')
+    .argument(
+      '[requirementsId]',
+      'Optional requirements ID argument to retrieve requirements with requirements provider'
+    )
+    .addOption(
+      new Option(
+        '-p, --requirements-provider <requirementsProvider>',
+        'Requirements provider for this review.'
+      ).choices(Object.keys(REQUIREMENTS_PROVIDERS))
+    )
+    .option(
+      '-f, --file [files...]',
+      'Input files. Content of these files will be added BEFORE the diff, but after requirements'
+    )
+    .action(async (prId: string, requirementsId: string | undefined, options: PrCommandOptions) => {
+      const { initConfig } = await import('#src/config.js');
+      await initConfig();
+
+      const preamble = [readInternalPreamble(), readPreamble(USER_PROJECT_REVIEW_PREAMBLE)];
+      const content: string[] = [];
+      const requirementsProvider =
+        options.requirementsProvider ??
+        (context.config?.pr?.requirementsProvider as RequirementsProviderType | undefined) ??
+        (context.config?.requirementsProvider as RequirementsProviderType | undefined);
+
+      // Handle requirements
+      const requirements = await getRequirementsFromProvider(requirementsProvider, requirementsId);
+      if (requirements) {
+        content.push(requirements);
+      }
+
+      if (options.file) {
+        content.push(readMultipleFilesFromCurrentDir(options.file));
+      }
+
+      // Get PR diff using the 'gh' provider
+      const providerPath = `#src/providers/${CONTENT_PROVIDERS['gh']}`;
+      const { get } = await import(providerPath);
+      content.push(await get(null, prId));
+
+      const { review } = await import('#src/modules/reviewModule.js');
+      await review(`sloth-PR-${prId}-review`, preamble.join('\n'), content.join('\n'));
+    });
+
+  async function getRequirementsFromProvider(
+    requirementsProvider: RequirementsProviderType | undefined,
+    requirementsId: string | undefined
+  ): Promise<string> {
+    return getFromProvider(
+      requirementsProvider,
+      requirementsId,
+      (context.config?.requirementsProviderConfig ?? {})[requirementsProvider as string],
+      REQUIREMENTS_PROVIDERS
+    );
+  }
+
+  async function getContentFromProvider(
+    contentProvider: ContentProviderType | undefined,
+    contentId: string | undefined
+  ): Promise<string> {
+    return getFromProvider(
+      contentProvider,
+      contentId,
+      (context.config?.contentProviderConfig ?? {})[contentProvider as string],
+      CONTENT_PROVIDERS
+    );
+  }
+
+  async function getFromProvider(
+    provider: RequirementsProviderType | ContentProviderType | undefined,
+    id: string | undefined,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    config: any,
+    legitPredefinedProviders: typeof REQUIREMENTS_PROVIDERS | typeof CONTENT_PROVIDERS
+  ): Promise<string> {
+    if (typeof provider === 'string') {
+      // Use one of the predefined providers
+      if (legitPredefinedProviders[provider as keyof typeof legitPredefinedProviders]) {
+        const providerPath = `#src/providers/${legitPredefinedProviders[provider as keyof typeof legitPredefinedProviders]}`;
+        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 as (id: string | undefined) => Promise<string>)(id);
+    }
+    return '';
+  }
+}