GitHub action (#173)

* add option to run OpenCommit as a Github Action

src/commands/config.ts

@@ -8,14 +8,18 @@ import chalk from 'chalk';
 import { COMMANDS } from '../CommandsEnum';
 import { getI18nLocal } from '../i18n';
 
+import * as dotenv from 'dotenv';
+
+dotenv.config();
+
 export enum CONFIG_KEYS {
-  OPENAI_API_KEY = 'OPENAI_API_KEY',
-  OPENAI_MAX_TOKENS = 'OPENAI_MAX_TOKENS',
-  OPENAI_BASE_PATH = 'OPENAI_BASE_PATH',
-  description = 'description',
-  emoji = 'emoji',
-  model = 'model',
-  language = 'language'
+  OCO_OPENAI_API_KEY = 'OCO_OPENAI_API_KEY',
+  OCO_OPENAI_MAX_TOKENS = 'OCO_OPENAI_MAX_TOKENS',
+  OCO_OPENAI_BASE_PATH = 'OCO_OPENAI_BASE_PATH',
+  OCO_DESCRIPTION = 'OCO_DESCRIPTION',
+  OCO_EMOJI = 'OCO_EMOJI',
+  OCO_MODEL = 'OCO_MODEL',
+  OCO_LANGUAGE = 'OCO_LANGUAGE'
 }
 
 export enum CONFIG_MODES {
@@ -38,15 +42,15 @@ const validateConfig = (
 };
 
 export const configValidators = {
-  [CONFIG_KEYS.OPENAI_API_KEY](value: any) {
-    validateConfig(CONFIG_KEYS.OPENAI_API_KEY, value, 'Cannot be empty');
+  [CONFIG_KEYS.OCO_OPENAI_API_KEY](value: any) {
+    validateConfig(CONFIG_KEYS.OCO_OPENAI_API_KEY, value, 'Cannot be empty');
     validateConfig(
-      CONFIG_KEYS.OPENAI_API_KEY,
+      CONFIG_KEYS.OCO_OPENAI_API_KEY,
       value.startsWith('sk-'),
       'Must start with "sk-"'
     );
     validateConfig(
-      CONFIG_KEYS.OPENAI_API_KEY,
+      CONFIG_KEYS.OCO_OPENAI_API_KEY,
       value.length === 51,
       'Must be 51 characters long'
     );
@@ -54,9 +58,9 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.description](value: any) {
+  [CONFIG_KEYS.OCO_DESCRIPTION](value: any) {
     validateConfig(
-      CONFIG_KEYS.description,
+      CONFIG_KEYS.OCO_DESCRIPTION,
       typeof value === 'boolean',
       'Must be true or false'
     );
@@ -64,18 +68,18 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.OPENAI_MAX_TOKENS](value: any) {
+  [CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS](value: any) {
     // If the value is a string, convert it to a number.
     if (typeof value === 'string') {
       value = parseInt(value);
       validateConfig(
-        CONFIG_KEYS.OPENAI_MAX_TOKENS,
+        CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
         !isNaN(value),
         'Must be a number'
       );
     }
     validateConfig(
-      CONFIG_KEYS.OPENAI_MAX_TOKENS,
+      CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
       typeof value === 'number',
       'Must be a number'
     );
@@ -83,9 +87,9 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.emoji](value: any) {
+  [CONFIG_KEYS.OCO_EMOJI](value: any) {
     validateConfig(
-      CONFIG_KEYS.emoji,
+      CONFIG_KEYS.OCO_EMOJI,
       typeof value === 'boolean',
       'Must be true or false'
     );
@@ -93,27 +97,27 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.language](value: any) {
+  [CONFIG_KEYS.OCO_LANGUAGE](value: any) {
     validateConfig(
-      CONFIG_KEYS.language,
+      CONFIG_KEYS.OCO_LANGUAGE,
       getI18nLocal(value),
       `${value} is not supported yet`
     );
     return getI18nLocal(value);
   },
 
-  [CONFIG_KEYS.OPENAI_BASE_PATH](value: any) {
+  [CONFIG_KEYS.OCO_OPENAI_BASE_PATH](value: any) {
     validateConfig(
-      CONFIG_KEYS.OPENAI_BASE_PATH,
+      CONFIG_KEYS.OCO_OPENAI_BASE_PATH,
       typeof value === 'string',
       'Must be string'
     );
     return value;
   },
 
-  [CONFIG_KEYS.model](value: any) {
+  [CONFIG_KEYS.OCO_MODEL](value: any) {
     validateConfig(
-      CONFIG_KEYS.OPENAI_BASE_PATH,
+      CONFIG_KEYS.OCO_OPENAI_BASE_PATH,
       value === 'gpt-3.5-turbo' || value === 'gpt-4',
       `${value} is not supported yet, use 'gpt-4' or 'gpt-3.5-turbo' (default)`
     );
@@ -128,18 +132,39 @@ export type ConfigType = {
 const configPath = pathJoin(homedir(), '.opencommit');
 
 export const getConfig = (): ConfigType | null => {
+  const configFromEnv = {
+    OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
+    OCO_OPENAI_MAX_TOKENS: Number(process.env.OCO_OPENAI_MAX_TOKENS),
+    OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
+    OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === 'true' ? true : false,
+    OCO_EMOJI: process.env.OCO_EMOJI === 'true' ? true : false,
+    OCO_MODEL: process.env.OCO_MODEL,
+    OCO_LANGUAGE: process.env.OCO_LANGUAGE
+  };
+
   const configExists = existsSync(configPath);
-  if (!configExists) return null;
+  if (!configExists) return configFromEnv;
 
   const configFile = readFileSync(configPath, 'utf8');
   const config = iniParse(configFile);
 
   for (const configKey of Object.keys(config)) {
-    const validValue = configValidators[configKey as CONFIG_KEYS](
-      config[configKey]
-    );
+    try {
+      const validator = configValidators[configKey as CONFIG_KEYS];
+      const validValue = validator(
+        config[configKey] ?? configFromEnv[configKey as CONFIG_KEYS]
+      );
 
-    config[configKey] = validValue;
+      config[configKey] = validValue;
+    } catch (error) {
+      outro(
+        `'${configKey}' name is invalid, it should be either 'OCO_${configKey.toUpperCase()}' or it doesn't exist.`
+      );
+      outro(
+        `Manually fix the '.env' file or global '~/.opencommit' config file.`
+      );
+      process.exit(1);
+    }
   }
 
   return config;