Skip to content

fix(commitlint): Support i18n translations in consistency prompt generation #525

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 1 commit into
base: master
Choose a base branch
from
Open

fix(commitlint): Support i18n translations in consistency prompt generation #525

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
2 changes: 1 addition & 1 deletion src/modules/commitlint/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export const configureCommitlintIntegration = async (force = false) => {
const prompts = inferPromptsFromCommitlintConfig(commitLintConfig as any);

const consistencyPrompts =
commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts);
commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts, translation);

// debug prompt which will generate a consistency
// await fs.writeFile(
Expand Down
21 changes: 12 additions & 9 deletions src/modules/commitlint/prompts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import {
import { getConfig } from '../../commands/config';
import { i18n, I18nLocals } from '../../i18n';
import { IDENTITY, INIT_DIFF_PROMPT } from '../../prompts';
import { ConsistencyPrompt } from './types';

const config = getConfig();
const translation = i18n[(config.OCO_LANGUAGE as I18nLocals) || 'en'];

type DeepPartial<T> = {
[P in keyof T]?: {
Expand Down Expand Up @@ -214,7 +214,8 @@ const STRUCTURE_OF_COMMIT = config.OCO_OMIT_SCOPE

// Prompt to generate LLM-readable rules based on @commitlint rules.
const GEN_COMMITLINT_CONSISTENCY_PROMPT = (
prompts: string[]
prompts: string[],
translation: ConsistencyPrompt
): OpenAI.Chat.Completions.ChatCompletionMessageParam[] => [
{
role: 'system',
Expand All @@ -233,15 +234,17 @@ Commit Message Conventions:
- ${prompts.join('\n- ')}

JSON Output Format:
- The JSON output should contain the commit messages for a bug fix and a new feature in the following format:
- You MUST write all commit messages and descriptions in ${
translation.localLanguage
} and output them in the following JSON format. Use the exact language and writing style as shown in the example:
\`\`\`json
{
"localLanguage": "${translation.localLanguage}",
"commitFix": "<Header of commit for bug fix with scope>",
"commitFeat": "<Header of commit for feature with scope>",
"commitFixOmitScope": "<Header of commit for bug fix without scope>",
"commitFeatOmitScope": "<Header of commit for feature without scope>",
"commitDescription": "<Description of commit for both the bug fix and the feature>"
"localLanguage": ${JSON.stringify(translation.localLanguage)},
"commitFix": ${JSON.stringify(translation.commitFix)},
"commitFeat": ${JSON.stringify(translation.commitFeat)},
"commitFixOmitScope": ${JSON.stringify(translation.commitFixOmitScope)},
"commitFeatOmitScope": ${JSON.stringify(translation.commitFeatOmitScope)},
"commitDescription": ${JSON.stringify(translation.commitDescription)}
}
\`\`\`
- The "commitDescription" should not include the commit message's header, only the description.
Expand Down