diff --git a/README.md b/README.md index 5590051..f752b01 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,15 @@ Automated git commit messages using GPT models via [gptcommit][1] for VS Code. Note: Do NOT install `gptcommit` hook via `gptcommit install` under the root of your git repo. +## Supported Versions + +| Extension Version | VS Code Version | gptcommit Version | +| ----------------- | --------------- | ----------------- | +| < 0.1.0 | 1.75+ | 0.1.16 | +| 0.1.x | 1.70+ | 0.1.16 | +| 0.2.x | 1.70+ | 0.3.0 | +| 0.3.x | 1.70+ | 0.5.x | + ## Commands Run via `Ctrl+Shift+P` or `Cmd+Shift+P`: @@ -21,13 +30,26 @@ Run via `Ctrl+Shift+P` or `Cmd+Shift+P`: - `GPTCommit: Setup OpenAI API Key` Setup the OpenAI API Key. You can get the API key from [OpenAI][3] -- `GPTCommit: Try a different OpenAI model` - Try a different OpenAI model. For a list of public OpenAI models, checkout the [OpenAI docs][4]. +- `GPTCommit: Use a different OpenAI model` + Use a different OpenAI model. For a list of public OpenAI models, checkout the [OpenAI docs][4]. Default is now `gpt-3.5-turbo`. + +- `GPTCommit: Set output language` + Set the output language. Default is `en`. + +- `GPTCommit: Show per-file summary` + Enable "show per-file summary"? It's disabled by default. + +- `GPTCommit: Disable conventional commit` + Disable "conventional commit"? It's enabled by default. + +- `GPTCommit: Open gptcommit configuration file` + Open the local gptcommit configuration file (~/.git/gptcommit.toml) ## Extension Settings - `ExpressMode`: If true, generated message will be filled into the Source Control commit message input box directly, instead of opening a new editor. - `ExpressModeContent`: Content of the message to fill in the express mode. + - Note that to show per-file summary, you need to enable "show per-file summary" by running the `GPTCommit: Show per-file summary` command. - `GptcommitPath`: Path to the `gptcommit` executable. - `OnFiles`: Diff of files to use for generating the commit message. - `staged`: Use staged files @@ -36,7 +58,9 @@ Run via `Ctrl+Shift+P` or `Cmd+Shift+P`: ## Advanced configuration -The configuration is saved at `~/.config/gptcommit/config.json`. You can edit it manually, but it's recommended to use commands inside VS Code to edit the configuration, unless you know what you are doing. +Note that now all the configuration via the extension is saved in the `.git/gptcommit.toml` file. If you have to change advanced configuration, you can edit the `.git/gptcommit.toml` file directly, but make sure you know what you are doing. You can also use the `GPTCommit: Open gptcommit configuration file` command to open the configuration file. + +If you want to use the configuration globally, you can copy the `.git/gptcommit.toml` file to `~/.config/gptcommit/config.toml`, or just the sections of the configuration you want to be used globally. Also refer to the [gptcommit][1] documentation for more information. diff --git a/package.json b/package.json index 7b2dd48..148ad48 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "gptcommit", "displayName": "vscode-gptcommit", "description": "Automated git commit messages using GPT models", - "version": "0.1.1", + "version": "0.3.0", "repository": { "url": "https://github.com/pwwang/vscode-gptcommit" }, @@ -23,7 +23,8 @@ "activationEvents": [ "onCommand:gptcommit.generateGitCommitMessage", "onCommand:gptcommit.setupOpenAIApiKey", - "onCommand:gptcommit.tryDifferentOpenAIModel" + "onCommand:gptcommit.useDifferentModel", + "onCommand:gptcommit.setOutputLanguage" ], "main": "./out/extension.js", "contributes": { @@ -31,15 +32,32 @@ { "command": "gptcommit.generateGitCommitMessage", "title": "GPTCommit: Generate Git Commit Message", - "icon": "$(output)" + "icon": "$(output)", + "enablement": "!gptcommit.generating" }, { "command": "gptcommit.setupOpenAIApiKey", "title": "GPTCommit: Setup OpenAI API Key" }, { - "command": "gptcommit.tryDifferentOpenAIModel", - "title": "GPTCommit: Try a different OpenAI model" + "command": "gptcommit.useDifferentModel", + "title": "GPTCommit: Use a different OpenAI model" + }, + { + "command": "gptcommit.setOutputLanguage", + "title": "GPTCommit: Set output language" + }, + { + "command": "gptcommit.showPerFileSummary", + "title": "GPTCommit: Show per-file summary" + }, + { + "command": "gptcommit.disableConventionalCommit", + "title": "GPTCommit: Disable conventional commit" + }, + { + "command": "gptcommit.openConfigFile", + "title": "GPTCommit: Open gptcommit configuration file" } ], "menus": { @@ -54,6 +72,16 @@ "configuration": { "title": "GPTCommit", "properties": { + "gptcommit.gptcommitPath": { + "type": "string", + "default": "", + "description": "Path to gptcommit executable." + }, + "gptcommit.debug": { + "type": "boolean", + "default": false, + "description": "If true, debug information will be shown in the output channel." + }, "gptcommit.expressMode": { "type": "boolean", "default": false, @@ -61,25 +89,20 @@ }, "gptcommit.expressModeContent": { "type": "string", - "default": "title + body", + "default": "title + summary", "enum": [ "title", - "title + body", - "title + breakdown", - "title + body + breakdown" + "title + summary", + "title + per-file", + "title + summary + per-file" ], "enumDescriptions": [ - "Only the title of the commit message", - "Title and body of the commit message", - "Title and breakdown of the commit message", - "Title, body and breakdown of the commit message" + "Only the title", + "Title and bullet-point summary", + "Title and per-file summary", + "Title, bullet-point summary and per-file summary" ], - "description": "Content of the message to fill in the express mode." - }, - "gptcommit.gptcommitPath": { - "type": "string", - "default": "", - "description": "Path to gptcommit executable." + "description": "Content of the message to fill in the express mode. Note that you need enable per-file summary for the per-file content (by GPTCommit: Show per-file summary)." }, "gptcommit.onFiles": { "type": "string", diff --git a/src/commands/createCommandConfigs.ts b/src/commands/createCommandConfigs.ts new file mode 100644 index 0000000..ff5bba7 --- /dev/null +++ b/src/commands/createCommandConfigs.ts @@ -0,0 +1,138 @@ +import * as vscode from 'vscode'; +import * as path from 'path'; +import { getRepo, saveConfig } from '../utils'; + +export function setupOpenAIApiKey(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { + let apiCommand = vscode.commands.registerCommand('gptcommit.setupOpenAIApiKey', async (uri?: vscode.SourceControl) => { + vscode.window.showInputBox({ + prompt: 'Enter your OpenAI API key', + placeHolder: 'sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', + ignoreFocusOut: true, + }).then((key) => { + if (key) { + saveConfig( + 'openai.api_key', + 'openai.api_key', + channel, + getRepo(uri), + key, + 'Configuration openai.api_key saved' + ); + } + }); + }); + + context.subscriptions.push(apiCommand); +}; + +export function useDifferentModel(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { + let modelCommand = vscode.commands.registerCommand('gptcommit.useDifferentModel', async (uri?: vscode.SourceControl) => { + vscode.window.showInputBox({ + prompt: 'Enter the model you want to use', + placeHolder: 'gpt-3.5-turbo', + ignoreFocusOut: true, + }).then((model) => { + if (model) { + saveConfig( + 'openai.model', + 'openai.model', + channel, + getRepo(uri), + model, + 'Configuration openai.model saved' + ); + } + }); + }); + + context.subscriptions.push(modelCommand); +} + +export function setOutputLanguage(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { + let languageCommand = vscode.commands.registerCommand('gptcommit.setOutputLanguage', async (uri?: vscode.SourceControl) => { + vscode.window.showInputBox({ + prompt: 'Enter the language of the generated commit message', + placeHolder: 'en', + ignoreFocusOut: true, + }).then((lang) => { + if (lang) { + saveConfig( + 'output.lang', + 'output.lang', + channel, + getRepo(uri), + lang, + 'Configuration output.lang saved' + ); + } + }); + }); + + context.subscriptions.push(languageCommand); +} + +export function showPerFileSummary(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { + let showPerFileCommand = vscode.commands.registerCommand('gptcommit.showPerFileSummary', async (uri?: vscode.SourceControl) => { + vscode.window.showQuickPick( + ["Yes", "No"], + { + placeHolder: 'Enable "show per-file summary"?', + } + ).then((show) => { + if (show === "Yes" || show === "No") { + saveConfig( + 'output.show_per_file_summary', + 'output.show_per_file_summary', + channel, + getRepo(uri), + show === "Yes" ? "true" : "false", + 'Configuration output.show_per_file_summary saved' + ); + } + }); + }); + + context.subscriptions.push(showPerFileCommand); +} + +export function disableConventionalCommit(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { + let disableConvCommitCommand = vscode.commands.registerCommand('gptcommit.disableConventionalCommit', async (uri?: vscode.SourceControl) => { + vscode.window.showQuickPick( + ["Yes", "No"], + { + placeHolder: 'Disable conventional commit?', + } + ).then((show) => { + if (show === "Yes" || show === "No") { + saveConfig( + 'output.conventional_commit', + 'output.conventional_commit', + channel, + getRepo(uri), + show === "Yes" ? "false" : "true", + 'Configuration output.conventional_commit saved' + ); + } + }); + }); + + context.subscriptions.push(disableConvCommitCommand); +} + +export function openConfigFile(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { + let openConfigFileCommand = vscode.commands.registerCommand('gptcommit.openConfigFile', async (uri?: vscode.SourceControl) => { + const repo = getRepo(uri); + if (!repo) { + return; + } + channel.appendLine(`Opening ${path.join(repo.rootUri.fsPath, ".git", "gptcommit.toml")}`); + const editor = vscode.window.activeTextEditor; + const doc = await vscode.workspace.openTextDocument(path.join(repo.rootUri.fsPath, ".git", "gptcommit.toml")); + await vscode.window.showTextDocument(doc, { + preview: false, + viewColumn: editor ? editor.viewColumn : undefined, + }); + }); + + context.subscriptions.push(openConfigFileCommand); +} diff --git a/src/commands/createCommandGenerateGitCommitMessage.ts b/src/commands/createCommandGenerateGitCommitMessage.ts index 4509b41..3c64369 100644 --- a/src/commands/createCommandGenerateGitCommitMessage.ts +++ b/src/commands/createCommandGenerateGitCommitMessage.ts @@ -1,46 +1,30 @@ import * as vscode from 'vscode'; -import { getGitExtension, getCommitMessage } from '../utils'; -import { Repository } from '../@types/git'; +import { getCommitMessage } from '../utils'; +import { getRepo } from '../utils'; export default (context: vscode.ExtensionContext, channel: vscode.OutputChannel) => { let command1 = vscode.commands.registerCommand( 'gptcommit.generateGitCommitMessage', async (uri?: vscode.SourceControl) => { - // The code you place here will be executed every time your command is executed - // Display a message box to the user - const git = getGitExtension(); - - if (!git) { - vscode.window.showErrorMessage('Git extension not found'); - return; - } - - const config = vscode.workspace.getConfiguration('gptcommit'); - - let repo: Repository | undefined; - if (uri) { - const uriPath = uri.rootUri?.path; - repo = git.repositories.find(r => r.rootUri.path === uriPath); - } else if (git.repositories.length === 1) { - repo = git.repositories[0]; - } else if (git.repositories.length > 1) { - repo = git.repositories[0]; - vscode.window.showWarningMessage('Multiple repositories found, using first one'); - } else { - vscode.window.showErrorMessage('No repository found'); - return; - } + const repo = getRepo(uri); if (!repo) { - vscode.window.showErrorMessage('No repository found'); return; } + const config = vscode.workspace.getConfiguration('gptcommit'); + vscode.commands.executeCommand('setContext', 'gptcommit.generating', true); getCommitMessage(config, repo, context, channel).then((message) => { if (repo) { repo.inputBox.value = message; } }).catch((err) => { - vscode.window.showErrorMessage(err); + vscode.window.showErrorMessage(err, "Show Output").then((choice) => { + if (choice === "Show Output") { + channel.show(); + } + }); + }).finally(() => { + vscode.commands.executeCommand('setContext', 'gptcommit.generating', false); }); } ); diff --git a/src/commands/setupOpenAIApiKey.ts b/src/commands/setupOpenAIApiKey.ts deleted file mode 100644 index 5fb0766..0000000 --- a/src/commands/setupOpenAIApiKey.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { exec } from 'child_process'; -import * as vscode from 'vscode'; - -export default async () => { - vscode.window.showInputBox({ - prompt: 'Enter your OpenAI API key', - placeHolder: 'sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', - }).then((key) => { - if (key) { - // save key - const gptcommit = vscode.workspace.getConfiguration('gptcommit').gptcommitPath || 'gptcommit'; - const cmd = `${gptcommit} config set openai.api_key ${key}`; - exec(cmd, (err, stdout, stderr) => { - if (err) { - vscode.window.showErrorMessage(`Failed to set OpenAI API key: ${err}`); - } else { - vscode.window.showInformationMessage('OpenAI API key saved'); - } - }); - } - }); -}; diff --git a/src/commands/tryDifferentOpenAIModel.ts b/src/commands/tryDifferentOpenAIModel.ts deleted file mode 100644 index f566b45..0000000 --- a/src/commands/tryDifferentOpenAIModel.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { exec } from 'child_process'; -import * as vscode from 'vscode'; - -export default async () => { - vscode.window.showInputBox({ - prompt: 'Try a different OpenAI model', - placeHolder: 'e.g. text-davinci-003 See: https://beta.openai.com/docs/models/overview', - }).then((model) => { - if (model) { - // save key - const gptcommit = vscode.workspace.getConfiguration('gptcommit').gptcommitPath || 'gptcommit'; - const cmd = `${gptcommit} config set openai.model ${model}`; - exec(cmd, (err, stdout, stderr) => { - if (err) { - vscode.window.showErrorMessage(`Failed to switch the model: ${err}`); - } else { - vscode.window.showInformationMessage('New model configuration saved'); - } - }); - } - }); -}; diff --git a/src/extension.ts b/src/extension.ts index e147d85..b48e1f1 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -2,8 +2,14 @@ // Import the module and reference it with the alias vscode in your code below import * as vscode from 'vscode'; import createCommandGenerateGitCommitMessage from './commands/createCommandGenerateGitCommitMessage'; -import setupOpenAIApiKey from './commands/setupOpenAIApiKey'; -import tryDifferentOpenAIModel from './commands/tryDifferentOpenAIModel'; +import { + setupOpenAIApiKey, + useDifferentModel, + setOutputLanguage, + showPerFileSummary, + disableConventionalCommit, + openConfigFile, +} from './commands/createCommandConfigs'; // This method is called when your extension is activated // Your extension is activated the very first time the command is executed @@ -20,12 +26,12 @@ export function activate(context: vscode.ExtensionContext) { // Now provide the implementation of the command with registerCommand // The commandId parameter must match the command field in package.json createCommandGenerateGitCommitMessage(context, channel); - - let command2 = vscode.commands.registerCommand('gptcommit.setupOpenAIApiKey', setupOpenAIApiKey); - context.subscriptions.push(command2); - - let command3 = vscode.commands.registerCommand('gptcommit.tryDifferentOpenAIModel', tryDifferentOpenAIModel); - context.subscriptions.push(command3); + setupOpenAIApiKey(context, channel); + useDifferentModel(context, channel); + setOutputLanguage(context, channel); + showPerFileSummary(context, channel); + disableConventionalCommit(context, channel); + openConfigFile(context, channel); } // This method is called when your extension is deactivated diff --git a/src/utils.ts b/src/utils.ts index 9b309ef..1f087d0 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -40,6 +40,10 @@ export async function getCommitMessage( diff = await repo.diff(false); } } + // if diff is empty, return the promise here + if (!diff) { + return Promise.reject('No changes to commit'); + } writeFileSync(tmpDiffFile, diff); const cmd = `${gptcommit} prepare-commit-msg --commit-msg-file ${tmpMsgFile} --commit-source commit --git-diff-content ${tmpDiffFile}`; channel.appendLine(`COMMAND: ${cmd}`); @@ -52,30 +56,61 @@ export async function getCommitMessage( try { unlinkSync(tmpDiffFile); } catch (e) {} if (/: not found\s*$/.test(stderr)) { + if (config.debug) { + channel.appendLine('DEBUG: gptcommit not found'); + } reject('gptcommit not found, see https://github.com/zurawiki/gptcommit. If it is not in your PATH, set "gptcommit.gptcommitPath" in your settings to the path to gptcommit'); } else if (/OpenAI API key not found/.test(stderr)) { + if (config.debug) { + channel.appendLine('DEBUG: OpenAI API key not set'); + } reject('OpenAI API key not found, run "gptcommit.setupOpenAIApiKey" command to set it up'); } else if (/is being amended/.test(stdout)) { + if (config.debug) { + channel.appendLine('DEBUG: allow_amend is false'); + } // set allow-amend to true - const cmd = `${gptcommit} config set allow_amend true`; + const cmd = `${gptcommit} config set --local allow_amend true`; channel.appendLine(`COMMAND: ${cmd}`); - execSync(cmd, {cwd: repo.rootUri.fsPath}); - // try again - getCommitMessage(config, repo, context, channel).then((msg) => { - resolve(msg); - }).catch((err) => { - reject(err); - }); + let setAmendSuccess = true; + try { + const setAmendOut = execSync(cmd, {cwd: repo.rootUri.fsPath}).toString(); + channel.appendLine(`STDOUT: ${setAmendOut}`); + } catch (error) { + setAmendSuccess = false; + channel.appendLine(`ERROR: ${error}`); + reject("Failed to set allow_amend to true"); + } + if (setAmendSuccess) { + // try again + getCommitMessage(config, repo, context, channel).then((msg) => { + resolve(msg); + }).catch((err) => { + reject(err); + }); + } } else if (err || stderr) { + if (config.debug) { + channel.appendLine(`DEBUG: gptcommit failed with error: ${err} | ${stderr}`); + } try { unlinkSync(tmpMsgFile); } catch (e) {} reject(err || stderr); } else if (!existsSync(tmpMsgFile)) { + if (config.debug) { + channel.appendLine('DEBUG: gptcommit failed to generate commit message, message file not generated'); + } reject('Failed to generate commit message'); } else if (config.expressMode) { + if (config.debug) { + channel.appendLine('DEBUG: express mode enabled, skipping editor'); + } const msg = readFileSync(tmpMsgFile, 'utf8'); try { unlinkSync(tmpMsgFile); } catch (e) {} resolve(polishMessage(msg, config.expressModeContent)); } else { + if (config.debug) { + channel.appendLine('DEBUG: opening editor'); + } const editor = vscode.window.activeTextEditor; vscode.workspace.openTextDocument(tmpMsgFile).then(async (doc) => { await vscode.window.showTextDocument(doc, { @@ -83,6 +118,7 @@ export async function getCommitMessage( viewColumn: editor ? editor.viewColumn : undefined, }); progress.report({ increment: 100 }); + vscode.commands.executeCommand('setContext', 'gptcommit.generating', false); }); let disposable = vscode.workspace.onDidSaveTextDocument(async (doc) => { @@ -100,7 +136,7 @@ export async function getCommitMessage( export function polishMessage(msg: string, content: string) { const lines = msg.split('\n'); let title = lines[0]; - let body = []; + let summary = []; let breakdown = []; let breakdownStarted = false; for (let line of lines.slice(1)) { @@ -113,7 +149,7 @@ export function polishMessage(msg: string, content: string) { if (breakdownStarted) { breakdown.push(line); } else if (line.startsWith('- ')) { - body.push(line); + summary.push(line); } } if (/breakdown/.test(content)) { @@ -122,11 +158,65 @@ export function polishMessage(msg: string, content: string) { if (content === 'title') { return title; } - if (content === 'title + body') { - return [title, '', ...body].join('\n'); + if (content === 'title + summary') { + return [title, '', ...summary].join('\n'); } if (content === 'title + breakdown') { return [title, ...breakdown].join('\n'); } - return [title, '', ...body, ...breakdown].join('\n'); + return [title, '', ...summary, ...breakdown].join('\n'); +} + +export function getRepo(uri?: vscode.SourceControl): Repository | undefined { + const git = getGitExtension(); + + if (!git) { + vscode.window.showErrorMessage('Git extension not found'); + return undefined; + } + + if (uri) { + const uriPath = uri.rootUri?.path; + return git.repositories.find(r => r.rootUri.path === uriPath); + } + if (git.repositories.length === 1) { + return git.repositories[0]; + } + if (git.repositories.length > 1) { + vscode.window.showWarningMessage('Multiple repositories found, using first one'); + return git.repositories[0]; + } + vscode.window.showErrorMessage('No repository found'); + return undefined; +} + +export function saveConfig( + key: string, + gckey: string, + channel: vscode.OutputChannel, + repo: Repository | undefined, + value: any | undefined = undefined, + savedInfo: string | undefined = undefined, +) { + if (repo === undefined) { + return; + } + const gptcommit = vscode.workspace.getConfiguration('gptcommit').gptcommitPath || 'gptcommit'; + if (value === undefined) { + value = vscode.workspace.getConfiguration('gptcommit')[key]; + } + const cmd = `${gptcommit} config set --local ${gckey} ${value}`; + exec(cmd, { cwd: repo.rootUri.fsPath }, (err, stdout, stderr) => { + if (err) { + vscode.window.showErrorMessage(`Failed to save "${key}": ${err}`); + channel.appendLine(`COMMAND: ${cmd}`); + channel.appendLine(`STDOUT: ${stdout}`); + channel.appendLine(`STDERR: ${stderr}`); + exec("pwd", (err, stdout, stderr) => { + vscode.window.showErrorMessage(`pwd: ${stdout} ${stderr} ${err}`) + }); + } else if (savedInfo !== undefined) { + vscode.window.showInformationMessage(savedInfo); + } + }); }