From f8ce0d32d572cfa1baca73f2950e8fb8bf160232 Mon Sep 17 00:00:00 2001 From: Bautista Igarzabal <bautistaigarzabal11@gmail.com> Date: Sun, 9 Mar 2025 00:41:30 -0300 Subject: [PATCH] feat(scope): add OMIT_SCOPE config option --- src/commands/config.ts | 14 ++++++++++++ src/i18n/cs.json | 4 +++- src/i18n/de.json | 4 +++- src/i18n/en.json | 4 +++- src/i18n/es_ES.json | 4 +++- src/i18n/fr.json | 4 +++- src/i18n/id_ID.json | 4 +++- src/i18n/it.json | 4 +++- src/i18n/ja.json | 4 +++- src/i18n/ko.json | 4 +++- src/i18n/nl.json | 4 +++- src/i18n/pl.json | 4 +++- src/i18n/pt_br.json | 4 +++- src/i18n/ru.json | 4 +++- src/i18n/sv.json | 4 +++- src/i18n/th.json | 4 +++- src/i18n/tr.json | 4 +++- src/i18n/vi_VN.json | 4 +++- src/i18n/zh_CN.json | 4 +++- src/i18n/zh_TW.json | 4 +++- src/modules/commitlint/prompts.ts | 24 +++++++++++++++------ src/prompts.ts | 36 +++++++++++++++++++++++++------ test/unit/config.test.ts | 4 +++- 23 files changed, 120 insertions(+), 34 deletions(-) diff --git a/src/commands/config.ts b/src/commands/config.ts index 5381a8d1..6c261523 100644 --- a/src/commands/config.ts +++ b/src/commands/config.ts @@ -25,6 +25,7 @@ export enum CONFIG_KEYS { OCO_ONE_LINE_COMMIT = 'OCO_ONE_LINE_COMMIT', OCO_TEST_MOCK_TYPE = 'OCO_TEST_MOCK_TYPE', OCO_API_URL = 'OCO_API_URL', + OCO_OMIT_SCOPE = 'OCO_OMIT_SCOPE', OCO_GITPUSH = 'OCO_GITPUSH' // todo: deprecate } @@ -232,6 +233,16 @@ export const configValidators = { return value; }, + [CONFIG_KEYS.OCO_OMIT_SCOPE](value: any) { + validateConfig( + CONFIG_KEYS.OCO_OMIT_SCOPE, + typeof value === 'boolean', + 'Must be boolean: true or false' + ); + + return value; + }, + [CONFIG_KEYS.OCO_LANGUAGE](value: any) { const supportedLanguages = Object.keys(i18n); @@ -374,6 +385,7 @@ export type ConfigType = { [CONFIG_KEYS.OCO_AI_PROVIDER]: OCO_AI_PROVIDER_ENUM; [CONFIG_KEYS.OCO_GITPUSH]: boolean; [CONFIG_KEYS.OCO_ONE_LINE_COMMIT]: boolean; + [CONFIG_KEYS.OCO_OMIT_SCOPE]: boolean; [CONFIG_KEYS.OCO_TEST_MOCK_TYPE]: string; }; @@ -421,6 +433,7 @@ export const DEFAULT_CONFIG = { OCO_ONE_LINE_COMMIT: false, OCO_TEST_MOCK_TYPE: 'commit-message', OCO_WHY: false, + OCO_OMIT_SCOPE: false, OCO_GITPUSH: true // todo: deprecate }; @@ -459,6 +472,7 @@ const getEnvConfig = (envPath: string) => { OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE as OCO_PROMPT_MODULE_ENUM, 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_GITPUSH: parseConfigVarValue(process.env.OCO_GITPUSH) // todo: deprecate }; diff --git a/src/i18n/cs.json b/src/i18n/cs.json index c4fdccad..6dd80d75 100644 --- a/src/i18n/cs.json +++ b/src/i18n/cs.json @@ -2,5 +2,7 @@ "localLanguage": "česky", "commitFix": "fix(server.ts): zlepšení velikosti proměnné port na velká písmena PORT", "commitFeat": "feat(server.ts): přidání podpory pro proměnnou prostředí process.env.PORT", - "commitDescription": "Proměnná port se nyní jmenuje PORT, což odpovídá konvenci pojmenování, protože PORT je konstanta. Podpora proměnné prostředí process.env.PORT umožňuje snadnější správu nastavení při spuštění." + "commitDescription": "Proměnná port se nyní jmenuje PORT, což odpovídá konvenci pojmenování, protože PORT je konstanta. Podpora proměnné prostředí process.env.PORT umožňuje snadnější správu nastavení při spuštění.", + "commitFixOmitScope": "fix: zlepšení velikosti proměnné port na velká písmena PORT", + "commitFeatOmitScope": "feat: přidání podpory pro proměnnou prostředí process.env.PORT" } diff --git a/src/i18n/de.json b/src/i18n/de.json index 6e65c140..481e00b0 100644 --- a/src/i18n/de.json +++ b/src/i18n/de.json @@ -2,5 +2,7 @@ "localLanguage": "Deutsch", "commitFix": "fix(server.ts): Ändere die Groß- und Kleinschreibung der Port-Variable von Kleinbuchstaben auf Großbuchstaben PORT.", "commitFeat": "Funktion(server.ts): Unterstützung für die Umgebungsvariable process.env.PORT hinzufügen", - "commitDescription": "Die Port-Variable heißt jetzt PORT, was die Konsistenz mit den Namenskonventionen verbessert, da PORT eine Konstante ist. Die Unterstützung für eine Umgebungsvariable ermöglicht es der Anwendung, flexibler zu sein, da sie jetzt auf jedem verfügbaren Port laufen kann, der über die Umgebungsvariable process.env.PORT angegeben wird." + "commitDescription": "Die Port-Variable heißt jetzt PORT, was die Konsistenz mit den Namenskonventionen verbessert, da PORT eine Konstante ist. Die Unterstützung für eine Umgebungsvariable ermöglicht es der Anwendung, flexibler zu sein, da sie jetzt auf jedem verfügbaren Port laufen kann, der über die Umgebungsvariable process.env.PORT angegeben wird.", + "commitFixOmitScope": "fix: Ändere die Groß- und Kleinschreibung der Port-Variable von Kleinbuchstaben auf Großbuchstaben PORT.", + "commitFeatOmitScope": "Funktion: Unterstützung für die Umgebungsvariable process.env.PORT hinzufügen" } diff --git a/src/i18n/en.json b/src/i18n/en.json index 8bf6e18d..d28723c3 100644 --- a/src/i18n/en.json +++ b/src/i18n/en.json @@ -2,5 +2,7 @@ "localLanguage": "english", "commitFix": "fix(server.ts): change port variable case from lowercase port to uppercase PORT to improve semantics", "commitFeat": "feat(server.ts): add support for process.env.PORT environment variable to be able to run app on a configurable port", - "commitDescription": "The port variable is now named PORT, which improves consistency with the naming conventions as PORT is a constant. Support for an environment variable allows the application to be more flexible as it can now run on any available port specified via the process.env.PORT environment variable." + "commitDescription": "The port variable is now named PORT, which improves consistency with the naming conventions as PORT is a constant. Support for an environment variable allows the application to be more flexible as it can now run on any available port specified via the process.env.PORT environment variable.", + "commitFixOmitScope": "fix: change port variable case from lowercase port to uppercase PORT to improve semantics", + "commitFeatOmitScope": "feat: add support for process.env.PORT environment variable to be able to run app on a configurable port" } diff --git a/src/i18n/es_ES.json b/src/i18n/es_ES.json index 9e566fde..4b38376c 100644 --- a/src/i18n/es_ES.json +++ b/src/i18n/es_ES.json @@ -2,5 +2,7 @@ "localLanguage": "spanish", "commitFix": "fix(server.ts): cambiar la variable port de minúsculas a mayúsculas PORT", "commitFeat": "feat(server.ts): añadir soporte para la variable de entorno process.env.PORT", - "commitDescription": "La variable port ahora se llama PORT, lo que mejora la coherencia con las convenciones de nomenclatura, ya que PORT es una constante. El soporte para una variable de entorno permite que la aplicación sea más flexible, ya que ahora puede ejecutarse en cualquier puerto disponible especificado a través de la variable de entorno process.env.PORT." + "commitDescription": "La variable port ahora se llama PORT, lo que mejora la coherencia con las convenciones de nomenclatura, ya que PORT es una constante. El soporte para una variable de entorno permite que la aplicación sea más flexible, ya que ahora puede ejecutarse en cualquier puerto disponible especificado a través de la variable de entorno process.env.PORT.", + "commitFixOmitScope": "fix: cambiar la variable port de minúsculas a mayúsculas PORT", + "commitFeatOmitScope": "feat: añadir soporte para la variable de entorno process.env.PORT" } diff --git a/src/i18n/fr.json b/src/i18n/fr.json index 2e6c0791..d2710a3f 100644 --- a/src/i18n/fr.json +++ b/src/i18n/fr.json @@ -2,5 +2,7 @@ "localLanguage": "française", "commitFix": "corriger(server.ts) : changer la casse de la variable de port de minuscules à majuscules (PORT)", "commitFeat": "fonctionnalité(server.ts) : ajouter la prise en charge de la variable d'environnement process.env.PORT", - "commitDescription": "La variable de port est maintenant nommée PORT, ce qui améliore la cohérence avec les conventions de nommage car PORT est une constante. La prise en charge d'une variable d'environnement permet à l'application d'être plus flexible car elle peut maintenant s'exécuter sur n'importe quel port disponible spécifié via la variable d'environnement process.env.PORT." + "commitDescription": "La variable de port est maintenant nommée PORT, ce qui améliore la cohérence avec les conventions de nommage car PORT est une constante. La prise en charge d'une variable d'environnement permet à l'application d'être plus flexible car elle peut maintenant s'exécuter sur n'importe quel port disponible spécifié via la variable d'environnement process.env.PORT.", + "commitFixOmitScope": "corriger : changer la casse de la variable de port de minuscules à majuscules (PORT)", + "commitFeatOmitScope": "fonctionnalité : ajouter la prise en charge de la variable d'environnement process.env.PORT" } diff --git a/src/i18n/id_ID.json b/src/i18n/id_ID.json index a0d464af..4f8ab3c8 100644 --- a/src/i18n/id_ID.json +++ b/src/i18n/id_ID.json @@ -2,5 +2,7 @@ "localLanguage": "bahasa", "commitFix": "fix(server.ts): mengubah huruf port variable dari huruf kecil ke huruf besar PORT", "commitFeat": "feat(server.ts): menambahkan support di process.env.PORT environment variabel", - "commitDescription": "Port variabel bernama PORT, yang membantu konsistensi dengan memberi nama yaitu PORT yang konstan. Bantuan environment variabel membantu aplikasi lebih fleksibel, dan dapat di jalankan di port manapun yang tertulis pada process.env.PORT" + "commitDescription": "Port variabel bernama PORT, yang membantu konsistensi dengan memberi nama yaitu PORT yang konstan. Bantuan environment variabel membantu aplikasi lebih fleksibel, dan dapat di jalankan di port manapun yang tertulis pada process.env.PORT", + "commitFixOmitScope": "fix: mengubah huruf port variable dari huruf kecil ke huruf besar PORT", + "commitFeatOmitScope": "feat: menambahkan support di process.env.PORT environment variabel" } diff --git a/src/i18n/it.json b/src/i18n/it.json index c9eaa058..8a9672f9 100644 --- a/src/i18n/it.json +++ b/src/i18n/it.json @@ -2,5 +2,7 @@ "localLanguage": "italiano", "commitFix": "fix(server.ts): cambia la grafia della variabile della porta dal minuscolo port al maiuscolo PORT", "commitFeat": "feat(server.ts): aggiunge il supporto per la variabile di ambiente process.env.PORT", - "commitDescription": "La variabile port è ora chiamata PORT, migliorando la coerenza con le convenzioni di denominazione in quanto PORT è una costante. Il supporto per una variabile di ambiente consente all'applicazione di essere più flessibile poiché ora può essere eseguita su qualsiasi porta disponibile specificata tramite la variabile di ambiente process.env.PORT." + "commitDescription": "La variabile port è ora chiamata PORT, migliorando la coerenza con le convenzioni di denominazione in quanto PORT è una costante. Il supporto per una variabile di ambiente consente all'applicazione di essere più flessibile poiché ora può essere eseguita su qualsiasi porta disponibile specificata tramite la variabile di ambiente process.env.PORT.", + "commitFixOmitScope": "fix: cambia la grafia della variabile della porta dal minuscolo port al maiuscolo PORT", + "commitFeatOmitScope": "feat: aggiunge il supporto per la variabile di ambiente process.env.PORT" } diff --git a/src/i18n/ja.json b/src/i18n/ja.json index 6845b68c..8d6e32d0 100644 --- a/src/i18n/ja.json +++ b/src/i18n/ja.json @@ -2,5 +2,7 @@ "localLanguage": "日本語", "commitFix": "修正(server.ts): ポート変数を小文字のportから大文字のPORTに変更", "commitFeat": "新機能(server.ts): 環境変数process.env.PORTのサポートを追加", - "commitDescription": "ポート変数は現在PORTという名前になり、定数であるPORTを使うことで命名規則に一貫性が生まれました。環境変数をサポートすることで、環境変数process.env.PORTで指定された任意の利用可能なポートで実行できるようになり、アプリケーションはより柔軟になりました。" + "commitDescription": "ポート変数は現在PORTという名前になり、定数であるPORTを使うことで命名規則に一貫性が生まれました。環境変数をサポートすることで、環境変数process.env.PORTで指定された任意の利用可能なポートで実行できるようになり、アプリケーションはより柔軟になりました。", + "commitFixOmitScope": "修正: ポート変数を小文字のportから大文字のPORTに変更", + "commitFeatOmitScope": "新機能: 環境変数process.env.PORTのサポートを追加" } diff --git a/src/i18n/ko.json b/src/i18n/ko.json index cdf511d9..7b335cb5 100644 --- a/src/i18n/ko.json +++ b/src/i18n/ko.json @@ -2,5 +2,7 @@ "localLanguage": "한국어", "commitFix": "fix(server.ts): 포트 변수를 소문자 port에서 대문자 PORT로 변경", "commitFeat": "피트(server.ts): process.env.PORT 환경 변수 지원 추가", - "commitDescription": "포트 변수는 이제 PORT로 이름이 지정되어 상수인 PORT와 일관성 있는 이름 규칙을 따릅니다. 환경 변수 지원을 통해 애플리케이션은 이제 process.env.PORT 환경 변수로 지정된 사용 가능한 모든 포트에서 실행할 수 있으므로 더 유연해졌습니다." + "commitDescription": "포트 변수는 이제 PORT로 이름이 지정되어 상수인 PORT와 일관성 있는 이름 규칙을 따릅니다. 환경 변수 지원을 통해 애플리케이션은 이제 process.env.PORT 환경 변수로 지정된 사용 가능한 모든 포트에서 실행할 수 있으므로 더 유연해졌습니다.", + "commitFixOmitScope": "fix: 포트 변수를 소문자 port에서 대문자 PORT로 변경", + "commitFeatOmitScope": "피트: process.env.PORT 환경 변수 지원 추가" } diff --git a/src/i18n/nl.json b/src/i18n/nl.json index 69cf3566..7880a34a 100644 --- a/src/i18n/nl.json +++ b/src/i18n/nl.json @@ -2,5 +2,7 @@ "localLanguage": "Nederlands", "commitFix": "fix(server.ts): verander poortvariabele van kleine letters poort naar hoofdletters PORT", "commitFeat": "feat(server.ts): voeg ondersteuning toe voor process.env.PORT omgevingsvariabele", - "commitDescription": "De poortvariabele heet nu PORT, wat de consistentie met de naamgevingsconventies verbetert omdat PORT een constante is. Ondersteuning voor een omgevingsvariabele maakt de applicatie flexibeler, omdat deze nu kan draaien op elke beschikbare poort die is gespecificeerd via de process.env.PORT omgevingsvariabele." + "commitDescription": "De poortvariabele heet nu PORT, wat de consistentie met de naamgevingsconventies verbetert omdat PORT een constante is. Ondersteuning voor een omgevingsvariabele maakt de applicatie flexibeler, omdat deze nu kan draaien op elke beschikbare poort die is gespecificeerd via de process.env.PORT omgevingsvariabele.", + "commitFixOmitScope": "fix: verander poortvariabele van kleine letters poort naar hoofdletters PORT", + "commitFeatOmitScope": "feat: voeg ondersteuning toe voor process.env.PORT omgevingsvariabele" } diff --git a/src/i18n/pl.json b/src/i18n/pl.json index d3c2bbbd..ff94600a 100644 --- a/src/i18n/pl.json +++ b/src/i18n/pl.json @@ -2,5 +2,7 @@ "localLanguage": "polski", "commitFix": "fix(server.ts): poprawa wielkości zmiennej port na pisane z dużymi literami PORT", "commitFeat": "feat(server.ts): dodanie obsługi zmiennej środowiskowej process.env.PORT", - "commitDescription": "Zmienna port jest teraz nazwana PORT, co jest zgodne z konwencją nazewniczą ponieważ PORT jest stałą. Obsługa zmiennej środowiskowej process.env.PORT pozwala łatwiej zarządzać ustawieniami przy starcie." + "commitDescription": "Zmienna port jest teraz nazwana PORT, co jest zgodne z konwencją nazewniczą ponieważ PORT jest stałą. Obsługa zmiennej środowiskowej process.env.PORT pozwala łatwiej zarządzać ustawieniami przy starcie.", + "commitFixOmitScope": "fix: poprawa wielkości zmiennej port na pisane z dużymi literami PORT", + "commitFeatOmitScope": "feat: dodanie obsługi zmiennej środowiskowej process.env.PORT" } diff --git a/src/i18n/pt_br.json b/src/i18n/pt_br.json index 02cd4c58..9a27d909 100644 --- a/src/i18n/pt_br.json +++ b/src/i18n/pt_br.json @@ -2,5 +2,7 @@ "localLanguage": "português", "commitFix": "fix(server.ts): altera o caso da variável de porta de port minúscula para PORT maiúscula", "commitFeat": "feat(server.ts): adiciona suporte para a variável de ambiente process.env.PORT", - "commitDescription": "A variável de porta agora é denominada PORT, o que melhora a consistência com as convenções de nomenclatura, pois PORT é uma constante. O suporte para uma variável de ambiente permite que o aplicativo seja mais flexível, pois agora pode ser executado em qualquer porta disponível especificada por meio da variável de ambiente process.env.PORT." + "commitDescription": "A variável de porta agora é denominada PORT, o que melhora a consistência com as convenções de nomenclatura, pois PORT é uma constante. O suporte para uma variável de ambiente permite que o aplicativo seja mais flexível, pois agora pode ser executado em qualquer porta disponível especificada por meio da variável de ambiente process.env.PORT.", + "commitFixOmitScope": "fix: altera o caso da variável de porta de port minúscula para PORT maiúscula", + "commitFeatOmitScope": "feat: adiciona suporte para a variável de ambiente process.env.PORT" } diff --git a/src/i18n/ru.json b/src/i18n/ru.json index 3fcc6b85..8b064a10 100644 --- a/src/i18n/ru.json +++ b/src/i18n/ru.json @@ -2,5 +2,7 @@ "localLanguage": "русский", "commitFix": "fix(server.ts): изменение регистра переменной порта с нижнего регистра port на верхний регистр PORT", "commitFeat": "feat(server.ts): добавлена поддержка переменной окружения process.env.PORT", - "commitDescription": "Переменная port теперь называется PORT, что улучшает согласованность с соглашениями об именовании констант. Поддержка переменной окружения позволяет приложению быть более гибким, запускаясь на любом доступном порту, указанном с помощью переменной окружения process.env.PORT." + "commitDescription": "Переменная port теперь называется PORT, что улучшает согласованность с соглашениями об именовании констант. Поддержка переменной окружения позволяет приложению быть более гибким, запускаясь на любом доступном порту, указанном с помощью переменной окружения process.env.PORT.", + "commitFixOmitScope": "fix: изменение регистра переменной порта с нижнего регистра port на верхний регистр PORT", + "commitFeatOmitScope": "feat: добавлена поддержка переменной окружения process.env.PORT" } diff --git a/src/i18n/sv.json b/src/i18n/sv.json index 7cd65ee0..fef841b3 100644 --- a/src/i18n/sv.json +++ b/src/i18n/sv.json @@ -2,5 +2,7 @@ "localLanguage": "svenska", "commitFix": "fixa(server.ts): ändra variabelnamnet för port från små bokstäver till stora bokstäver PORT", "commitFeat": "nyhet(server.ts): lägg till stöd för process.env.PORT miljövariabel", - "commitDescription": "Variabeln som innehåller portnumret heter nu PORT vilket förbättrar konsekvensen med namngivningskonventionerna eftersom PORT är en konstant. Stöd för en miljövariabel gör att applikationen kan vara mer flexibel då den nu kan köras på vilken port som helst som specificeras via miljövariabeln process.env.PORT." + "commitDescription": "Variabeln som innehåller portnumret heter nu PORT vilket förbättrar konsekvensen med namngivningskonventionerna eftersom PORT är en konstant. Stöd för en miljövariabel gör att applikationen kan vara mer flexibel då den nu kan köras på vilken port som helst som specificeras via miljövariabeln process.env.PORT.", + "commitFixOmitScope": "fixa: ändra variabelnamnet för port från små bokstäver till stora bokstäver PORT", + "commitFeatOmitScope": "nyhet: lägg till stöd för process.env.PORT miljövariabel" } diff --git a/src/i18n/th.json b/src/i18n/th.json index 6a9800c0..8900e96e 100644 --- a/src/i18n/th.json +++ b/src/i18n/th.json @@ -2,5 +2,7 @@ "localLanguage": "ไทย", "commitFix": "fix(server.ts): เปลี่ยนตัวพิมพ์ของตัวแปร จากตัวพิมพ์เล็ก port เป็นตัวพิมพ์ใหญ่ PORT", "commitFeat": "feat(server.ts): เพิ่มการรองรับสำหรับตัวแปรสภาพแวดล้อม process.env.PORT", - "commitDescription": "ตอนนี้ตัวแปรพอร์ตมีชื่อว่า PORT, ซึ่งปรับปรุงความสอดคล้องกับหลักการตั้งชื่อเนื่องจาก PORT เป็นค่าคงที่. การสนับสนุนสำหรับตัวแปรสภาพแวดล้อม ช่วยให้แอปพลิเคชันมีความยืดหยุ่นมากขึ้นเนื่องจาก สามารถทำงานบนพอร์ตใด ๆ ตามที่กำหนด ซึ่งระบุผ่านตัวแปรสภาพแวดล้อม process.env.PORT" + "commitDescription": "ตอนนี้ตัวแปรพอร์ตมีชื่อว่า PORT, ซึ่งปรับปรุงความสอดคล้องกับหลักการตั้งชื่อเนื่องจาก PORT เป็นค่าคงที่. การสนับสนุนสำหรับตัวแปรสภาพแวดล้อม ช่วยให้แอปพลิเคชันมีความยืดหยุ่นมากขึ้นเนื่องจาก สามารถทำงานบนพอร์ตใด ๆ ตามที่กำหนด ซึ่งระบุผ่านตัวแปรสภาพแวดล้อม process.env.PORT", + "commitFixOmitScope": "fix: เปลี่ยนตัวพิมพ์ของตัวแปร จากตัวพิมพ์เล็ก port เป็นตัวพิมพ์ใหญ่ PORT", + "commitFeatOmitScope": "feat: เพิ่มการรองรับสำหรับตัวแปรสภาพแวดล้อม process.env.PORT" } diff --git a/src/i18n/tr.json b/src/i18n/tr.json index e6674198..c5fa45ad 100644 --- a/src/i18n/tr.json +++ b/src/i18n/tr.json @@ -2,5 +2,7 @@ "localLanguage": "Turkish", "commitFix": "fix(server.ts): port değişkeni küçük harfli porttan büyük harfli PORT'a değiştirildi", "commitFeat": "feat(server.ts): process.env.PORT ortam değişkeni için destek eklendi.", - "commitDescription": "Bağlantı noktası değişkeni artık PORT olarak adlandırıldı ve PORT bir sabit değişken olduğu için bu adlandırma tutarlılığı artırır. Ortam değişkeni desteği, artık process.env.PORT ortam değişkeni aracılığıyla belirtilen herhangi bir kullanılabilir bağlantı noktasında çalışabileceğinden uygulamanın daha esnek olmasını sağlar." + "commitDescription": "Bağlantı noktası değişkeni artık PORT olarak adlandırıldı ve PORT bir sabit değişken olduğu için bu adlandırma tutarlılığı artırır. Ortam değişkeni desteği, artık process.env.PORT ortam değişkeni aracılığıyla belirtilen herhangi bir kullanılabilir bağlantı noktasında çalışabileceğinden uygulamanın daha esnek olmasını sağlar.", + "commitFixOmitScope": "fix: port değişkeni küçük harfli porttan büyük harfli PORT'a değiştirildi", + "commitFeatOmitScope": "feat: process.env.PORT ortam değişkeni için destek eklendi." } diff --git a/src/i18n/vi_VN.json b/src/i18n/vi_VN.json index 22d56412..01838f41 100644 --- a/src/i18n/vi_VN.json +++ b/src/i18n/vi_VN.json @@ -2,5 +2,7 @@ "localLanguage": "vietnamese", "commitFix": "fix(server.ts): thay đổi chữ viết thường của biến port thành chữ viết hoa PORT", "commitFeat": "feat(server.ts): thêm hỗ trợ cho biến môi trường process.env.PORT", - "commitDescription": "Biến port đã được đổi tên thành PORT, giúp cải thiện tính nhất quán trong việc đặt tên theo quy ước vì PORT là một hằng số. Hỗ trợ cho biến môi trường cho phép ứng dụng linh hoạt hơn khi có thể chạy trên bất kỳ cổng nào được chỉ định thông qua biến môi trường process.env.PORT." + "commitDescription": "Biến port đã được đổi tên thành PORT, giúp cải thiện tính nhất quán trong việc đặt tên theo quy ước vì PORT là một hằng số. Hỗ trợ cho biến môi trường cho phép ứng dụng linh hoạt hơn khi có thể chạy trên bất kỳ cổng nào được chỉ định thông qua biến môi trường process.env.PORT.", + "commitFixOmitScope": "fix: thay đổi chữ viết thường của biến port thành chữ viết hoa PORT", + "commitFeatOmitScope": "feat: thêm hỗ trợ cho biến môi trường process.env.PORT" } diff --git a/src/i18n/zh_CN.json b/src/i18n/zh_CN.json index 8a25af3f..ae070fbe 100644 --- a/src/i18n/zh_CN.json +++ b/src/i18n/zh_CN.json @@ -2,5 +2,7 @@ "localLanguage": "简体中文", "commitFix": "fix(server.ts):将端口变量从小写port改为大写PORT", "commitFeat": "feat(server.ts):添加对process.env.PORT环境变量的支持", - "commitDescription": "现在端口变量被命名为PORT,这提高了命名约定的一致性,因为PORT是一个常量。环境变量的支持使应用程序更加灵活,因为它现在可以通过process.env.PORT环境变量在任何可用端口上运行。" + "commitDescription": "现在端口变量被命名为PORT,这提高了命名约定的一致性,因为PORT是一个常量。环境变量的支持使应用程序更加灵活,因为它现在可以通过process.env.PORT环境变量在任何可用端口上运行。", + "commitFixOmitScope": "fix:将端口变量从小写port改为大写PORT", + "commitFeatOmitScope": "feat:添加对process.env.PORT环境变量的支持" } diff --git a/src/i18n/zh_TW.json b/src/i18n/zh_TW.json index f3f85fba..8e703500 100644 --- a/src/i18n/zh_TW.json +++ b/src/i18n/zh_TW.json @@ -2,5 +2,7 @@ "localLanguage": "繁體中文", "commitFix": "修正(server.ts):將端口變數從小寫端口改為大寫PORT", "commitFeat": "功能(server.ts):新增對process.env.PORT環境變數的支援", - "commitDescription": "現在port變數已更名為PORT,以符合命名慣例,因為PORT是一個常量。支援環境變數可以使應用程序更靈活,因為它現在可以通過process.env.PORT環境變數運行在任何可用端口上。" + "commitDescription": "現在port變數已更名為PORT,以符合命名慣例,因為PORT是一個常量。支援環境變數可以使應用程序更靈活,因為它現在可以通過process.env.PORT環境變數運行在任何可用端口上。", + "commitFixOmitScope": "修正:將端口變數從小寫端口改為大寫PORT", + "commitFeatOmitScope": "功能:新增對process.env.PORT環境變數的支援" } diff --git a/src/modules/commitlint/prompts.ts b/src/modules/commitlint/prompts.ts index 8a1c91a1..445e09d8 100644 --- a/src/modules/commitlint/prompts.ts +++ b/src/modules/commitlint/prompts.ts @@ -204,7 +204,11 @@ export const inferPromptsFromCommitlintConfig = ( * ubiquitous language from @commitlint. * While gpt-4 does this on it self, gpt-3.5 can't map this on his own atm. */ -const STRUCTURE_OF_COMMIT = ` +const STRUCTURE_OF_COMMIT = config.OCO_OMIT_SCOPE + ? ` +- Header of commit is composed of type and subject: <type-of-commit>: <subject-of-commit> +- Description of commit is composed of body and footer (optional): <body-of-commit>\n<footer(s)-of-commit>` + : ` - Header of commit is composed of type, scope, subject: <type-of-commit>(<scope-of-commit>): <subject-of-commit> - Description of commit is composed of body and footer (optional): <body-of-commit>\n<footer(s)-of-commit>`; @@ -221,7 +225,7 @@ Here are the specific requirements and conventions that should be strictly follo Commit Message Conventions: - The commit message consists of three parts: Header, Body, and Footer. - Header: - - Format: \`<type>(<scope>): <subject>\` + - Format: ${config.OCO_OMIT_SCOPE ? '`<type>: <subject>`' : '`<type>(<scope>): <subject>`'} - ${prompts.join('\n- ')} JSON Output Format: @@ -229,8 +233,10 @@ JSON Output Format: \`\`\`json { "localLanguage": "${translation.localLanguage}", - "commitFix": "<Header of commit for bug fix>", - "commitFeat": "<Header of commit for feature>", + "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>" } \`\`\` @@ -238,8 +244,8 @@ JSON Output Format: - Description should not be more than 74 characters. Additional Details: -- Changing the variable 'port' to uppercase 'PORT' is considered a bug fix. -- Allowing the server to listen on a port specified through the environment variable is considered a new feature. +- Changing the variable 'port' to uppercase 'PORT' is considered a bug fix. +- Allowing the server to listen on a port specified through the environment variable is considered a new feature. Example Git Diff is to follow:` }, @@ -277,7 +283,11 @@ ${ ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.' : '' } - +${ + config.OCO_OMIT_SCOPE + ? 'Do not include a scope in the commit message format. Use the format: <type>: <subject>' + : '' +} You will strictly follow the following conventions to generate the content of the commit message: - ${prompts.join('\n- ')} diff --git a/src/prompts.ts b/src/prompts.ts index 78a5ecd7..13da9238 100644 --- a/src/prompts.ts +++ b/src/prompts.ts @@ -111,6 +111,11 @@ const getOneLineCommitInstruction = () => ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.' : ''; +const getScopeInstruction = () => + config.OCO_OMIT_SCOPE + ? 'Do not include a scope in the commit message format. Use the format: <type>: <subject>' + : ''; + /** * Get the context of the user input * @param extraArgs - The arguments passed to the command line @@ -141,10 +146,11 @@ const INIT_MAIN_PROMPT = ( const conventionGuidelines = getCommitConvention(fullGitMojiSpec); const descriptionGuideline = getDescriptionInstruction(); const oneLineCommitGuideline = getOneLineCommitInstruction(); + const scopeInstruction = getScopeInstruction(); const generalGuidelines = `Use the present tense. Lines must not be longer than 74 characters. Use ${language} for the commit message.`; const userInputContext = userInputCodeContext(context); - return `${missionStatement}\n${diffInstruction}\n${conventionGuidelines}\n${descriptionGuideline}\n${oneLineCommitGuideline}\n${generalGuidelines}\n${userInputContext}`; + return `${missionStatement}\n${diffInstruction}\n${conventionGuidelines}\n${descriptionGuideline}\n${oneLineCommitGuideline}\n${scopeInstruction}\n${generalGuidelines}\n${userInputContext}`; })() }); @@ -178,13 +184,29 @@ export const INIT_DIFF_PROMPT: OpenAI.Chat.Completions.ChatCompletionMessagePara }; const getContent = (translation: ConsistencyPrompt) => { - const fix = config.OCO_EMOJI - ? `🐛 ${removeConventionalCommitWord(translation.commitFix)}` - : translation.commitFix; + const getCommitString = (commitWithScope: string, commitWithoutScope?: string) => { + if (config.OCO_OMIT_SCOPE && commitWithoutScope) { + return config.OCO_EMOJI + ? `🐛 ${removeConventionalCommitWord(commitWithoutScope)}` + : commitWithoutScope; + } + return config.OCO_EMOJI + ? `🐛 ${removeConventionalCommitWord(commitWithScope)}` + : commitWithScope; + }; + + const fix = getCommitString( + translation.commitFix, + translation.commitFixOmitScope + ); - const feat = config.OCO_EMOJI - ? `✨ ${removeConventionalCommitWord(translation.commitFeat)}` - : translation.commitFeat; + const feat = config.OCO_OMIT_SCOPE && translation.commitFeatOmitScope + ? (config.OCO_EMOJI + ? `✨ ${removeConventionalCommitWord(translation.commitFeatOmitScope)}` + : translation.commitFeatOmitScope) + : (config.OCO_EMOJI + ? `✨ ${removeConventionalCommitWord(translation.commitFeat)}` + : translation.commitFeat); const description = config.OCO_DESCRIPTION ? translation.commitDescription diff --git a/test/unit/config.test.ts b/test/unit/config.test.ts index 49a84ae6..89ffc7e4 100644 --- a/test/unit/config.test.ts +++ b/test/unit/config.test.ts @@ -106,7 +106,8 @@ describe('config', () => { envConfigFile = await generateConfig('.env', { OCO_TOKENS_MAX_INPUT: '8192', - OCO_ONE_LINE_COMMIT: 'false' + OCO_ONE_LINE_COMMIT: 'false', + OCO_OMIT_SCOPE: 'true' }); const config = getConfig({ @@ -119,6 +120,7 @@ describe('config', () => { expect(config.OCO_TOKENS_MAX_OUTPUT).toEqual(500); expect(config.OCO_GITPUSH).toEqual(true); expect(config.OCO_ONE_LINE_COMMIT).toEqual(false); + expect(config.OCO_OMIT_SCOPE).toEqual(true); }); it('should handle empty local config correctly', async () => {