feat: read config from process.env

Author: 0xKrauser

src/commands/config.ts

@@ -9,8 +9,8 @@ import { COMMANDS } from '../CommandsEnum';
 
 export enum CONFIG_KEYS {
   OPENAI_API_KEY = 'OPENAI_API_KEY',
-  description = 'description',
-  emoji = 'emoji'
+  OPENCOMMIT_DESCRIPTION = 'OPENCOMMIT_DESCRIPTION',
+  OPENCOMMIT_EMOJI = 'OPENCOMMIT_EMOJI'
 }
 
 export enum CONFIG_MODES {
@@ -47,23 +47,25 @@ export const configValidators = {
 
     return value;
   },
-  [CONFIG_KEYS.description](value: any) {
+  [CONFIG_KEYS.OPENCOMMIT_DESCRIPTION](value: any) {
+    const parsedValue = typeof value === 'boolean' || value === 'true' ? value : 'false'
     validateConfig(
-      CONFIG_KEYS.description,
-      typeof value === 'boolean',
+      CONFIG_KEYS.OPENCOMMIT_DESCRIPTION,
+      typeof parsedValue === 'boolean',
       'Must be true or false'
     );
 
-    return value;
+    return parsedValue;
   },
-  [CONFIG_KEYS.emoji](value: any) {
+  [CONFIG_KEYS.OPENCOMMIT_EMOJI](value: any) {
+    const parsedValue = typeof value === 'boolean' || value === 'true' ? value : 'false'
     validateConfig(
-      CONFIG_KEYS.emoji,
-      typeof value === 'boolean',
+      CONFIG_KEYS.OPENCOMMIT_EMOJI,
+      typeof parsedValue === 'boolean',
       'Must be true or false'
     );
 
-    return value;
+    return parsedValue;
   }
 };
 
@@ -75,14 +77,13 @@ const configPath = pathJoin(homedir(), '.opencommit');
 
 export const getConfig = (): ConfigType | null => {
   const configExists = existsSync(configPath);
-  if (!configExists) return null;
 
-  const configFile = readFileSync(configPath, 'utf8');
-  const config = iniParse(configFile);
+  const configFile = configExists ? readFileSync(configPath, 'utf8') : '';
+  const config = configFile? iniParse(configFile) : {};
 
-  for (const configKey of Object.keys(config)) {
+  for (const configKey in CONFIG_KEYS) {
     const validValue = configValidators[configKey as CONFIG_KEYS](
-      config[configKey]
+      config.hasOwnProperty(configKey) ? config[configKey] : process.env[configKey]
     );
 
     config[configKey] = validValue;

src/generateCommitMessageFromGitDiff.ts

@@ -3,7 +3,7 @@ import {
   ChatCompletionRequestMessageRoleEnum
 } from 'openai';
 import { api } from './api';
-import { getConfig } from './commands/config';
+import { CONFIG_KEYS, getConfig } from './commands/config';
 import { mergeStrings } from './utils/mergeStrings';
 
 const config = getConfig();
@@ -12,11 +12,11 @@ const INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
   {
     role: ChatCompletionRequestMessageRoleEnum.System,
     content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message. ${
-      config?.emoji
+      config?.[CONFIG_KEYS.OPENCOMMIT_EMOJI]
         ? 'Use Gitmoji convention to preface the commit'
         : 'Do not preface the commit with anything'
     }, use the present tense. ${
-      config?.description
+      config?.[CONFIG_KEYS.OPENCOMMIT_DESCRIPTION]
         ? 'Add a short description of what commit is about after the commit message. Don\'t start it with "This commit", just describe the changes.'
         : "Don't add any descriptions to the commit, only commit message."
     }`
@@ -49,9 +49,9 @@ const INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
   {
     role: ChatCompletionRequestMessageRoleEnum.Assistant,
     // prettier-ignore
-    content: `${config?.emoji ? '🐛 ' : ''}fix(server.ts): change port variable case from lowercase port to uppercase PORT
-${config?.emoji ? '✨ ' : ''}feat(server.ts): add support for process.env.PORT environment variable
-${config?.description ? '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.' : ''}`
+    content: `${config?.[CONFIG_KEYS.OPENCOMMIT_EMOJI] ? '🐛 ' : ''}fix(server.ts): change port variable case from lowercase port to uppercase PORT
+${config?.[CONFIG_KEYS.OPENCOMMIT_EMOJI] ? '✨ ' : ''}feat(server.ts): add support for process.env.PORT environment variable
+${config?.[CONFIG_KEYS.OPENCOMMIT_DESCRIPTION] ? '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.' : ''}`
   }
 ];