diff --git a/README.md b/README.md index 64fa3c6..21f42d7 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,29 @@ # ChatGPT NeoVim Plugin -This Plugin should help the user to integrate ChatGPT o1 model into the development workflow with neovim. -It Provides two commands +This plugin helps integrate the ChatGPT O1 model into the development workflow with Neovim. +It provides one main interactive command: `:ChatGPT`. ## :ChatGPT -This command will ask the user for a prompt. -It will then gather the following context: -- The project structure based on the git which the currently open file belongs to. -- The README.md file content if it exists in the top folder of the project structure. -- The currently open file content. -It also appends to the prompt that every file should be in a code block and the first line of the block -should always just contain the file path for the file and nothing else. Regardless if it would destroy the code. +**Workflow:** -The generated prompt for the ChatGPT o1 model, will than be copied to the clipboard and the user will be asked -to paste it into the website of ChatGPT. +1. **Initial Prompt:** + When you run `:ChatGPT`, the plugin asks you for a prompt. After entering the prompt, it gathers context: + - The project structure based on the git repository of the currently open file. + - The `README.md` file content if it exists at the project root. + - The currently open file’s content. -## :ChatGPTPaste -This command will look if the clipboard contains a response where the first line is a filepath. -It then creates the file and pastes the rest of the response as content into the file. + It then constructs a combined prompt and automatically copies it to your system clipboard. You will be instructed to paste this prompt into the ChatGPT O1 model’s website. + +2. **Pasting Prompt into ChatGPT:** + Switch to your browser, paste the prompt into ChatGPT’s interface, and submit it. ChatGPT will return one or multiple code blocks. Each code block should start with the file path on the first line, followed by the code. + +3. **Interactive File Pasting:** + Return to Neovim. After pressing ``, the plugin enters an interactive mode: + - It will prompt you to copy the file path (the first line of the returned code block) into your clipboard and press ``. + - Once you do that, it will store that file path. + - Next, it will ask you to copy the file content (the rest of the returned code block) to your clipboard and press `` again. + - The plugin will then write the pasted content into the file specified by the previously stored path. + - After this file is processed, it asks if you want to paste another file. Press `y` to process another file (repeat the steps above) or `n` to finish. + +By following this interactive workflow, you can iteratively apply all changes suggested by ChatGPT O1 model directly into your project files without leaving Neovim. diff --git a/lua/chatgpt_nvim/context.lua b/lua/chatgpt_nvim/context.lua index 0ddeb36..226d454 100644 --- a/lua/chatgpt_nvim/context.lua +++ b/lua/chatgpt_nvim/context.lua @@ -21,7 +21,6 @@ function M.get_project_structure() end end - -- Fallback if not in a git repo local dhandle = io.popen("find . -type f") if dhandle then local dresult = dhandle:read("*a") @@ -32,26 +31,21 @@ function M.get_project_structure() return "No files found." end --- Helper to find the git root directory local function get_git_root() local handle = io.popen("git rev-parse --show-toplevel 2>/dev/null") if handle then local root = handle:read("*l") handle:close() - if root and root ~= "" then - return root - end + return root end return nil end --- Attempt to read README.md from the root of the git repository function M.get_readme_content() local root = get_git_root() if not root then return nil end - local readme_path = root .. "/README.md" local f = io.open(readme_path, "r") if f then diff --git a/lua/chatgpt_nvim/handler.lua b/lua/chatgpt_nvim/handler.lua index b159a7c..7a6cb34 100644 --- a/lua/chatgpt_nvim/handler.lua +++ b/lua/chatgpt_nvim/handler.lua @@ -1,39 +1,13 @@ local M = {} --- paste_code_from_clipboard: --- The user copies a code block from the website (which includes a first line with the file path), --- and then runs :ChatGPTPaste. --- We retrieve the clipboard content, extract the first line as a path, and the rest as code. -function M.paste_code_from_clipboard() - local clipboard_content = vim.fn.getreg('+') - if clipboard_content == "" then - vim.api.nvim_err_writeln("Clipboard is empty. Copy the code block from the website first.") - return - end - - local lines = {} - for line in clipboard_content:gmatch("[^\r\n]+") do - table.insert(lines, line) - end - - if #lines == 0 then - vim.api.nvim_err_writeln("No content in clipboard to parse.") - return - end - - local filepath = lines[1] - local code_lines = {} - for i = 2, #lines do - table.insert(code_lines, lines[i]) - end - - local code = table.concat(code_lines, "\n") - M.write_file(filepath, code) - print("Wrote file: " .. filepath) +-- Retrieves clipboard content and trims trailing whitespace/newlines +function M.get_clipboard_content() + local content = vim.fn.getreg('+') + content = content:gsub("%s+$", "") + return content end function M.write_file(filepath, content) - -- Create directories if needed local dir = filepath:match("(.*/)") if dir and dir ~= "" then vim.fn.mkdir(dir, "p") @@ -48,4 +22,8 @@ function M.write_file(filepath, content) end end +function M.finish() + print("All files processed. You can now continue working.") +end + return M diff --git a/lua/chatgpt_nvim/init.lua b/lua/chatgpt_nvim/init.lua index 584f0eb..846c843 100644 --- a/lua/chatgpt_nvim/init.lua +++ b/lua/chatgpt_nvim/init.lua @@ -1,39 +1,89 @@ local M = {} local context = require('chatgpt_nvim.context') +local handler = require('chatgpt_nvim.handler') function M.run_chatgpt_command() - vim.schedule(function() - -- Prompt the user for input - local user_input = vim.fn.input("Message for O1 Model: ") - if user_input == "" then - print("No input provided.") - return + -- Prompt the user for input + local user_input = vim.fn.input("Message for O1 Model: ") + if user_input == "" then + print("No input provided.") + return + end + + local project_structure = context.get_project_structure() + local current_file_content, current_file_path = context.get_current_file() + local readme_content = context.get_readme_content() + + local sections = { + "Following you will get instructions for a development project. First you get a prompt of the user which starts with \"<< once you've pasted the prompt into the website and have the first file ready to copy.") + vim.fn.input("") -- wait for user to press Enter + + while true do + -- Ask user for filepath + local filepath = "" + while true do + print("Please copy the FILE PATH (the first line of the code block) to your clipboard.") + print("Press when done.") + vim.fn.input("") -- Wait for user confirmation + filepath = handler.get_clipboard_content() + if filepath == "" then + vim.api.nvim_err_writeln("Clipboard is empty. Please copy the file path and try again.") + else + print("Got file path: " .. filepath) + break + end end - local project_structure = context.get_project_structure() - local current_file_content, current_file_path = context.get_current_file() - local readme_content = context.get_readme_content() - - local sections = { - "User Message:\n" .. user_input, - "\nProject Structure:\n" .. project_structure, - "\nCurrent File:\nPath: " .. current_file_path .. "\n" .. current_file_content, - "\nInstructions:\nPlease return code blocks for the changes. Each code block must start with the file path on the first line, followed by the code.", - "Do not comment out the file path. Just plain text.", - "If multiple files are needed, return multiple code blocks each starting with a file path." - } - - if readme_content then - table.insert(sections, "\nREADME Content:\n" .. readme_content) + -- Ask user for file content + local filecontent = "" + while true do + print("Now copy the FILE CONTENT (everything after the first line) to your clipboard.") + print("Press when done.") + vim.fn.input("") -- Wait for user confirmation + filecontent = handler.get_clipboard_content() + if filecontent == "" then + vim.api.nvim_err_writeln("Clipboard is empty. Please copy the file content and try again.") + else + break + end end - local prompt = table.concat(sections, "\n") + handler.write_file(filepath, filecontent) + print("Wrote file: " .. filepath) - -- Copy prompt to clipboard so user can paste it into the website form. - vim.fn.setreg('+', prompt) - print("Prompt (including README if found) copied to clipboard! Paste it into the website form.") - end) + local another = vim.fn.input("Do you want to paste another file? (y/n): ") + if another:lower() ~= "y" then + handler.finish() + break + end + end end return M diff --git a/plugin/chatgpt.vim b/plugin/chatgpt.vim index 1ad2087..eec3a61 100644 --- a/plugin/chatgpt.vim +++ b/plugin/chatgpt.vim @@ -1,3 +1,2 @@ -" Defines the commands for the plugin +" Defines the :ChatGPT command command! ChatGPT lua require('chatgpt_nvim').run_chatgpt_command() -command! ChatGPTPaste lua require('chatgpt_nvim.handler').paste_code_from_clipboard()