Add model selection to OpenAI setup for enhanced customization

package.json

@@ -1,6 +1,6 @@
 {
   "name": "commitfy",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "main": "lib/index.js",
   "repository": "https://github.com/ribeirogab/commitfy.git",
   "author": "ribeirogab <ribeirogabx@gmail.com>",

src/interfaces/utils/env.utils.ts

@@ -1,11 +1,15 @@
+import type { ChatModel } from 'openai/resources';
+
 import type { SetupContextEnum } from '../commands/setup';
 import type { ProviderEnum } from '../provider';
 
 export type Env = {
   PROVIDER?: ProviderEnum;
+  SETUP_CONTEXT: SetupContextEnum;
+
   OPENAI_API_KEY?: string;
   OPENAI_N_COMMITS?: number | string;
-  SETUP_CONTEXT: SetupContextEnum;
+  OPENAI_CHAT_MODEL?: ChatModel;
 
   CONFIG_COMMIT_LANGUAGE: string;
   CONFIG_MAX_COMMIT_CHARACTERS: string | number;

src/interfaces/utils/input.utils.ts

@@ -29,5 +29,5 @@ export interface InputList extends DefaultInput {
 export type InputPromptDto = Input | InputList;
 
 export interface InputUtils {
-  prompt(input: InputPromptDto): Promise<string>;
+  prompt<T = string>(input: InputPromptDto): Promise<T>;
 }

src/providers/openai.provider.spec.ts

@@ -132,6 +132,7 @@ describe('OpenAIProvider', () => {
 
       vi.spyOn(inputUtils, 'prompt')
         .mockResolvedValueOnce('new-api-key')
+        .mockResolvedValueOnce('chat-model')
         .mockResolvedValueOnce('3');
 
       const loggerMessageSpy = vi.spyOn(appUtils.logger, 'message');
@@ -144,6 +145,7 @@ describe('OpenAIProvider', () => {
 
       expect(envUtils.update).toHaveBeenCalledWith({
         ...DEFAULT_ENV,
+        OPENAI_CHAT_MODEL: 'chat-model',
         OPENAI_API_KEY: 'new-api-key',
         OPENAI_N_COMMITS: 3,
         PROVIDER: ProviderEnum.OpenAI,

src/providers/openai.provider.ts

@@ -1,7 +1,9 @@
 import { OpenAI } from 'openai';
+import type { ChatModel } from 'openai/resources';
 
 import {
   type AppUtils,
+  type Env,
   type EnvUtils,
   type GenerateCommitMessagesDto,
   InputTypeEnum,
@@ -14,6 +16,16 @@ import { DEFAULT_N_COMMITS } from '@/constants';
 export class OpenAIProvider implements Provider {
   private openai: OpenAI;
 
+  private readonly defaultChatModel: ChatModel = 'gpt-4o-mini';
+  private readonly chatModels: ChatModel[] = [
+    'gpt-4o',
+    'gpt-4o-mini',
+    'gpt-4-turbo',
+    'gpt-4-vision-preview',
+    'gpt-4',
+    'gpt-3.5-turbo',
+  ];
+
   constructor(
     private readonly envUtils: EnvUtils,
     private readonly inputUtils: InputUtils,
@@ -52,6 +64,18 @@ export class OpenAIProvider implements Provider {
         type: InputTypeEnum.Input,
       });
 
+      const chatModel = await this.inputUtils.prompt<ChatModel>({
+        default: env.OPENAI_CHAT_MODEL || this.defaultChatModel,
+        message:
+          'Choose your OpenAI language model (https://platform.openai.com/docs/models):',
+        type: 'list',
+        choices: this.chatModels.map((model) => ({
+          value: model,
+          short: model,
+          name: model,
+        })),
+      });
+
       const numberOfCommits = await this.inputUtils.prompt({
         default: env.OPENAI_N_COMMITS ? String(env.OPENAI_N_COMMITS) : '2',
         message: 'Enter the number of commits to generate:',
@@ -62,6 +86,7 @@ export class OpenAIProvider implements Provider {
         ...env,
         OPENAI_N_COMMITS: Number(numberOfCommits),
         PROVIDER: ProviderEnum.OpenAI,
+        OPENAI_CHAT_MODEL: chatModel,
         OPENAI_API_KEY: apiKey,
       });
 
@@ -92,14 +117,16 @@ export class OpenAIProvider implements Provider {
     diff,
   }: GenerateCommitMessagesDto): Promise<string[]> {
     try {
-      this.checkRequiredEnvVars();
+      const env = this.envUtils.variables();
+
+      this.checkRequiredEnvVars(env);
 
       const chatCompletion = await this.client.chat.completions.create({
         messages: [
           { role: 'user', content: prompt },
-          { role: 'user', content: diff },
+          { role: 'user', content: `git diff:\n${diff}` },
         ],
-        model: 'gpt-3.5-turbo',
+        model: env.OPENAI_CHAT_MODEL || this.defaultChatModel,
         max_tokens: 50,
         n,
       });
@@ -125,8 +152,8 @@ export class OpenAIProvider implements Provider {
     }
   }
 
-  private checkRequiredEnvVars(): void {
-    if (!this.envUtils.variables().OPENAI_API_KEY) {
+  private checkRequiredEnvVars(env: Env): void {
+    if (!env.OPENAI_API_KEY) {
       this.appUtils.logger.error('OPENAI_API_KEY is required');
       this.appUtils.logger.message("Run 'commitfy setup' to set up.");
       process.exit(0);

src/utils/input.utils.ts

@@ -8,7 +8,7 @@ import {
 } from '@/interfaces';
 
 export class InputUtils implements InputUtilsInterface {
-  public async prompt(input: InputPromptDto) {
+  public async prompt<T = string>(input: InputPromptDto) {
     try {
       const promptDto = [{ name: 'data', ...input }];
 
@@ -24,7 +24,7 @@ export class InputUtils implements InputUtilsInterface {
         Object.assign(promptDto[0], { choices: choicesWithCustom });
       }
 
-      const { data } = await inquirer.prompt(promptDto as never);
+      const { data } = await inquirer.prompt<{ data: T }>(promptDto as never);
 
       return data;
     } catch (error) {