gaunt-sloth-assistant 0.1.0 → 0.1.2

package/.gsloth.preamble.review.md

@@ -18,6 +18,7 @@ You are conducting LangChain.js/LangGraph.js Node.JS code review.
 
 ### Security
 - Validate API key handling and environment variables
+- Make sure no personal data is present in code
 - Check for proper input sanitization
 - Review rate limiting implementation
 - Verify output validation and sanitization

package/README.md

@@ -54,7 +54,7 @@ export async function configure(importFunction, global) {
         requirementsProvider: 'jira-legacy',
         requirementsProviderConfig: {
             'jira-legacy': {
-                username: 'andrei.kondratev@unimarket.com', // Your Jira username/email
+                username: 'user.name@company.com', // Your Jira username/email
                 token: 'YOURSECRETTOKEN',     // Replace with your real Jira API token
                 baseUrl: 'https://yourcompany.atlassian.net/rest/api/2/issue/'  // Your Jira instance base URL
             }
@@ -93,7 +93,14 @@ npm install gaunt-sloth-assistant -g
 ```
 
 ## Configuration
-Go to your project directory and init sloth with vendor of your choice.
+
+> Gaunt Sloth currently only functions from the directory which has `.gsloth.config.js` and `.gsloth.preamble.review.md`.
+> Global configuration to invoke gsloth anywhere is in [ROADMAP](../ROADMAP.md).
+
+Configuration can be created with `gsloth init [vendor]` command.
+Currently, vertexai, anthropic and groq can be configured with `gsloth init [vendor]`.
+
+More detailed information on configuration can be found in [CONFIGURATION.md](./docs/CONFIGURATION.md)
 
 ### Google Vertex AI
 ```shell
@@ -117,78 +124,8 @@ gsloth init groq
 ```
 Make sure you either define `GROQ_API_KEY` environment variable or edit `.gsloth.config.js` and set up your key.
 
-### Further configuration
-
-Currently vertexai, anthropic and groq can be configured with `gsloth init`.
-
-Populate `.gsloth.preamble.review.md` with your project details and quality requirements.
-Proper preamble is a paramount for good inference.
-Check [.gsloth.preamble.review.md](.gsloth.preamble.review.md) for example.
-
-### Manual configuration.
-Your project should have the following files in order for gsloth to function:
-- `.gsloth.config.js`
-- `.gsloth.preamble.review.md`
-
-Global configuration to invoke gsloth anywhere is in [ROADMAP](ROADMAP.md).
-
-**Example of .gsloth.config.js for Anthropic**  
-```javascript
-export async function configure(importFunction, global) {
-    // this is going to be imported from sloth dependencies,
-    // but can potentially be pulled from global node modules or from this project
-    // At a moment only google-vertexai and anthropic packaged with Sloth, but you can install support for any other langchain llms
-    const anthropic = await importFunction('@langchain/anthropic');
-    return {
-        llm: new anthropic.ChatAnthropic({
-            apiKey: process.env.ANTHROPIC_API_KEY, // Default value, but you can provide the key in many different ways, even as literal
-            model: "claude-3-5-sonnet-20241022"
-        })
-    };
-}
-```
-
-**Example of .gsloth.config.js for VertexAI**  
-VertexAI usually needs `gcloud auth application-default login`
-(or both `gcloud auth login` and `gcloud auth application-default login`) and does not need any separate API keys.
-```javascript
-export async function configure(importFunction, global) {
-    // this is going to be imported from sloth dependencies,
-    // but can potentially be pulled from global node modules or from this project
-    // At a moment only google-vertexai and anthropic packaged with Sloth, but you can install support for any other langchain llms
-    // Note: for vertex AI you likely to need to do `gcloud auth login`
-    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
-            temperature: 0,
-            //// Other parameters might be relevant depending on Vertex AI API updates.
-            //// The project is not in the interface, but it is in documentation and it seems to work.
-            // project: 'your-cool-google-cloud-project',
-        })
-    }
-}
-```
-
-**Example of .gsloth.config.js for Groq**  
-VertexAI usually needs `gcloud auth application-default login`
-(or both `gcloud auth login` and `gcloud auth application-default login`) and does not need any separate API keys.
-```javascript
-export async function configure(importFunction, global) {
-    // this is going to be imported from sloth dependencies,
-    // but can potentially be pulled from global node modules or from this project
-    const groq = await importFunction('@langchain/groq');
-    return {
-        llm: new groq.ChatGroq({
-            model: "deepseek-r1-distill-llama-70b", // Check other models available
-            apiKey: process.env.GROQ_API_KEY, // Default value, but you can provide the key in many different ways, even as literal
-        })
-    };
-}
-```
-
-The configure function should simply return instance of langchain [chat model](https://v03.api.js.langchain.com/classes/_langchain_core.language_models_chat_models.BaseChatModel.html).
-See [Langchain documentation](https://js.langchain.com/docs/tutorials/llm_chain/) for more details.
+## Building from repo
+See [DEVELOPMENT.md](./docs/DEVELOPMENT.md)
 
 ## License
 License is [MIT](https://opensource.org/license/mit). See [LICENSE](LICENSE)

package/docs/CONFIGURATION.md

@@ -0,0 +1,100 @@
+# Configuration
+
+Populate `.gsloth.preamble.review.md` with your project details and quality requirements.
+Proper preamble is a paramount for good inference.
+Check [.gsloth.preamble.review.md](../.gsloth.preamble.review.md) for example.
+
+Your project should have the following files in order for gsloth to function:
+- `.gsloth.config.js`
+- `.gsloth.preamble.review.md`
+
+> Gaunt Sloth currently only functions from the directory which has `.gsloth.config.js` and `.gsloth.preamble.review.md`.
+> Global configuration to invoke gsloth anywhere is in [ROADMAP](../ROADMAP.md).
+
+## Config initialization
+Configuration can be created with `gsloth init [vendor]` command.
+Currently, vertexai, anthropic and groq can be configured with `gsloth init [vendor]`.
+
+### Google Vertex AI
+```shell
+cd ./your-project
+gsloth init vertexai
+gcloud auth login
+gcloud auth application-default login
+```
+
+### Anthropic
+```shell
+cd ./your-project
+gsloth init anthropic
+```
+Make sure you either define `ANTHROPIC_API_KEY` environment variable or edit `.gsloth.config.js` and set up your key.
+
+### Groq
+```shell
+cd ./your-project
+gsloth init groq
+```
+Make sure you either define `GROQ_API_KEY` environment variable or edit `.gsloth.config.js` and set up your key.
+
+## Examples of configuration for different providers 
+
+**Example of .gsloth.config.js for Anthropic**
+```javascript
+export async function configure(importFunction, global) {
+    // this is going to be imported from sloth dependencies,
+    // but can potentially be pulled from global node modules or from this project
+    // At a moment only google-vertexai and anthropic packaged with Sloth, but you can install support for any other langchain llms
+    const anthropic = await importFunction('@langchain/anthropic');
+    return {
+        llm: new anthropic.ChatAnthropic({
+            apiKey: process.env.ANTHROPIC_API_KEY, // Default value, but you can provide the key in many different ways, even as literal
+            model: "claude-3-5-sonnet-20241022"
+        })
+    };
+}
+```
+
+**Example of .gsloth.config.js for VertexAI**  
+VertexAI usually needs `gcloud auth application-default login`
+(or both `gcloud auth login` and `gcloud auth application-default login`) and does not need any separate API keys.
+```javascript
+export async function configure(importFunction, global) {
+    // this is going to be imported from sloth dependencies,
+    // but can potentially be pulled from global node modules or from this project
+    // At a moment only google-vertexai and anthropic packaged with Sloth, but you can install support for any other langchain llms
+    // Note: for vertex AI you likely to need to do `gcloud auth login`
+    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
+            temperature: 0,
+            //// Other parameters might be relevant depending on Vertex AI API updates.
+            //// The project is not in the interface, but it is in documentation and it seems to work.
+            // project: 'your-cool-google-cloud-project',
+        })
+    }
+}
+```
+
+**Example of .gsloth.config.js for Groq**  
+VertexAI usually needs `gcloud auth application-default login`
+(or both `gcloud auth login` and `gcloud auth application-default login`) and does not need any separate API keys.
+```javascript
+export async function configure(importFunction, global) {
+    // this is going to be imported from sloth dependencies,
+    // but can potentially be pulled from global node modules or from this project
+    const groq = await importFunction('@langchain/groq');
+    return {
+        llm: new groq.ChatGroq({
+            model: "deepseek-r1-distill-llama-70b", // Check other models available
+            apiKey: process.env.GROQ_API_KEY, // Default value, but you can provide the key in many different ways, even as literal
+        })
+    };
+}
+```
+
+## Using other providers
+
+The configure function should simply return instance of langchain [chat model](https://v03.api.js.langchain.com/classes/_langchain_core.language_models_chat_models.BaseChatModel.html).
+See [Langchain documentation](https://js.langchain.com/docs/tutorials/llm_chain/) for more details.

package/{RELEASE-HOWTO.md → docs/RELEASE-HOWTO.md}

@@ -9,7 +9,7 @@ git push --tags
 
 For minor, e.g., from 0.0.8 to 0.1.0
 ```shell
-npm version patch
+npm version minor
 git push
 git push --tags
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gaunt-sloth-assistant",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "",
   "license": "MIT",
   "author": "Andrew Kondratev",

package/src/commands/reviewCommand.js

@@ -105,7 +105,7 @@ export function reviewCommand(program, context) {
             // Get PR diff using the 'gh' provider
             const providerPath = `../providers/${CONTENT_PROVIDERS['gh']}`;
             const {get} = await import(providerPath);
-            content.push(await get(prId));
+            content.push(await get(null, prId));
 
             const {review} = await import('../modules/reviewModule.js');
             await review(`sloth-PR-${prId}-review`, preamble.join("\n"), content.join("\n"));