Skip to content

Add support for specify the conventional commit type #278

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
ChristoferMendes wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add support for specify the conventional commit type #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ cli(
description: 'Type of commit message to generate',
alias: 't',
},
conventionalType: {
type: String,
description:
'Conventional commit type to generate if the type generated is not precise',
alias: 'c',
}
},

commands: [configCommand, hookCommand],
Expand All @@ -61,6 +67,7 @@ cli(
argv.flags.exclude,
argv.flags.all,
argv.flags.type,
argv.flags.type ? argv.flags.conventionalType : undefined,
rawArgv
);
}
Expand Down
5 changes: 4 additions & 1 deletion src/commands/aicommits.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export default async (
excludeFiles: string[],
stageAll: boolean,
commitType: string | undefined,
conventionalType: string | undefined,
rawArgv: string[]
) =>
(async () => {
Expand Down Expand Up @@ -58,6 +59,7 @@ export default async (
env.https_proxy || env.HTTPS_PROXY || env.http_proxy || env.HTTP_PROXY,
generate: generate?.toString(),
type: commitType?.toString(),
conventionalType: conventionalType?.toString(),
});

const s = spinner();
Expand All @@ -73,7 +75,8 @@ export default async (
config['max-length'],
config.type,
config.timeout,
config.proxy
config.proxy,
config.conventionalType
);
} finally {
s.stop('Changes analyzed');
Expand Down
8 changes: 8 additions & 0 deletions src/utils/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ const configParsers = {

return parsed;
},
conventionalType(type?: string) {
if (!type) {
return '';
}

parseAssert('conventionalType', type, 'Cannot be empty');
return type;
}
} as const;

type ConfigKeys = keyof typeof configParsers;
Expand Down
5 changes: 3 additions & 2 deletions src/utils/openai.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ export const generateCommitMessage = async (
maxLength: number,
type: CommitType,
timeout: number,
proxy?: string
proxy?: string,
conventionalType?: string
) => {
try {
const completion = await createChatCompletion(
Expand All @@ -149,7 +150,7 @@ export const generateCommitMessage = async (
messages: [
{
role: 'system',
content: generatePrompt(locale, maxLength, type),
content: generatePrompt(locale, maxLength, type, conventionalType),
},
{
role: 'user',
Expand Down
7 changes: 5 additions & 2 deletions src/utils/prompt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ const commitTypeFormats: Record<CommitType, string> = {
const specifyCommitFormat = (type: CommitType) =>
`The output response must be in format:\n${commitTypeFormats[type]}`;

const insertConventionalCommitType = (conventionalCommitType: string) => `With the type: ${conventionalCommitType}`;

const commitTypes: Record<CommitType, string> = {
'': '',

Expand Down Expand Up @@ -41,14 +43,15 @@ const commitTypes: Record<CommitType, string> = {
export const generatePrompt = (
locale: string,
maxLength: number,
type: CommitType
type: CommitType,
conventionalType?: string
) =>
[
'Generate a concise git commit message written in present tense for the following code diff with the given specifications below:',
`Message language: ${locale}`,
`Commit message must be a maximum of ${maxLength} characters.`,
'Exclude anything unnecessary such as translation. Your entire response will be passed directly into git commit.',
commitTypes[type],
conventionalType ? insertConventionalCommitType(conventionalType) : commitTypes[type],
specifyCommitFormat(type),
]
.filter(Boolean)
Expand Down