diff --git a/README.md b/README.md index 2301b2d..f752b01 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ Note: Do NOT install `gptcommit` hook via `gptcommit install` under the root of | ----------------- | --------------- | ----------------- | | < 0.1.0 | 1.75+ | 0.1.16 | | 0.1.x | 1.70+ | 0.1.16 | -| 0.2.0 | 1.70+ | 0.3.0 | +| 0.2.x | 1.70+ | 0.3.0 | +| 0.3.x | 1.70+ | 0.5.x | ## Commands @@ -35,10 +36,20 @@ Run via `Ctrl+Shift+P` or `Cmd+Shift+P`: - `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 @@ -47,7 +58,7 @@ Run via `Ctrl+Shift+P` or `Cmd+Shift+P`: ## Advanced configuration -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. +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. diff --git a/package.json b/package.json index fe824a1..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.2.0", + "version": "0.3.0", "repository": { "url": "https://github.com/pwwang/vscode-gptcommit" }, @@ -32,7 +32,8 @@ { "command": "gptcommit.generateGitCommitMessage", "title": "GPTCommit: Generate Git Commit Message", - "icon": "$(output)" + "icon": "$(output)", + "enablement": "!gptcommit.generating" }, { "command": "gptcommit.setupOpenAIApiKey", @@ -45,6 +46,18 @@ { "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": { @@ -64,6 +77,11 @@ "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, @@ -75,16 +93,16 @@ "enum": [ "title", "title + summary", - "title + breakdown", - "title + summary + breakdown" + "title + per-file", + "title + summary + per-file" ], "enumDescriptions": [ "Only the title", "Title and bullet-point summary", - "Title and breakdown of each changed file", - "Title, bullet-point summary and each changed file" + "Title and per-file summary", + "Title, bullet-point summary and per-file summary" ], - "description": "Content of the message to fill in the express mode." + "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 index fbd1826..ff5bba7 100644 --- a/src/commands/createCommandConfigs.ts +++ b/src/commands/createCommandConfigs.ts @@ -1,4 +1,5 @@ import * as vscode from 'vscode'; +import * as path from 'path'; import { getRepo, saveConfig } from '../utils'; export function setupOpenAIApiKey(context: vscode.ExtensionContext, channel: vscode.OutputChannel) { @@ -6,6 +7,7 @@ export function setupOpenAIApiKey(context: vscode.ExtensionContext, channel: vsc vscode.window.showInputBox({ prompt: 'Enter your OpenAI API key', placeHolder: 'sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', + ignoreFocusOut: true, }).then((key) => { if (key) { saveConfig( @@ -14,7 +16,7 @@ export function setupOpenAIApiKey(context: vscode.ExtensionContext, channel: vsc channel, getRepo(uri), key, - 'OpenAI API key saved' + 'Configuration openai.api_key saved' ); } }); @@ -28,6 +30,7 @@ export function useDifferentModel(context: vscode.ExtensionContext, channel: vsc vscode.window.showInputBox({ prompt: 'Enter the model you want to use', placeHolder: 'gpt-3.5-turbo', + ignoreFocusOut: true, }).then((model) => { if (model) { saveConfig( @@ -36,7 +39,7 @@ export function useDifferentModel(context: vscode.ExtensionContext, channel: vsc channel, getRepo(uri), model, - 'Model saved' + 'Configuration openai.model saved' ); } }); @@ -50,6 +53,7 @@ export function setOutputLanguage(context: vscode.ExtensionContext, channel: vsc vscode.window.showInputBox({ prompt: 'Enter the language of the generated commit message', placeHolder: 'en', + ignoreFocusOut: true, }).then((lang) => { if (lang) { saveConfig( @@ -58,7 +62,7 @@ export function setOutputLanguage(context: vscode.ExtensionContext, channel: vsc channel, getRepo(uri), lang, - 'Output language saved' + 'Configuration output.lang saved' ); } }); @@ -66,3 +70,69 @@ export function setOutputLanguage(context: vscode.ExtensionContext, channel: vsc 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 0299c09..3c64369 100644 --- a/src/commands/createCommandGenerateGitCommitMessage.ts +++ b/src/commands/createCommandGenerateGitCommitMessage.ts @@ -12,13 +12,19 @@ export default (context: vscode.ExtensionContext, channel: vscode.OutputChannel) } 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/extension.ts b/src/extension.ts index 6fb1412..b48e1f1 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -2,7 +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, useDifferentModel, setOutputLanguage } from './commands/createCommandConfigs'; +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 @@ -22,6 +29,9 @@ export function activate(context: vscode.ExtensionContext) { 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 085b9aa..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) => {