Skip to content

#497 Feature: Add Fully custom prompts #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

#497 Feature: Add Fully custom prompts #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6570a65
Feature: Add --show-prompt flag
Danjoe4 Aug 2, 2025
72e2e45
chore: Remove ini dependency. Use dotenv to allow multine strings
Danjoe4 Aug 2, 2025
ebc6348
feat: Add config option OCO_CUSTOM_PROMPT
Danjoe4 Aug 2, 2025
7be4773
docs: reference OCO_CUSTOM_PROMPT
Danjoe4 Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ OCO_LANGUAGE=<locale, scroll to the bottom to see options>
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
OCO_ONE_LINE_COMMIT=<one line commit message, default: false>
OCO_CUSTOM_PROMPT="<multiline string of custom instructions>"
```

Global configs are same as local configs, but they are stored in the global `~/.opencommit` config file and set with `oco config set` command, e.g. `oco config set OCO_MODEL=gpt-4o`.
Expand Down
269 changes: 80 additions & 189 deletions out/cli.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1332,185 +1332,6 @@ var require_main = __commonJS({
}
});

// node_modules/ini/lib/ini.js
var require_ini = __commonJS({
"node_modules/ini/lib/ini.js"(exports2, module2) {
var { hasOwnProperty: hasOwnProperty2 } = Object.prototype;
var eol = typeof process !== "undefined" && process.platform === "win32" ? "\r\n" : "\n";
var encode3 = (obj, opt) => {
const children = [];
let out = "";
if (typeof opt === "string") {
opt = {
section: opt,
whitespace: false
};
} else {
opt = opt || /* @__PURE__ */ Object.create(null);
opt.whitespace = opt.whitespace === true;
}
const separator = opt.whitespace ? " = " : "=";
for (const k7 of Object.keys(obj)) {
const val = obj[k7];
if (val && Array.isArray(val)) {
for (const item of val) {
out += safe(k7 + "[]") + separator + safe(item) + eol;
}
} else if (val && typeof val === "object") {
children.push(k7);
} else {
out += safe(k7) + separator + safe(val) + eol;
}
}
if (opt.section && out.length) {
out = "[" + safe(opt.section) + "]" + eol + out;
}
for (const k7 of children) {
const nk = dotSplit(k7).join("\\.");
const section = (opt.section ? opt.section + "." : "") + nk;
const { whitespace } = opt;
const child = encode3(obj[k7], {
section,
whitespace
});
if (out.length && child.length) {
out += eol;
}
out += child;
}
return out;
};
var dotSplit = (str2) => str2.replace(/\1/g, "LITERAL\\1LITERAL").replace(/\\\./g, "").split(/\./).map((part) => part.replace(/\1/g, "\\.").replace(/\2LITERAL\\1LITERAL\2/g, ""));
var decode = (str2) => {
const out = /* @__PURE__ */ Object.create(null);
let p4 = out;
let section = null;
const re3 = /^\[([^\]]*)\]$|^([^=]+)(=(.*))?$/i;
const lines = str2.split(/[\r\n]+/g);
for (const line of lines) {
if (!line || line.match(/^\s*[;#]/)) {
continue;
}
const match = line.match(re3);
if (!match) {
continue;
}
if (match[1] !== void 0) {
section = unsafe(match[1]);
if (section === "__proto__") {
p4 = /* @__PURE__ */ Object.create(null);
continue;
}
p4 = out[section] = out[section] || /* @__PURE__ */ Object.create(null);
continue;
}
const keyRaw = unsafe(match[2]);
const isArray2 = keyRaw.length > 2 && keyRaw.slice(-2) === "[]";
const key = isArray2 ? keyRaw.slice(0, -2) : keyRaw;
if (key === "__proto__") {
continue;
}
const valueRaw = match[3] ? unsafe(match[4]) : true;
const value = valueRaw === "true" || valueRaw === "false" || valueRaw === "null" ? JSON.parse(valueRaw) : valueRaw;
if (isArray2) {
if (!hasOwnProperty2.call(p4, key)) {
p4[key] = [];
} else if (!Array.isArray(p4[key])) {
p4[key] = [p4[key]];
}
}
if (Array.isArray(p4[key])) {
p4[key].push(value);
} else {
p4[key] = value;
}
}
const remove = [];
for (const k7 of Object.keys(out)) {
if (!hasOwnProperty2.call(out, k7) || typeof out[k7] !== "object" || Array.isArray(out[k7])) {
continue;
}
const parts = dotSplit(k7);
p4 = out;
const l3 = parts.pop();
const nl = l3.replace(/\\\./g, ".");
for (const part of parts) {
if (part === "__proto__") {
continue;
}
if (!hasOwnProperty2.call(p4, part) || typeof p4[part] !== "object") {
p4[part] = /* @__PURE__ */ Object.create(null);
}
p4 = p4[part];
}
if (p4 === out && nl === l3) {
continue;
}
p4[nl] = out[k7];
remove.push(k7);
}
for (const del of remove) {
delete out[del];
}
return out;
};
var isQuoted = (val) => {
return val.startsWith('"') && val.endsWith('"') || val.startsWith("'") && val.endsWith("'");
};
var safe = (val) => {
if (typeof val !== "string" || val.match(/[=\r\n]/) || val.match(/^\[/) || val.length > 1 && isQuoted(val) || val !== val.trim()) {
return JSON.stringify(val);
}
return val.split(";").join("\\;").split("#").join("\\#");
};
var unsafe = (val, doUnesc) => {
val = (val || "").trim();
if (isQuoted(val)) {
if (val.charAt(0) === "'") {
val = val.slice(1, -1);
}
try {
val = JSON.parse(val);
} catch {
}
} else {
let esc = false;
let unesc = "";
for (let i3 = 0, l3 = val.length; i3 < l3; i3++) {
const c4 = val.charAt(i3);
if (esc) {
if ("\\;#".indexOf(c4) !== -1) {
unesc += c4;
} else {
unesc += "\\" + c4;
}
esc = false;
} else if (";#".indexOf(c4) !== -1) {
break;
} else if (c4 === "\\") {
esc = true;
} else {
unesc += c4;
}
}
if (esc) {
unesc += "\\";
}
return unesc.trim();
}
return val;
};
module2.exports = {
parse: decode,
decode,
stringify: encode3,
encode: encode3,
safe,
unsafe
};
}
});

// node_modules/webidl-conversions/lib/index.js
var require_lib = __commonJS({
"node_modules/webidl-conversions/lib/index.js"(exports2) {
Expand Down Expand Up @@ -47736,7 +47557,6 @@ var package_default = {
},
devDependencies: {
"@commitlint/types": "^17.4.4",
"@types/ini": "^1.3.31",
"@types/inquirer": "^9.0.3",
"@types/jest": "^29.5.12",
"@types/node": "^16.18.14",
Expand Down Expand Up @@ -47771,7 +47591,6 @@ var package_default = {
crypto: "^1.0.1",
execa: "^7.0.0",
ignore: "^5.2.4",
ini: "^3.0.1",
inquirer: "^9.1.4",
openai: "^4.57.0",
punycode: "^2.3.1",
Expand Down Expand Up @@ -50019,7 +49838,6 @@ var $4 = create$();
// src/commands/config.ts
var dotenv = __toESM(require_main(), 1);
var import_fs = require("fs");
var import_ini = __toESM(require_ini(), 1);
var import_os = require("os");
var import_path = require("path");

Expand Down Expand Up @@ -50313,6 +50131,7 @@ var CONFIG_KEYS = /* @__PURE__ */ ((CONFIG_KEYS2) => {
CONFIG_KEYS2["OCO_OMIT_SCOPE"] = "OCO_OMIT_SCOPE";
CONFIG_KEYS2["OCO_GITPUSH"] = "OCO_GITPUSH";
CONFIG_KEYS2["OCO_HOOK_AUTO_UNCOMMENT"] = "OCO_HOOK_AUTO_UNCOMMENT";
CONFIG_KEYS2["OCO_CUSTOM_PROMPT"] = "OCO_CUSTOM_PROMPT";
return CONFIG_KEYS2;
})(CONFIG_KEYS || {});
var MODEL_LIST = {
Expand Down Expand Up @@ -51064,6 +50883,15 @@ var configValidators = {
typeof value === "boolean",
"Must be true or false"
);
},
["OCO_CUSTOM_PROMPT" /* OCO_CUSTOM_PROMPT */](value) {
if (value === void 0 || value === null) return value;
validateConfig(
"OCO_CUSTOM_PROMPT" /* OCO_CUSTOM_PROMPT */,
typeof value === "string",
"Must be a string"
);
return value;
}
};
var OCO_AI_PROVIDER_ENUM = /* @__PURE__ */ ((OCO_AI_PROVIDER_ENUM2) => {
Expand Down Expand Up @@ -51105,10 +50933,12 @@ var DEFAULT_CONFIG = {
OCO_OMIT_SCOPE: false,
OCO_GITPUSH: true,
// todo: deprecate
OCO_HOOK_AUTO_UNCOMMENT: false
OCO_HOOK_AUTO_UNCOMMENT: false,
OCO_CUSTOM_PROMPT: void 0
};
var initGlobalConfig = (configPath = defaultConfigPath) => {
(0, import_fs.writeFileSync)(configPath, (0, import_ini.stringify)(DEFAULT_CONFIG), "utf8");
const configContent = Object.entries(DEFAULT_CONFIG).map(([key, value]) => `${key}=${value}`).join("\n");
(0, import_fs.writeFileSync)(configPath, configContent, "utf8");
return DEFAULT_CONFIG;
};
var parseConfigVarValue = (value) => {
Expand Down Expand Up @@ -51138,12 +50968,22 @@ var getEnvConfig = (envPath) => {
OCO_ONE_LINE_COMMIT: parseConfigVarValue(process.env.OCO_ONE_LINE_COMMIT),
OCO_TEST_MOCK_TYPE: process.env.OCO_TEST_MOCK_TYPE,
OCO_OMIT_SCOPE: parseConfigVarValue(process.env.OCO_OMIT_SCOPE),
OCO_CUSTOM_PROMPT: process.env.OCO_CUSTOM_PROMPT,
OCO_GITPUSH: parseConfigVarValue(process.env.OCO_GITPUSH)
// todo: deprecate
};
};
var setGlobalConfig = (config7, configPath = defaultConfigPath) => {
(0, import_fs.writeFileSync)(configPath, (0, import_ini.stringify)(config7), "utf8");
const configContent = Object.entries(config7).filter(([_7, value]) => value !== void 0 && value !== null).map(([key, value]) => {
if (typeof value === "string" && value.includes("\n")) {
return `${key}="${value.replace(/\n/g, "\\n")}"`;
}
if (typeof value === "string" && (value.includes(" ") || value.includes('"') || value.includes("'"))) {
return `${key}="${value.replace(/"/g, '\\"')}"`;
}
return `${key}=${value}`;
}).join("\n");
(0, import_fs.writeFileSync)(configPath, configContent, "utf8");
};
var getIsGlobalConfigFileExist = (configPath = defaultConfigPath) => {
return (0, import_fs.existsSync)(configPath);
Expand All @@ -51153,8 +50993,28 @@ var getGlobalConfig = (configPath = defaultConfigPath) => {
const isGlobalConfigFileExist = getIsGlobalConfigFileExist(configPath);
if (!isGlobalConfigFileExist) globalConfig = initGlobalConfig(configPath);
else {
const configFile = (0, import_fs.readFileSync)(configPath, "utf8");
globalConfig = (0, import_ini.parse)(configFile);
dotenv.config({ path: configPath });
globalConfig = {
OCO_API_KEY: process.env.OCO_API_KEY,
OCO_TOKENS_MAX_INPUT: parseConfigVarValue(process.env.OCO_TOKENS_MAX_INPUT) || DEFAULT_CONFIG.OCO_TOKENS_MAX_INPUT,
OCO_TOKENS_MAX_OUTPUT: parseConfigVarValue(process.env.OCO_TOKENS_MAX_OUTPUT) || DEFAULT_CONFIG.OCO_TOKENS_MAX_OUTPUT,
OCO_API_URL: process.env.OCO_API_URL,
OCO_API_CUSTOM_HEADERS: process.env.OCO_API_CUSTOM_HEADERS,
OCO_DESCRIPTION: parseConfigVarValue(process.env.OCO_DESCRIPTION) || DEFAULT_CONFIG.OCO_DESCRIPTION,
OCO_EMOJI: parseConfigVarValue(process.env.OCO_EMOJI) || DEFAULT_CONFIG.OCO_EMOJI,
OCO_WHY: parseConfigVarValue(process.env.OCO_WHY) || DEFAULT_CONFIG.OCO_WHY,
OCO_MODEL: process.env.OCO_MODEL || DEFAULT_CONFIG.OCO_MODEL,
OCO_LANGUAGE: process.env.OCO_LANGUAGE || DEFAULT_CONFIG.OCO_LANGUAGE,
OCO_MESSAGE_TEMPLATE_PLACEHOLDER: process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || DEFAULT_CONFIG.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || DEFAULT_CONFIG.OCO_PROMPT_MODULE,
OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || DEFAULT_CONFIG.OCO_AI_PROVIDER,
OCO_GITPUSH: parseConfigVarValue(process.env.OCO_GITPUSH) || DEFAULT_CONFIG.OCO_GITPUSH,
OCO_ONE_LINE_COMMIT: parseConfigVarValue(process.env.OCO_ONE_LINE_COMMIT) || DEFAULT_CONFIG.OCO_ONE_LINE_COMMIT,
OCO_OMIT_SCOPE: parseConfigVarValue(process.env.OCO_OMIT_SCOPE) || DEFAULT_CONFIG.OCO_OMIT_SCOPE,
OCO_TEST_MOCK_TYPE: process.env.OCO_TEST_MOCK_TYPE || DEFAULT_CONFIG.OCO_TEST_MOCK_TYPE,
OCO_HOOK_AUTO_UNCOMMENT: parseConfigVarValue(process.env.OCO_HOOK_AUTO_UNCOMMENT) || DEFAULT_CONFIG.OCO_HOOK_AUTO_UNCOMMENT,
OCO_CUSTOM_PROMPT: process.env.OCO_CUSTOM_PROMPT || DEFAULT_CONFIG.OCO_CUSTOM_PROMPT
};
}
return globalConfig;
};
Expand Down Expand Up @@ -51311,6 +51171,11 @@ function getConfigKeyDetails(key) {
description: "Automatically uncomment the commit message in the hook",
values: ["true", "false"]
};
case "OCO_CUSTOM_PROMPT" /* OCO_CUSTOM_PROMPT */:
return {
description: "Custom prompt to use instead of the default prompt template",
values: ["Any string"]
};
default:
return {
description: "String value",
Expand Down Expand Up @@ -67206,6 +67071,11 @@ Consider this context when generating the commit message, incorporating relevant
var INIT_MAIN_PROMPT2 = (language, fullGitMojiSpec, context) => ({
role: "system",
content: (() => {
if (config4.OCO_CUSTOM_PROMPT) {
const userInputContext2 = userInputCodeContext(context);
return userInputContext2 ? `${config4.OCO_CUSTOM_PROMPT}
${userInputContext2}` : config4.OCO_CUSTOM_PROMPT;
}
const commitConvention = fullGitMojiSpec ? "GitMoji specification" : "Conventional Commit Convention";
const missionStatement = `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the ${commitConvention} and explain WHAT were the changes and mainly WHY the changes were done.`;
const diffInstruction = "I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.";
Expand Down Expand Up @@ -67715,7 +67585,7 @@ ${source_default.grey("\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2
process.exit(1);
}
};
async function commit(extraArgs2 = [], context = "", isStageAllFlag = false, fullGitMojiSpec = false, skipCommitConfirmation = false) {
async function commit(extraArgs2 = [], context = "", isStageAllFlag = false, fullGitMojiSpec = false, skipCommitConfirmation = false, showPrompt = false) {
if (isStageAllFlag) {
const changedFiles2 = await getChangedFiles();
if (changedFiles2) await gitAdd({ files: changedFiles2 });
Expand All @@ -67730,6 +67600,22 @@ async function commit(extraArgs2 = [], context = "", isStageAllFlag = false, ful
ce(source_default.red("No changes detected"));
process.exit(1);
}
if (showPrompt) {
try {
const messages = await getMainCommitPrompt(fullGitMojiSpec, context);
const systemMessage = messages.find((msg) => msg.role === "system");
if (systemMessage) {
console.log(systemMessage.content);
} else {
console.error("No system prompt found");
}
process.exit(0);
} catch (error) {
const err = error;
console.error(`Failed to generate prompt: ${err?.message || err}`);
process.exit(1);
}
}
ae("open-commit");
if (errorChangedFiles ?? errorStagedFiles) {
ce(`${source_default.red("\u2716")} ${errorChangedFiles ?? errorStagedFiles}`);
Expand Down Expand Up @@ -68151,6 +68037,11 @@ Z2(
alias: "y",
description: "Skip commit confirmation prompt",
default: false
},
"show-prompt": {
type: Boolean,
description: "Show the instructional prompt that would be given to the LLM",
default: false
}
},
ignoreArgv: (type2) => type2 === "unknown-flag" || type2 === "argument",
Expand All @@ -68162,7 +68053,7 @@ Z2(
if (await isHookCalled()) {
prepareCommitMessageHook();
} else {
commit(extraArgs, flags.context, false, flags.fgm, flags.yes);
commit(extraArgs, flags.context, false, flags.fgm, flags.yes, flags["show-prompt"]);
}
},
extraArgs
Expand Down
Loading