cloving 0.3.11 → 0.3.12

package/dist/managers/CodeManager.js

@@ -5,14 +5,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const prompts_1 = require("@inquirer/prompts");
 const cli_highlight_1 = __importDefault(require("cli-highlight"));
+const colors_1 = __importDefault(require("colors"));
 const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const config_utils_1 = require("../utils/config_utils");
 const prompt_utils_1 = require("../utils/prompt_utils");
 const string_utils_1 = require("../utils/string_utils");
-class CodeManager {
+const prompts_2 = require("../utils/prompts");
+const StreamManager_1 = __importDefault(require("./StreamManager"));
+class CodeManager extends StreamManager_1.default {
     constructor(options) {
-        this.options = options;
-        this.contextFiles = {};
-        this.chatHistory = [];
+        super(options);
+        options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+        options.stream = true;
         this.gpt = new cloving_gpt_1.default(options);
     }
     async initialize() {
@@ -26,7 +30,7 @@ class CodeManager {
                 let includeMoreFiles = true;
                 while (includeMoreFiles) {
                     const contextFile = await (0, prompts_1.input)({
-                        message: `Enter the relative path of a file or directory you would like to include as context (or press enter to continue):`,
+                        message: `Enter the relative path of a file or directory you would like to include as context (or press enter to continue): `,
                     });
                     if (contextFile) {
                         this.contextFiles = await (0, prompt_utils_1.addFileOrDirectoryToContext)(contextFile, this.contextFiles, this.options);
@@ -42,26 +46,7 @@ class CodeManager {
                 });
                 this.options.prompt = userPrompt;
             }
-            let response = await this.generateCode(this.options.prompt);
-            const currentNewBlocks = (0, string_utils_1.extractCurrentNewBlocks)(response);
-            const [canApply, summary] = await (0, string_utils_1.checkBlocksApplicability)(currentNewBlocks);
-            if (!canApply) {
-                console.log('The generated code could not be automatically applied. It will try again asking for more details.');
-                console.log(`Some of the provided code blocks could not be applied,
-please match the existing code with a few more lines of context and make sure it is a character for character exact match.
-
-${summary}`);
-                response = await this.generateCode(this.options.prompt);
-                this.displayGeneratedCode(response);
-            }
-            this.displayGeneratedCode(response);
-            if (this.options.save) {
-                const currentNewBlocks = (0, string_utils_1.extractCurrentNewBlocks)(response);
-                await (0, string_utils_1.applyAndSaveCurrentNewBlocks)(currentNewBlocks);
-            }
-            else {
-                await this.handleUserAction(response, this.options.prompt);
-            }
+            await this.generateCode(this.options.prompt);
         }
         catch (err) {
             const error = err;
@@ -69,35 +54,26 @@ ${summary}`);
         }
     }
     async generateCode(userPrompt) {
+        await this.checkForLatestVersion();
+        await this.loadContextFiles();
         if (this.chatHistory.length === 0) {
-            const systemPrompt = (0, prompt_utils_1.generateCodegenPrompt)(this.contextFiles);
-            this.chatHistory.push({ role: 'user', content: systemPrompt });
-            this.chatHistory.push({ role: 'assistant', content: 'What would you like to do?' });
+            this.addUserPrompt((0, prompt_utils_1.generateCodegenPrompt)(this.contextFiles));
+            this.addAssistantResponse('What would you like to do?');
+        }
+        this.addUserPrompt(userPrompt);
+        try {
+            const responseStream = await this.gpt.streamText({
+                prompt: userPrompt,
+                messages: this.chatHistory,
+            });
+            this.handleResponseStream(responseStream);
+        }
+        catch (err) {
+            const error = err;
+            console.error('Error streaming response:', error.message);
         }
-        this.chatHistory.push({ role: 'user', content: userPrompt });
-        return await this.gpt.generateText({ prompt: userPrompt, messages: this.chatHistory });
-    }
-    displayGeneratedCode(rawCodeCommand) {
-        (0, string_utils_1.parseMarkdownInstructions)(rawCodeCommand).map((code) => {
-            if (code.trim().startsWith('```')) {
-                const lines = code.split('\n');
-                const language = code.match(/```(\w+)/)?.[1] || 'plaintext';
-                console.log(lines[0]);
-                try {
-                    console.log((0, cli_highlight_1.default)(lines.slice(1, -1).join('\n'), { language }));
-                }
-                catch (error) {
-                    // don't highlight if it fails
-                    console.log(lines.slice(1, -1).join('\n'));
-                }
-                console.log(lines.slice(-1)[0]);
-            }
-            else {
-                console.log((0, cli_highlight_1.default)(code, { language: 'markdown' }));
-            }
-        });
     }
-    async handleUserAction(response, prompt) {
+    async handleUserAction(response) {
         const currentNewBlocks = (0, string_utils_1.extractCurrentNewBlocks)(response);
         const files = Array.from(new Set(currentNewBlocks.map((block) => block.filePath)));
         if (this.options.save) {
@@ -133,9 +109,7 @@ ${summary}`);
                         includeMoreFiles = false;
                     }
                 }
-                const newResponse = await this.generateCode(newPrompt);
-                this.displayGeneratedCode(newResponse);
-                await this.handleUserAction(newResponse, newPrompt);
+                await this.generateCode(newPrompt);
                 break;
             case 'explain':
                 const explainPrompt = this.generateExplainCodePrompt(response);
@@ -163,7 +137,7 @@ ${summary}`);
                 break;
             case 'saveAll':
                 await (0, string_utils_1.applyAndSaveCurrentNewBlocks)(currentNewBlocks);
-                console.log('All files have been saved.');
+                console.log(colors_1.default.green('\nAll files have been saved.'));
                 break;
             case 'done':
                 break;
@@ -176,5 +150,34 @@ ${summary}`);
 
 Please briefly explain how the code works in this.`;
     }
+    /**
+     * Finalizes the response processing.
+     * This method should be overridden to provide specific finalization behavior.
+     * @protected
+     */
+    async finalizeResponse() {
+        this.addAssistantResponse(this.responseString);
+        this.isProcessing = false;
+        if (this.responseString !== '') {
+            const currentNewBlocks = (0, string_utils_1.extractCurrentNewBlocks)(this.responseString);
+            const [canApply, summary] = await (0, string_utils_1.checkBlocksApplicability)(currentNewBlocks);
+            if (!canApply) {
+                if (this.retryCount < this.maxRetries) {
+                    console.log(`\n\n${summary}\n\n${colors_1.default.yellow.bold('WARNING')} Some of the provided code blocks could not be automatically applied. Retrying (Attempt ${this.retryCount + 1}/${this.maxRetries})...\n`);
+                    this.retryCount++;
+                    this.generateCode(`${prompts_2.CODEGEN_COULDNT_APPLY}\n\n${summary}`);
+                    return;
+                }
+                else {
+                    console.log(`\n\n${colors_1.default.red.bold('ERROR')} Failed to generate a diff that could be cleanly applied after ${this.maxRetries} attempts. Please review the changes manually and try again.\n`);
+                    this.retryCount = 0; // Reset the retry count for future attempts
+                }
+            }
+            else {
+                this.retryCount = 0; // Reset the retry count on successful application
+            }
+        }
+        this.handleUserAction(this.responseString);
+    }
 }
 exports.default = CodeManager;

package/dist/managers/CommitManager.js

@@ -15,7 +15,7 @@ class CommitManager {
         options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
         this.gpt = new cloving_gpt_1.default(options);
     }
-    async commit() {
+    async generateCommit() {
         try {
             // Get the git diff
             const diff = (0, child_process_1.execSync)('git diff HEAD').toString().trim();

package/dist/managers/DocsManager.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const prompts_1 = require("@inquirer/prompts");
+const colors_1 = __importDefault(require("colors"));
+const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
+const config_utils_1 = require("../utils/config_utils");
+const prompts_2 = require("../utils/prompts");
+const prompt_utils_1 = require("../utils/prompt_utils");
+const string_utils_1 = require("../utils/string_utils");
+const StreamManager_1 = __importDefault(require("./StreamManager"));
+/**
+ * Manages the generation of documentation for specified files.
+ */
+class DocsManager extends StreamManager_1.default {
+    /**
+     * Creates a new DocumentationManager instance.
+     * @param {ClovingGPTOptions} options - Configuration options for the DocumentationManager.
+     */
+    constructor(options) {
+        super(options);
+        options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
+        options.stream = true;
+        this.gpt = new cloving_gpt_1.default(options);
+    }
+    /**
+     * Generates documentation for the specified files.
+     * @returns {Promise<void>}
+     */
+    async generateDocs(extraPrompt) {
+        try {
+            this.isProcessing = true;
+            if (this.retryCount === 0) {
+                await this.checkForLatestVersion();
+            }
+            await this.loadContextFiles();
+            this.addUserPrompt(`${(0, prompt_utils_1.generateDocsPrompt)(this.contextFiles)}\n\n${extraPrompt || ''}`);
+            const responseStream = await this.gpt.streamText({
+                prompt: this.prompt,
+                messages: this.chatHistory,
+            });
+            this.handleResponseStream(responseStream);
+        }
+        catch (error) {
+            console.error(colors_1.default.red('Error generating documentation:'), error);
+        }
+    }
+    /**
+     * Finalizes the response processing.
+     * This method should be overridden to provide specific finalization behavior.
+     * @protected
+     */
+    async finalizeResponse() {
+        this.addAssistantResponse(this.responseString);
+        this.isProcessing = false;
+        if (this.responseString !== '') {
+            const currentNewBlocks = (0, string_utils_1.extractCurrentNewBlocks)(this.responseString);
+            const [canApply, summary] = await (0, string_utils_1.checkBlocksApplicability)(currentNewBlocks);
+            if (canApply && currentNewBlocks.length > 0) {
+                const shouldSave = await (0, prompts_1.confirm)({
+                    message: '\n\nDo you want to save the generated documentation?',
+                    default: true,
+                });
+                if (shouldSave) {
+                    await (0, string_utils_1.applyAndSaveCurrentNewBlocks)(currentNewBlocks);
+                    console.log(colors_1.default.green('\nDocumentation has been saved to the respective files.'));
+                }
+            }
+            else {
+                if (this.retryCount < this.maxRetries) {
+                    console.log(`\n\n${summary}\n\n${colors_1.default.yellow.bold('WARNING')} Some of the provided code blocks could not be automatically applied. Retrying (Attempt ${this.retryCount + 1}/${this.maxRetries})...\n`);
+                    this.retryCount++;
+                    this.generateDocs(`\n\n${prompts_2.CODEGEN_COULDNT_APPLY}\n\n${summary}`);
+                    return;
+                }
+                else {
+                    console.log(`\n\n${colors_1.default.red.bold('ERROR')} Failed to generate a diff that could be cleanly applied after ${this.maxRetries} attempts. Please review the changes manually and try again.\n`);
+                    this.retryCount = 0; // Reset the retry count for future attempts
+                }
+            }
+        }
+    }
+}
+exports.default = DocsManager;

package/dist/managers/DocumentationManager.js

@@ -9,6 +9,7 @@ const cli_highlight_1 = __importDefault(require("cli-highlight"));
 const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 const config_utils_1 = require("../utils/config_utils");
 const prompt_utils_1 = require("../utils/prompt_utils");
+const prompts_2 = require("../utils/prompts");
 const string_utils_1 = require("../utils/string_utils");
 /**
  * Manages the generation of documentation for specified files.
@@ -33,7 +34,7 @@ class DocumentationManager {
         try {
             await this.loadContextFiles();
             if (this.chatHistory.length === 0) {
-                this.chatHistory.push({ role: 'user', content: prompt_utils_1.CODEGEN_INSTRUCTIONS });
+                this.chatHistory.push({ role: 'user', content: prompts_2.CODEGEN_INSTRUCTIONS });
                 this.chatHistory.push({ role: 'assistant', content: 'What would you like to do?' });
             }
             const prompt = this.generateDocumentationPrompt();

package/dist/managers/InitManager.js

@@ -14,6 +14,7 @@ const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 const string_utils_1 = require("../utils/string_utils");
 const config_utils_1 = require("../utils/config_utils");
 const prompt_utils_1 = require("../utils/prompt_utils");
+const prompts_2 = require("../utils/prompts");
 class InitManager {
     constructor(options) {
         this.options = options;
@@ -22,7 +23,7 @@ class InitManager {
         this.gpt = new cloving_gpt_1.default(this.options);
         this.chatHistory.push({
             role: 'system',
-            content: prompt_utils_1.INIT_INSTRUCTIONS,
+            content: prompts_2.INIT_INSTRUCTIONS,
         });
     }
     /**

package/dist/managers/ReviewManager.js

@@ -3,181 +3,31 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_highlight_1 = __importDefault(require("cli-highlight"));
-const prompts_1 = require("@inquirer/prompts");
 const copy_paste_1 = __importDefault(require("copy-paste"));
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
+const colors_1 = __importDefault(require("colors"));
+const prompts_1 = require("@inquirer/prompts");
 const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 const git_utils_1 = require("../utils/git_utils");
-const string_utils_1 = require("../utils/string_utils");
 const prompt_utils_1 = require("../utils/prompt_utils");
 const config_utils_1 = require("../utils/config_utils");
-class ReviewManager {
+const StreamManager_1 = __importDefault(require("./StreamManager"));
+class ReviewManager extends StreamManager_1.default {
     constructor(options) {
-        this.contextFiles = {};
-        this.chatHistory = [];
+        super(options);
         options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
-        this.options = options;
+        options.stream = true;
         this.gpt = new cloving_gpt_1.default(options);
     }
-    /**
-     * Loads the context files specified in the options. If directories are provided,
-     * it expands them to include all files within. The contents of each file are
-     * stored in the `contextFiles` object for later use.
-     */
-    async loadContextFiles() {
-        if (this.options.files) {
-            let expandedFiles = [];
-            for (const file of this.options.files) {
-                const filePath = path_1.default.resolve(file);
-                if (await fs_1.default.promises
-                    .stat(filePath)
-                    .then((stat) => stat.isDirectory())
-                    .catch(() => false)) {
-                    const dirFiles = await (0, prompt_utils_1.getAllFilesInDirectory)(filePath);
-                    expandedFiles = expandedFiles.concat(dirFiles.map((f) => path_1.default.relative(process.cwd(), f)));
-                }
-                else {
-                    expandedFiles.push(path_1.default.relative(process.cwd(), filePath));
-                }
-            }
-            this.options.files = expandedFiles;
-            for (const file of this.options.files) {
-                const filePath = path_1.default.resolve(file);
-                if (await fs_1.default.promises
-                    .stat(filePath)
-                    .then((stat) => stat.isFile())
-                    .catch(() => false)) {
-                    const content = await fs_1.default.promises.readFile(filePath, 'utf-8');
-                    this.contextFiles[file] = content;
-                }
-            }
-        }
-    }
-    /**
-     * Generates a review prompt based on the current chat history and options.
-     * If no chat history exists, it initializes it with a system prompt and a request
-     * for user input. The prompt includes a structured example response for code review.
-     *
-     * @returns {string} The generated review prompt.
-     */
-    generateReviewPrompt() {
-        if (this.chatHistory.length === 0) {
-            let systemPrompt = `### Example of a well-structured response
-
-    # Code Review: Enhanced Code Generation and File Handling
-
-    ## Changes Overview
-
-    These changes primarily focus on improving the code generation process and adding more robust file handling capabilities. The main modifications include:
-
-    1. Enhancing the code generation prompt with a structured example response.
-    2. Implementing a new function to extract file names and contents from the generated code.
-    3. Adding a new option to save generated code directly to files.
-    4. Improving the copy-to-clipboard functionality to allow copying individual files.
-    5. Removing an unused import in the review.ts file.
-
-    ## Reason for Changes
-
-    The changes aim to enhance the usability and flexibility of the code generation tool by providing clearer prompts, better file management, and more control over the generated code.
-
-    ## Detailed Description
-
-    1. **Enhanced Code Generation Prompt** - The \`generateCodePrompt\` function now includes a structured example of a well-formatted response. This helps guide the AI to produce more consistent and usable output, making it easier to parse and use the generated code.
-    2. **File Extraction Function** - A new function \`extractFilesAndContent\` has been added to parse the raw code command and extract individual file names and their contents. This enables more granular control over the generated code, allowing for file-specific operations.
-    3. **Save to File Option** - A new 'Save Source Code to Files' option has been added to the user action menu. This feature allows users to save generated code directly to files in the appropriate directory structure.
-    4. **Improved Copy to Clipboard** - The 'Copy Source Code to Clipboard' option has been enhanced to allow users to choose specific files to copy, rather than copying all generated code at once.
-    5. **Removed Unused Import** - The unused import of \`execFileSync\` from 'child_process' has been removed from the review.ts file, improving code cleanliness.
-
-    ## Potential Bugs and Recommended Fixes
-
-    ### 1. Possible undefined access in \`extractFilesAndContent\`
-
-    \`\`\`typescript
-    const contentMatch = regex.exec(rawCodeCommand)
-    if (contentMatch) {
-      files.push(fileName)
-      let content = contentMatch[1]
-      // ...
-    }
-    \`\`\`
-
-    There's a potential for \`contentMatch[1]\` to be undefined if the regex doesn't capture any groups. To fix this, add a null check:
-
-    \`\`\`typescript
-    const contentMatch = regex.exec(rawCodeCommand)
-    if (contentMatch && contentMatch[1]) {
-      files.push(fileName)
-      let content = contentMatch[1]
-      // ...
-    }
-    \`\`\`
-
-`;
-            if (this.options.files) {
-                const contextFileContents = Object.keys(this.contextFiles)
-                    .map((file) => `### Contents of ${file}\n\n${this.contextFiles[file]}\n\n`)
-                    .join('\n');
-                systemPrompt += `### Description of App
-
-${JSON.stringify((0, config_utils_1.getClovingConfig)(), null, 2)}
-
-${contextFileContents}
-
-### Request
-
-I would like you to explain the code and document a description of it.
-List any bugs in the new code as well as recommended fixes for those bugs with code examples.
-Format the output of this code review in Markdown format.`;
-            }
-            else {
-                systemPrompt += `### Request
-
-Do not use any data from the example response structure, only use the structure.
-I would like you to explain why these change are being made and document a description of these changes.
-Also list any bugs in the new code as well as recommended fixes for those bugs with code examples.
-Format the output of this code review in Markdown format.`;
-            }
-            this.chatHistory.push({ role: 'user', content: systemPrompt });
-            this.chatHistory.push({ role: 'assistant', content: 'What would you like to do?' });
-        }
-        this.chatHistory.push({
-            role: 'user',
-            content: this.options.prompt || 'Please provide a code review.',
-        });
-        return this.options.prompt || 'Please provide a code review.';
-    }
     async getGitDiffPrompt() {
         const gitDiff = await (0, git_utils_1.getGitDiff)();
-        this.options.prompt = `## Diff Content
+        return `${(0, prompt_utils_1.generateReviewPrompt)(this.options, this.contextFiles)}
+
+## Diff Content
 ${gitDiff}
 
 # Task
 
 ${this.options.prompt || 'Please provide a code review.'}`;
-        const prompt = this.generateReviewPrompt();
-        return prompt;
-    }
-    displayAnalysis(analysis) {
-        (0, string_utils_1.parseMarkdownInstructions)(analysis).map((code) => {
-            if (code.trim().startsWith('```')) {
-                const lines = code.split('\n');
-                const language = code.match(/```(\w+)/)?.[1] || 'plaintext';
-                console.log(lines[0]);
-                try {
-                    console.log((0, cli_highlight_1.default)(lines.slice(1, -1).join('\n'), { language }));
-                }
-                catch (error) {
-                    // don't highlight if it fails
-                    console.log(lines.slice(1, -1).join('\n'));
-                }
-                console.log(lines.slice(-1)[0]);
-            }
-            else {
-                console.log((0, cli_highlight_1.default)(code, { language: 'markdown' }));
-            }
-        });
     }
     async handleUserAction(analysis) {
         const extractSection = (section) => {
@@ -215,27 +65,67 @@ ${this.options.prompt || 'Please provide a code review.'}`;
         if (contentToCopy) {
             copy_paste_1.default.copy(contentToCopy, (err) => {
                 if (err) {
-                    console.error('Error: Unable to copy to clipboard.', err);
+                    console.error(colors_1.default.red('Error: Unable to copy to clipboard.'), err);
                 }
                 else {
-                    console.log('Selected content copied to clipboard');
+                    console.log(colors_1.default.green('Selected content copied to clipboard'));
                 }
             });
         }
     }
-    async review() {
+    async generateReview(extraPrompt) {
         try {
+            await this.checkForLatestVersion();
             await this.loadContextFiles();
-            const prompt = this.options.files
-                ? this.generateReviewPrompt()
-                : await this.getGitDiffPrompt();
-            const analysis = await this.gpt.generateText({ prompt, messages: this.chatHistory });
-            this.displayAnalysis(analysis);
-            await this.handleUserAction(analysis);
+            if (this.options.files) {
+                if (this.chatHistory.length === 0) {
+                    this.addUserPrompt(`${(0, prompt_utils_1.generateReviewPrompt)(this.options, this.contextFiles)}`);
+                    this.addAssistantResponse('What would you like to do?');
+                }
+                this.addUserPrompt(`${this.options.prompt || 'Please provide a code review.'}\n\n${extraPrompt || ''}`);
+            }
+            else {
+                if (this.chatHistory.length === 0) {
+                    this.addUserPrompt(await this.getGitDiffPrompt());
+                    this.addAssistantResponse('What would you like to do?');
+                }
+                this.addUserPrompt(`${this.options.prompt || 'Please provide a code review.'}\n\n${extraPrompt || ''}`);
+            }
+            const responseStream = await this.gpt.streamText({
+                prompt: this.prompt,
+                messages: this.chatHistory,
+            });
+            this.handleResponseStream(responseStream);
         }
         catch (error) {
-            console.error('Error during analysis:', error.message);
+            this.handleError(error);
         }
     }
+    handleError(error) {
+        let errorMessage = error.message || 'An error occurred.';
+        const errorNumber = error.response?.status || 'unknown';
+        switch (errorNumber) {
+            case 400:
+                errorMessage = 'Invalid model or prompt size too large. Try specifying fewer files.';
+                break;
+            case 403:
+                errorMessage = 'Inactive subscription or usage limit reached';
+                break;
+            case 429:
+                errorMessage = 'Rate limit error';
+                break;
+            case 500:
+                errorMessage = 'Internal server error';
+                break;
+        }
+        const statusMessage = error.response?.data?.statusMessage;
+        console.error(colors_1.default.red(`\nError (${errorNumber}) while submitting the prompt to the AI API\n\n${statusMessage}\n`));
+        this.isProcessing = false;
+    }
+    async finalizeResponse() {
+        this.addAssistantResponse(this.responseString);
+        this.isProcessing = false;
+        await this.handleUserAction(this.responseString);
+    }
 }
 exports.default = ReviewManager;

package/dist/managers/ShellManager.js

@@ -11,13 +11,26 @@ const cloving_gpt_1 = __importDefault(require("../cloving_gpt"));
 const prompt_utils_1 = require("../utils/prompt_utils");
 const string_utils_1 = require("../utils/string_utils");
 const config_utils_1 = require("../utils/config_utils");
+/**
+ * ShellManager class for handling shell script generation and execution.
+ */
 class ShellManager {
+    /**
+     * Creates an instance of ShellManager.
+     * @param {ClovingGPTOptions} options - The options for ClovingGPT.
+     */
     constructor(options) {
         this.options = options;
         this.chatHistory = [];
         options.silent = (0, config_utils_1.getConfig)(options).globalSilent || false;
         this.gpt = new cloving_gpt_1.default(options);
     }
+    /**
+     * Generates a prompt to explain a shell script.
+     * @param {string} prompt - The original shell script prompt.
+     * @returns {string} The prompt for explaining the shell script.
+     * @private
+     */
     generateExplainShellPrompt(prompt) {
         return `${prompt}
 
@@ -25,6 +38,12 @@ class ShellManager {
 
 Please briefly explain how this shell script works.`;
     }
+    /**
+     * Generates a shell script based on the given prompt.
+     * @param {string} prompt - The user's prompt for generating a shell script.
+     * @returns {Promise<string>} A promise that resolves to the generated shell script.
+     * @private
+     */
     async generateShell(prompt) {
         if (this.chatHistory.length === 0) {
             const systemPrompt = (0, prompt_utils_1.generateShellPrompt)();
@@ -34,11 +53,23 @@ Please briefly explain how this shell script works.`;
         this.chatHistory.push({ role: 'user', content: prompt });
         return await this.gpt.generateText({ prompt, messages: this.chatHistory });
     }
+    /**
+     * Displays the generated shell script with syntax highlighting.
+     * @param {string} rawShellCommand - The raw shell command to display.
+     * @private
+     */
     displayGeneratedShell(rawShellCommand) {
         const generatedShell = (0, string_utils_1.extractMarkdown)(rawShellCommand);
         const generatedShellWithoutShebang = generatedShell.replace(/^#!.*?\s/, '');
         console.log((0, cli_highlight_1.default)(generatedShellWithoutShebang));
     }
+    /**
+     * Handles user actions after generating a shell script.
+     * @param {string} response - The generated shell script.
+     * @param {string} prompt - The original user prompt.
+     * @returns {Promise<void>}
+     * @private
+     */
     async handleUserAction(response, prompt) {
         let { exec } = this.options;
         this.chatHistory.push({ role: 'assistant', content: response });
@@ -94,6 +125,24 @@ Please briefly explain how this shell script works.`;
                 break;
         }
     }
+    /**
+     * Generates a shell script based on user input and handles subsequent user actions.
+     *
+     * This method is the main entry point for generating and interacting with shell scripts.
+     * It performs the following steps:
+     * 1. Obtains a user prompt (either from options or by asking the user).
+     * 2. Generates a shell script based on the prompt.
+     * 3. Displays the generated script with syntax highlighting.
+     * 4. Handles user actions (execute, revise, explain, copy, or cancel) for the generated script.
+     *
+     * @returns {Promise<void>} A promise that resolves when the generation and handling process is complete.
+     * @throws {Error} If there's an issue during the shell script generation process.
+     * @public
+     *
+     * @example
+     * const shellManager = new ShellManager(options);
+     * await shellManager.generateAndHandleShell();
+     */
     async generateAndHandleShell() {
         let { prompt: userPrompt } = this.options;
         try {