Add push config #220

Moret84 · 2023-07-12T21:13:47Z

This is the same PR as #74. The author unexpectedly closed it. I am interested in the feature, as others seem to be. I rebased the branch on dev, as requested in CONTRIBUTING.md. Please let me know if some extra work is needed before merging the PR.

@evandeininger, I kept your name. My intention is absolutely not to appropriate your code. Let me know if it bothers you.

I couldn't test well the feature, as there seems to be an issue with ts-node, preventing the npm run dev command to execute the soft. I am not used to developing in Node, so I haven't found how to solve it.

github-actions · 2023-08-22T21:30:43Z

Stale pull request message

di-sukharev · 2023-08-24T04:24:11Z

@Moret84 long time no see :)

to test this you should run npm run build and then npm run start -- config set <your_config>=true/false then running npm run start should run the local vevrsion, so you are able to test it locally

Moret84 · 2023-08-24T11:46:37Z

Hello @di-sukharev,
Thanks for your help, I have been able to do some tests and fix some bugs ;).
However, I could not get my config key working. After some debugging, I have found something in the code that could explain the reason, at validator level, in config.ts:

 
 const config = iniParse(configFile);

  for (const configKey of Object.keys(config)) {
    if (
      !config[configKey] ||
      ['null', 'undefined'].includes(config[configKey])
    ) {
      config[configKey] = undefined;
      continue;
    }

config[configKey] is assigned to undefined if the ini value is false. Hence, any configuration key set to false will be ignored, won't be ?
Is this an expected behavior ? The existing OCO_DESCRIPTION key is concerned as well, IMO.
What do you think about this ?

Thanks for your read and your work

di-sukharev · 2023-09-03T04:27:03Z

@Moret84 hey, i dont remember having this issue with boolean configs, could you confirm that false is set as undefined for all boolean configs?

an addition: let's make the config false by default, not sure if people want to push instantly, let them configure it

one more question to the PR: are you sure that when the config is set to true it's bypassing the prompt do you want to run git push? i dont see any code that handles this, so now it looks like users are asked if they want to git push and if the config is set to false the push wont happen anyway :)

Moret84 · 2023-09-21T07:46:02Z

@Moret84 hey, i dont remember having this issue with boolean configs, could you confirm that false is set as undefined for all boolean configs?

Yeah, this is what the !config[configKey] || part of the if does.

an addition: let's make the config false by default, not sure if people want to push instantly, let them configure it

one more question to the PR: are you sure that when the config is set to true it's bypassing the prompt do you want to run git push? i dont see any code that handles this, so now it looks like users are asked if they want to git push and if the config is set to false the push wont happen anyway :)

You are right.
In my opinion it would be good to keep the prompt when the user has not set the OCO_GITPUSH variable (i.e. the variable is undefined).
What do you think about this behavior ?

Moret84 · 2023-10-25T22:36:39Z

Hi @di-sukharev,

I have removed the false to undefined conversion. I have also improved the push prompt behavior:

if not defined the prompt appears
if defined and true the prompt does not appears and push is performed
if defined and false no prompt no push

From my point of view the PR is ready. Please consider review it as I miss this feature 🤪

Thanks for your work
Moret

github-actions · 2023-12-05T21:30:43Z

Stale pull request message

di-sukharev · 2024-02-28T05:58:37Z

@Moret84 could you please fix the conflict and lets merge it <3

…ersion The part of the the condition that is removed made the statement assign undefined when a config key is not set. This prevented to set a config variable to false.

feat(config.ts): add gitpush config option and validator

oc config set OCO_GITPUSH=false command

…the updated config key name fix(config.ts): change CONFIG_KEYS.gitpush to CONFIG_KEYS.OCO_GITPUSH to match the updated config key name The config key name has been changed from "gitpush" to "OCO_GITPUSH" for consistency and clarity. This change ensures that the code references the correct key when checking the value of the config.

push behavior The OCO_GITPUSH environment variable is added to the config file to allow controlling the behavior of git push. If the variable is set to 'false', git push will be disabled. Otherwise, it will be enabled. This provides flexibility in scenarios where git push is not desired, such as during development or testing.

…not set to true before prompting for `git push` confirmation

Moret84 · 2024-02-28T10:13:22Z

@di-sukharev done

di-sukharev · 2024-02-29T03:22:30Z

@Moret84 have you tested the build and run it?
do npm run build && npm run start on the opencommit repo when there are staged changes, you can do any change, test it and then revert back

di-sukharev · 2024-02-29T03:28:44Z

you can also do npm run start -- config set KEY=VALUE && npm run start

Moret84 · 2024-02-29T07:24:07Z

@di-sukharev Yes I have tested setting the variable to true, false and not setting at all. Behavior seems OK to me.

dangnhdev · 2024-03-27T16:18:04Z

@di-sukharev Let's review and merge it 🚀🚀🚀

di-sukharev · 2024-03-29T02:57:27Z

will be in the next version

di-sukharev · 2024-03-29T03:00:23Z

hey guys, it broke the test, but it is expected as we dont wait for the do you want to push? now, but could you make the config false by default? this will solve the test https://github.com/di-sukharev/opencommit/actions/runs/8476583098/job/23226316086

Moret84 · 2024-03-29T12:00:20Z

@di-sukharev I am afraid I haven't understood. By default if the variable is not set, the prompt appears so it should be expected by the test. I can't reproduce the failed result for the test https://github.com/di-sukharev/opencommit/actions/runs/8476583098/job/23226316086 on my side

di-sukharev · 2024-03-29T13:44:29Z

hmm.. i may be mistaken, thanks, will take a look into it

* test: ✅ add the first E2E test and configuration to CI (#316) * add tests * Add push config (#220) * feat: add instructions and support for configuring gpt-4-turbo (#320) * 3.0.12 * build * feat: add 'gpt-4-turbo' to supported models in README and config validation --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * ✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (#321) * test(oneFile.test.ts): update test expectations to match new push prompt text * build * Feat: Add Claude 3 support (#318) * 3.0.12 * build * feat: anthropic claude 3 support * fix: add system prompt * fix: type check * fix: package version * fix: update anthropic for dependency bug fix * feat: update build files * feat: update version number --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * 🐛bug fix: enable to use the new format of OpenAI's project API Key (#328) * fix(config.ts): remove validation for OCO_OPENAI_API_KEY length to accommodate variable key lengths * build * ♻️ refactor(config.ts): Addition of UnitTest environment and unittest for commands/config.ts#getConfig (#330) * feat(jest.config.ts): update jest preset for TS ESM support and ignore patterns feat(package.json): add test:unit script with NODE_OPTIONS for ESM refactor(src/commands/config.ts): improve dotenv usage with dynamic paths feat(src/commands/config.ts): allow custom config and env paths in getConfig refactor(src/commands/config.ts): streamline environment variable access feat(test/unit): add unit tests for config handling and utility functions - Implement unit tests for `getConfig` function to ensure correct behavior in various scenarios including default values, global config, and local env file precedence. - Add utility function `prepareFile` for creating temporary files during tests, facilitating testing of file-based configurations. * feat(e2e.yml): add unit-test job to GitHub Actions for running unit tests on pull requests * ci(test.yml): add GitHub Actions workflow for unit and e2e tests on pull requests * refactor(config.ts): streamline environment variable access using process.env directly test(config.test.ts): add setup and teardown for environment variables in tests to ensure test isolation * feat(package.json): add `test:all` script to run all tests in Docker refactor(package.json): consolidate Docker build steps into `test:docker-build` script for DRY principle fix(package.json): ensure `test:unit:docker` and `test:e2e:docker` scripts use the same Docker image and remove container after run chore(test/Dockerfile): remove default CMD to allow dynamic test script execution in Docker * refactor(config.test.ts): anonymize API keys in tests for better security practices * feat(config.test.ts): add tests for OCO_ANTHROPIC_API_KEY configuration * refactor(config.ts): streamline path imports and remove unused DotenvParseOutput - Simplify path module imports by removing default import and using named imports for `pathJoin` and `pathResolve`. - Remove unused `DotenvParseOutput` import to clean up the code. * refactor(config.test.ts): simplify API key mock values for clarity in tests * test(config.test.ts): remove tests for default config values and redundant cases - Removed tests that checked for default config values when no config or env files are present, as these scenarios are now handled differently. - Eliminated tests for empty global config and local env files to streamline testing focus on actual config loading logic. - Removed test for prioritizing local env over global config due to changes in config loading strategy, simplifying the configuration management. * new version --------- Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com>

* ✨ feat(api.ts): add support for Azure OpenAI API The Azure OpenAI API is now supported in addition to the OpenAI API. The API type can be specified in the configuration file using the OPENAI_API_TYPE key. If the key is not specified, the default value is 'openai'. The AzureOpenAIApi class is added to the utils folder to handle the Azure OpenAI API calls. The createChatCompletion method is implemented in the AzureOpenAIApi class to handle the chat completion requests. The method is called in the generateCommitMessage method in the OpenAi class if the apiType is set to 'azure'. * 🐛 fix(AzureOpenAI.ts): fix import path for AxiosRequestConfig to avoid conflicts with openai's axios dependency In AzureOpenAI.ts, the import path for AxiosRequestConfig was changed to avoid conflicts with openai's axios dependency, which was causing lint errors. * 🔧 fix(AzureOpenAI.ts): import RequiredError to fix error handling and remove commented out debug code The RequiredError class was not being imported from the openai/dist/base module, causing errors to be thrown incorrectly. This has been fixed by importing the RequiredError class. Debug code has been removed and comments have been updated to reflect the changes made. * 🔇 chore(AzureOpenAI.ts): remove console.log statement and translate Japanese comment The commented console.log statement was removed to improve code cleanliness. * 🔥 refactoring(api.ts, AzureOpenAI.ts): Leverage openai npm package 🐛 fix(config.ts): API Key string validation * ✨ (README.md): update opencommit command to set OCO_AI_PROVIDER instead of OPENAI_API_TYPE to improve consistency and clarity in configuration ♻️ (config.ts): update OCO_AI_PROVIDER enum in configValidators to include 'azure' and remove unnecessary conditionals to improve maintainability and extensibility ⬆️ (config.ts): add OCO_AZURE_API_VERSION to ConfigType and getConfig() to support new azure api version configuration ♻️ (engine/ollama.ts): add space between temperature and top_p properties to improve readability ♻️ (engine/openAi.ts): refactor OpenAi class to improve readability and maintainability by extracting configuration logic into separate switch statement 🔧 (generateCommitMessageFromGitDiff.ts): refactor MAX_TOKENS_INPUT and MAX_TOKENS_OUTPUT lines to improve readability 🔧 (generateCommitMessageFromGitDiff.ts): refactor generateCommitMessageByDiff and getMessagesPromisesByChangesInFile functions to use destructuring and improve readability ♻️ (generateCommitMessageFromGitDiff.ts): refactor getCommitMsgsPromisesFromFileDiffs function to use destructuring and improve readability 📝 (modules/commitlint/config.ts): add missing types to function parameters and improve readability by removing unnecessary comments and whitespace 📝 (modules/commitlint/utils.ts): fix indentation and add missing types to function parameters 📝 (prompts.ts): update INIT_MAIN_PROMPT description to include clarification on the use of present tense and line length 📝 (version.ts): fix import statements and add missing types to function parameters * ✨ (package.json): add @azure/openai dependency to support integration with Azure AI services 🔧 (config.ts): change CONFIG_KEYS.OCO_AZURE_API_VERSION to CONFIG_KEYS.OCO_AZURE_ENDPOINT to improve semantics and allow configuration of Azure endpoint URL ♻️ (config.ts): refactor configValidators to use OCO_AZURE_ENDPOINT instead of OCO_AZURE_API_VERSION and update validation message for OCO_AZURE_ENDPOINT ✨ (config.ts): add OCO_AZURE_ENDPOINT to getConfig function to retrieve Azure endpoint configuration from environment variables ✨ (azure.ts): introduce a new file azure.ts to implement Azure AI engine ✨ (azure.ts): implement generateCommitMessage function in Azure AI engine ✨ (prompts.ts): add a new line to INIT_MAIN_PROMPT to mention that changes within a single file should be described with a single commit message ♻️ (engine.ts): refactor getEngine function to add support for 'azure' as the AI provider and return the azure engine * 📝 (prompts.ts): remove unnecessary information about crafting a concise commit message with a one single message for OCO_ONE_LINE_COMMIT configuration * 3.0.14 (#333) * test: ✅ add the first E2E test and configuration to CI (#316) * add tests * Add push config (#220) * feat: add instructions and support for configuring gpt-4-turbo (#320) * 3.0.12 * build * feat: add 'gpt-4-turbo' to supported models in README and config validation --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * ✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (#321) * test(oneFile.test.ts): update test expectations to match new push prompt text * build * Feat: Add Claude 3 support (#318) * 3.0.12 * build * feat: anthropic claude 3 support * fix: add system prompt * fix: type check * fix: package version * fix: update anthropic for dependency bug fix * feat: update build files * feat: update version number --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * 🐛bug fix: enable to use the new format of OpenAI's project API Key (#328) * fix(config.ts): remove validation for OCO_OPENAI_API_KEY length to accommodate variable key lengths * build * ♻️ refactor(config.ts): Addition of UnitTest environment and unittest for commands/config.ts#getConfig (#330) * feat(jest.config.ts): update jest preset for TS ESM support and ignore patterns feat(package.json): add test:unit script with NODE_OPTIONS for ESM refactor(src/commands/config.ts): improve dotenv usage with dynamic paths feat(src/commands/config.ts): allow custom config and env paths in getConfig refactor(src/commands/config.ts): streamline environment variable access feat(test/unit): add unit tests for config handling and utility functions - Implement unit tests for `getConfig` function to ensure correct behavior in various scenarios including default values, global config, and local env file precedence. - Add utility function `prepareFile` for creating temporary files during tests, facilitating testing of file-based configurations. * feat(e2e.yml): add unit-test job to GitHub Actions for running unit tests on pull requests * ci(test.yml): add GitHub Actions workflow for unit and e2e tests on pull requests * refactor(config.ts): streamline environment variable access using process.env directly test(config.test.ts): add setup and teardown for environment variables in tests to ensure test isolation * feat(package.json): add `test:all` script to run all tests in Docker refactor(package.json): consolidate Docker build steps into `test:docker-build` script for DRY principle fix(package.json): ensure `test:unit:docker` and `test:e2e:docker` scripts use the same Docker image and remove container after run chore(test/Dockerfile): remove default CMD to allow dynamic test script execution in Docker * refactor(config.test.ts): anonymize API keys in tests for better security practices * feat(config.test.ts): add tests for OCO_ANTHROPIC_API_KEY configuration * refactor(config.ts): streamline path imports and remove unused DotenvParseOutput - Simplify path module imports by removing default import and using named imports for `pathJoin` and `pathResolve`. - Remove unused `DotenvParseOutput` import to clean up the code. * refactor(config.test.ts): simplify API key mock values for clarity in tests * test(config.test.ts): remove tests for default config values and redundant cases - Removed tests that checked for default config values when no config or env files are present, as these scenarios are now handled differently. - Eliminated tests for empty global config and local env files to streamline testing focus on actual config loading logic. - Removed test for prioritizing local env over global config due to changes in config loading strategy, simplifying the configuration management. * new version --------- Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> * 3.0.15 * build * 🐛 (prepare-commit-msg-hook.ts): improve error message to cover missing OCO_ANTHROPIC_API_KEY and OCO_AZURE_API_KEY in addition to OCO_OPENAI_API_KEY * 🐛 (azure.ts): fix check for OCO_AI_PROVIDER to properly assign provider variable 🐛 (azure.ts): initialize OpenAIClient only if provider is 'azure' 🔧 (Dockerfile): rearrange instructions to optimize caching by copying package.json and package-lock.json first before running npm ci and copying the rest of the files 🔧 (e2e/noChanges.test.ts): remove unnecessary line break 🔧 (e2e/oneFile.test.ts): remove unnecessary line break --------- Co-authored-by: Takuya Ono <takuya-o@users.osdn.me> Co-authored-by: GPT10 <57486732+di-sukharev@users.noreply.github.com> Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> Co-authored-by: di-sukharev <dim.sukharev@gmail.com>

* test: ✅ add the first E2E test and configuration to CI (#316) * add tests * Add push config (#220) * feat: add instructions and support for configuring gpt-4-turbo (#320) * 3.0.12 * build * feat: add 'gpt-4-turbo' to supported models in README and config validation --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * ✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (#321) * test(oneFile.test.ts): update test expectations to match new push prompt text * build * Feat: Add Claude 3 support (#318) * 3.0.12 * build * feat: anthropic claude 3 support * fix: add system prompt * fix: type check * fix: package version * fix: update anthropic for dependency bug fix * feat: update build files * feat: update version number --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * 🐛bug fix: enable to use the new format of OpenAI's project API Key (#328) * fix(config.ts): remove validation for OCO_OPENAI_API_KEY length to accommodate variable key lengths * build * ♻️ refactor(config.ts): Addition of UnitTest environment and unittest for commands/config.ts#getConfig (#330) * feat(jest.config.ts): update jest preset for TS ESM support and ignore patterns feat(package.json): add test:unit script with NODE_OPTIONS for ESM refactor(src/commands/config.ts): improve dotenv usage with dynamic paths feat(src/commands/config.ts): allow custom config and env paths in getConfig refactor(src/commands/config.ts): streamline environment variable access feat(test/unit): add unit tests for config handling and utility functions - Implement unit tests for `getConfig` function to ensure correct behavior in various scenarios including default values, global config, and local env file precedence. - Add utility function `prepareFile` for creating temporary files during tests, facilitating testing of file-based configurations. * feat(e2e.yml): add unit-test job to GitHub Actions for running unit tests on pull requests * ci(test.yml): add GitHub Actions workflow for unit and e2e tests on pull requests * refactor(config.ts): streamline environment variable access using process.env directly test(config.test.ts): add setup and teardown for environment variables in tests to ensure test isolation * feat(package.json): add `test:all` script to run all tests in Docker refactor(package.json): consolidate Docker build steps into `test:docker-build` script for DRY principle fix(package.json): ensure `test:unit:docker` and `test:e2e:docker` scripts use the same Docker image and remove container after run chore(test/Dockerfile): remove default CMD to allow dynamic test script execution in Docker * refactor(config.test.ts): anonymize API keys in tests for better security practices * feat(config.test.ts): add tests for OCO_ANTHROPIC_API_KEY configuration * refactor(config.ts): streamline path imports and remove unused DotenvParseOutput - Simplify path module imports by removing default import and using named imports for `pathJoin` and `pathResolve`. - Remove unused `DotenvParseOutput` import to clean up the code. * refactor(config.test.ts): simplify API key mock values for clarity in tests * test(config.test.ts): remove tests for default config values and redundant cases - Removed tests that checked for default config values when no config or env files are present, as these scenarios are now handled differently. - Eliminated tests for empty global config and local env files to streamline testing focus on actual config loading logic. - Removed test for prioritizing local env over global config due to changes in config loading strategy, simplifying the configuration management. * new version * improve OCO_AI_PROVIDER=ollama[/model name] (#327) * 🐛 (config.ts, engine/ollama.ts, utils/engine.ts): improve Ollama AI configuration and usage ✨ (config.ts): add support for multiple Ollama models and allow users to specify the model in their config ✅ (engine/ollama.ts, utils/engine.ts): refactor code to use the specified Ollama model instead of hardcoding it * add build results * add support for Azure OpenAI API - continue MR 167 (#324) * ✨ feat(api.ts): add support for Azure OpenAI API The Azure OpenAI API is now supported in addition to the OpenAI API. The API type can be specified in the configuration file using the OPENAI_API_TYPE key. If the key is not specified, the default value is 'openai'. The AzureOpenAIApi class is added to the utils folder to handle the Azure OpenAI API calls. The createChatCompletion method is implemented in the AzureOpenAIApi class to handle the chat completion requests. The method is called in the generateCommitMessage method in the OpenAi class if the apiType is set to 'azure'. * 🐛 fix(AzureOpenAI.ts): fix import path for AxiosRequestConfig to avoid conflicts with openai's axios dependency In AzureOpenAI.ts, the import path for AxiosRequestConfig was changed to avoid conflicts with openai's axios dependency, which was causing lint errors. * 🔧 fix(AzureOpenAI.ts): import RequiredError to fix error handling and remove commented out debug code The RequiredError class was not being imported from the openai/dist/base module, causing errors to be thrown incorrectly. This has been fixed by importing the RequiredError class. Debug code has been removed and comments have been updated to reflect the changes made. * 🔇 chore(AzureOpenAI.ts): remove console.log statement and translate Japanese comment The commented console.log statement was removed to improve code cleanliness. * 🔥 refactoring(api.ts, AzureOpenAI.ts): Leverage openai npm package 🐛 fix(config.ts): API Key string validation * ✨ (README.md): update opencommit command to set OCO_AI_PROVIDER instead of OPENAI_API_TYPE to improve consistency and clarity in configuration ♻️ (config.ts): update OCO_AI_PROVIDER enum in configValidators to include 'azure' and remove unnecessary conditionals to improve maintainability and extensibility ⬆️ (config.ts): add OCO_AZURE_API_VERSION to ConfigType and getConfig() to support new azure api version configuration ♻️ (engine/ollama.ts): add space between temperature and top_p properties to improve readability ♻️ (engine/openAi.ts): refactor OpenAi class to improve readability and maintainability by extracting configuration logic into separate switch statement 🔧 (generateCommitMessageFromGitDiff.ts): refactor MAX_TOKENS_INPUT and MAX_TOKENS_OUTPUT lines to improve readability 🔧 (generateCommitMessageFromGitDiff.ts): refactor generateCommitMessageByDiff and getMessagesPromisesByChangesInFile functions to use destructuring and improve readability ♻️ (generateCommitMessageFromGitDiff.ts): refactor getCommitMsgsPromisesFromFileDiffs function to use destructuring and improve readability 📝 (modules/commitlint/config.ts): add missing types to function parameters and improve readability by removing unnecessary comments and whitespace 📝 (modules/commitlint/utils.ts): fix indentation and add missing types to function parameters 📝 (prompts.ts): update INIT_MAIN_PROMPT description to include clarification on the use of present tense and line length 📝 (version.ts): fix import statements and add missing types to function parameters * ✨ (package.json): add @azure/openai dependency to support integration with Azure AI services 🔧 (config.ts): change CONFIG_KEYS.OCO_AZURE_API_VERSION to CONFIG_KEYS.OCO_AZURE_ENDPOINT to improve semantics and allow configuration of Azure endpoint URL ♻️ (config.ts): refactor configValidators to use OCO_AZURE_ENDPOINT instead of OCO_AZURE_API_VERSION and update validation message for OCO_AZURE_ENDPOINT ✨ (config.ts): add OCO_AZURE_ENDPOINT to getConfig function to retrieve Azure endpoint configuration from environment variables ✨ (azure.ts): introduce a new file azure.ts to implement Azure AI engine ✨ (azure.ts): implement generateCommitMessage function in Azure AI engine ✨ (prompts.ts): add a new line to INIT_MAIN_PROMPT to mention that changes within a single file should be described with a single commit message ♻️ (engine.ts): refactor getEngine function to add support for 'azure' as the AI provider and return the azure engine * 📝 (prompts.ts): remove unnecessary information about crafting a concise commit message with a one single message for OCO_ONE_LINE_COMMIT configuration * 3.0.14 (#333) * test: ✅ add the first E2E test and configuration to CI (#316) * add tests * Add push config (#220) * feat: add instructions and support for configuring gpt-4-turbo (#320) * 3.0.12 * build * feat: add 'gpt-4-turbo' to supported models in README and config validation --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * ✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (#321) * test(oneFile.test.ts): update test expectations to match new push prompt text * build * Feat: Add Claude 3 support (#318) * 3.0.12 * build * feat: anthropic claude 3 support * fix: add system prompt * fix: type check * fix: package version * fix: update anthropic for dependency bug fix * feat: update build files * feat: update version number --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * 🐛bug fix: enable to use the new format of OpenAI's project API Key (#328) * fix(config.ts): remove validation for OCO_OPENAI_API_KEY length to accommodate variable key lengths * build * ♻️ refactor(config.ts): Addition of UnitTest environment and unittest for commands/config.ts#getConfig (#330) * feat(jest.config.ts): update jest preset for TS ESM support and ignore patterns feat(package.json): add test:unit script with NODE_OPTIONS for ESM refactor(src/commands/config.ts): improve dotenv usage with dynamic paths feat(src/commands/config.ts): allow custom config and env paths in getConfig refactor(src/commands/config.ts): streamline environment variable access feat(test/unit): add unit tests for config handling and utility functions - Implement unit tests for `getConfig` function to ensure correct behavior in various scenarios including default values, global config, and local env file precedence. - Add utility function `prepareFile` for creating temporary files during tests, facilitating testing of file-based configurations. * feat(e2e.yml): add unit-test job to GitHub Actions for running unit tests on pull requests * ci(test.yml): add GitHub Actions workflow for unit and e2e tests on pull requests * refactor(config.ts): streamline environment variable access using process.env directly test(config.test.ts): add setup and teardown for environment variables in tests to ensure test isolation * feat(package.json): add `test:all` script to run all tests in Docker refactor(package.json): consolidate Docker build steps into `test:docker-build` script for DRY principle fix(package.json): ensure `test:unit:docker` and `test:e2e:docker` scripts use the same Docker image and remove container after run chore(test/Dockerfile): remove default CMD to allow dynamic test script execution in Docker * refactor(config.test.ts): anonymize API keys in tests for better security practices * feat(config.test.ts): add tests for OCO_ANTHROPIC_API_KEY configuration * refactor(config.ts): streamline path imports and remove unused DotenvParseOutput - Simplify path module imports by removing default import and using named imports for `pathJoin` and `pathResolve`. - Remove unused `DotenvParseOutput` import to clean up the code. * refactor(config.test.ts): simplify API key mock values for clarity in tests * test(config.test.ts): remove tests for default config values and redundant cases - Removed tests that checked for default config values when no config or env files are present, as these scenarios are now handled differently. - Eliminated tests for empty global config and local env files to streamline testing focus on actual config loading logic. - Removed test for prioritizing local env over global config due to changes in config loading strategy, simplifying the configuration management. * new version --------- Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> * 3.0.15 * build * 🐛 (prepare-commit-msg-hook.ts): improve error message to cover missing OCO_ANTHROPIC_API_KEY and OCO_AZURE_API_KEY in addition to OCO_OPENAI_API_KEY * 🐛 (azure.ts): fix check for OCO_AI_PROVIDER to properly assign provider variable 🐛 (azure.ts): initialize OpenAIClient only if provider is 'azure' 🔧 (Dockerfile): rearrange instructions to optimize caching by copying package.json and package-lock.json first before running npm ci and copying the rest of the files 🔧 (e2e/noChanges.test.ts): remove unnecessary line break 🔧 (e2e/oneFile.test.ts): remove unnecessary line break --------- Co-authored-by: Takuya Ono <takuya-o@users.osdn.me> Co-authored-by: GPT10 <57486732+di-sukharev@users.noreply.github.com> Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * feat(cli.ts, commit.ts): add `--yes` flag to skip commit confirmation prompt (#341) docs(README.md): document the `--yes` flag usage in README for user guidance --------- Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> Co-authored-by: tumf <y.takahara@gmail.com> Co-authored-by: Jakub Rosa <jakub.rosa.95@gmail.com> Co-authored-by: Takuya Ono <takuya-o@users.osdn.me> Co-authored-by: Ignacio Lago <ignacio@ignaciolago.com>

* ✨ feat(api.ts): add support for Azure OpenAI API The Azure OpenAI API is now supported in addition to the OpenAI API. The API type can be specified in the configuration file using the OPENAI_API_TYPE key. If the key is not specified, the default value is 'openai'. The AzureOpenAIApi class is added to the utils folder to handle the Azure OpenAI API calls. The createChatCompletion method is implemented in the AzureOpenAIApi class to handle the chat completion requests. The method is called in the generateCommitMessage method in the OpenAi class if the apiType is set to 'azure'. * 🐛 fix(AzureOpenAI.ts): fix import path for AxiosRequestConfig to avoid conflicts with openai's axios dependency In AzureOpenAI.ts, the import path for AxiosRequestConfig was changed to avoid conflicts with openai's axios dependency, which was causing lint errors. * 🔧 fix(AzureOpenAI.ts): import RequiredError to fix error handling and remove commented out debug code The RequiredError class was not being imported from the openai/dist/base module, causing errors to be thrown incorrectly. This has been fixed by importing the RequiredError class. Debug code has been removed and comments have been updated to reflect the changes made. * 🔇 chore(AzureOpenAI.ts): remove console.log statement and translate Japanese comment The commented console.log statement was removed to improve code cleanliness. * 🔥 refactoring(api.ts, AzureOpenAI.ts): Leverage openai npm package 🐛 fix(config.ts): API Key string validation * ✨ (README.md): update opencommit command to set OCO_AI_PROVIDER instead of OPENAI_API_TYPE to improve consistency and clarity in configuration ♻️ (config.ts): update OCO_AI_PROVIDER enum in configValidators to include 'azure' and remove unnecessary conditionals to improve maintainability and extensibility ⬆️ (config.ts): add OCO_AZURE_API_VERSION to ConfigType and getConfig() to support new azure api version configuration ♻️ (engine/ollama.ts): add space between temperature and top_p properties to improve readability ♻️ (engine/openAi.ts): refactor OpenAi class to improve readability and maintainability by extracting configuration logic into separate switch statement 🔧 (generateCommitMessageFromGitDiff.ts): refactor MAX_TOKENS_INPUT and MAX_TOKENS_OUTPUT lines to improve readability 🔧 (generateCommitMessageFromGitDiff.ts): refactor generateCommitMessageByDiff and getMessagesPromisesByChangesInFile functions to use destructuring and improve readability ♻️ (generateCommitMessageFromGitDiff.ts): refactor getCommitMsgsPromisesFromFileDiffs function to use destructuring and improve readability 📝 (modules/commitlint/config.ts): add missing types to function parameters and improve readability by removing unnecessary comments and whitespace 📝 (modules/commitlint/utils.ts): fix indentation and add missing types to function parameters 📝 (prompts.ts): update INIT_MAIN_PROMPT description to include clarification on the use of present tense and line length 📝 (version.ts): fix import statements and add missing types to function parameters * ✨ (package.json): add @azure/openai dependency to support integration with Azure AI services 🔧 (config.ts): change CONFIG_KEYS.OCO_AZURE_API_VERSION to CONFIG_KEYS.OCO_AZURE_ENDPOINT to improve semantics and allow configuration of Azure endpoint URL ♻️ (config.ts): refactor configValidators to use OCO_AZURE_ENDPOINT instead of OCO_AZURE_API_VERSION and update validation message for OCO_AZURE_ENDPOINT ✨ (config.ts): add OCO_AZURE_ENDPOINT to getConfig function to retrieve Azure endpoint configuration from environment variables ✨ (azure.ts): introduce a new file azure.ts to implement Azure AI engine ✨ (azure.ts): implement generateCommitMessage function in Azure AI engine ✨ (prompts.ts): add a new line to INIT_MAIN_PROMPT to mention that changes within a single file should be described with a single commit message ♻️ (engine.ts): refactor getEngine function to add support for 'azure' as the AI provider and return the azure engine * 📝 (prompts.ts): remove unnecessary information about crafting a concise commit message with a one single message for OCO_ONE_LINE_COMMIT configuration * 3.0.14 (di-sukharev#333) * test: ✅ add the first E2E test and configuration to CI (di-sukharev#316) * add tests * Add push config (di-sukharev#220) * feat: add instructions and support for configuring gpt-4-turbo (di-sukharev#320) * 3.0.12 * build * feat: add 'gpt-4-turbo' to supported models in README and config validation --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * ✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (di-sukharev#321) * test(oneFile.test.ts): update test expectations to match new push prompt text * build * Feat: Add Claude 3 support (di-sukharev#318) * 3.0.12 * build * feat: anthropic claude 3 support * fix: add system prompt * fix: type check * fix: package version * fix: update anthropic for dependency bug fix * feat: update build files * feat: update version number --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> * 🐛bug fix: enable to use the new format of OpenAI's project API Key (di-sukharev#328) * fix(config.ts): remove validation for OCO_OPENAI_API_KEY length to accommodate variable key lengths * build * ♻️ refactor(config.ts): Addition of UnitTest environment and unittest for commands/config.ts#getConfig (di-sukharev#330) * feat(jest.config.ts): update jest preset for TS ESM support and ignore patterns feat(package.json): add test:unit script with NODE_OPTIONS for ESM refactor(src/commands/config.ts): improve dotenv usage with dynamic paths feat(src/commands/config.ts): allow custom config and env paths in getConfig refactor(src/commands/config.ts): streamline environment variable access feat(test/unit): add unit tests for config handling and utility functions - Implement unit tests for `getConfig` function to ensure correct behavior in various scenarios including default values, global config, and local env file precedence. - Add utility function `prepareFile` for creating temporary files during tests, facilitating testing of file-based configurations. * feat(e2e.yml): add unit-test job to GitHub Actions for running unit tests on pull requests * ci(test.yml): add GitHub Actions workflow for unit and e2e tests on pull requests * refactor(config.ts): streamline environment variable access using process.env directly test(config.test.ts): add setup and teardown for environment variables in tests to ensure test isolation * feat(package.json): add `test:all` script to run all tests in Docker refactor(package.json): consolidate Docker build steps into `test:docker-build` script for DRY principle fix(package.json): ensure `test:unit:docker` and `test:e2e:docker` scripts use the same Docker image and remove container after run chore(test/Dockerfile): remove default CMD to allow dynamic test script execution in Docker * refactor(config.test.ts): anonymize API keys in tests for better security practices * feat(config.test.ts): add tests for OCO_ANTHROPIC_API_KEY configuration * refactor(config.ts): streamline path imports and remove unused DotenvParseOutput - Simplify path module imports by removing default import and using named imports for `pathJoin` and `pathResolve`. - Remove unused `DotenvParseOutput` import to clean up the code. * refactor(config.test.ts): simplify API key mock values for clarity in tests * test(config.test.ts): remove tests for default config values and redundant cases - Removed tests that checked for default config values when no config or env files are present, as these scenarios are now handled differently. - Eliminated tests for empty global config and local env files to streamline testing focus on actual config loading logic. - Removed test for prioritizing local env over global config due to changes in config loading strategy, simplifying the configuration management. * new version --------- Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> * 3.0.15 * build * 🐛 (prepare-commit-msg-hook.ts): improve error message to cover missing OCO_ANTHROPIC_API_KEY and OCO_AZURE_API_KEY in addition to OCO_OPENAI_API_KEY * 🐛 (azure.ts): fix check for OCO_AI_PROVIDER to properly assign provider variable 🐛 (azure.ts): initialize OpenAIClient only if provider is 'azure' 🔧 (Dockerfile): rearrange instructions to optimize caching by copying package.json and package-lock.json first before running npm ci and copying the rest of the files 🔧 (e2e/noChanges.test.ts): remove unnecessary line break 🔧 (e2e/oneFile.test.ts): remove unnecessary line break --------- Co-authored-by: Takuya Ono <takuya-o@users.osdn.me> Co-authored-by: GPT10 <57486732+di-sukharev@users.noreply.github.com> Co-authored-by: Takanori Matsumoto <matscube@gmail.com> Co-authored-by: Moret84 <aurelienrivet@hotmail.fr> Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com> Co-authored-by: metavind <94786679+metavind@users.noreply.github.com> Co-authored-by: di-sukharev <dim.sukharev@gmail.com>

Moret84 force-pushed the add-push-config branch 3 times, most recently from dea5826 to b1ce56b Compare July 13, 2023 19:37

Moret84 marked this pull request as ready for review July 13, 2023 20:13

Moret84 mentioned this pull request Jul 13, 2023

Add push config #74

Closed

github-actions bot added the no-pr-activity label Aug 22, 2023

Moret84 force-pushed the add-push-config branch from b1ce56b to a73254f Compare August 24, 2023 11:32

Moret84 force-pushed the add-push-config branch 2 times, most recently from aea3b22 to 929a581 Compare August 24, 2023 15:49

github-actions bot removed the no-pr-activity label Aug 24, 2023

Moret84 force-pushed the add-push-config branch 3 times, most recently from b7dd9ee to 2c6d38c Compare October 25, 2023 22:19

bodrick mentioned this pull request Oct 28, 2023

[Snyk] Fix for 1 vulnerabilities bodrick/opencommit#8

Closed

github-actions bot added the no-pr-activity label Dec 5, 2023

github-actions bot closed this Dec 13, 2023

bodrick mentioned this pull request Dec 15, 2023

[Snyk] Security upgrade openai from 3.2.1 to 4.0.0 bodrick/opencommit#10

Closed

bodrick mentioned this pull request Dec 29, 2023

[Snyk] Fix for 2 vulnerabilities bodrick/opencommit#12

Closed

bodrick mentioned this pull request Jan 6, 2024

[Snyk] Fix for 1 vulnerabilities bodrick/opencommit#13

Closed

Ikramcat mentioned this pull request Jan 6, 2024

[Snyk] Fix for 1 vulnerabilities cat-home-experts/opencommit#7

Closed

di-sukharev reopened this Feb 28, 2024

refactor(config.ts): remove false to undefined configuration key conv…

ac37809

…ersion The part of the the condition that is removed made the statement assign undefined when a config key is not set. This prevented to set a config variable to false.

evandeininger and others added 5 commits February 28, 2024 11:11

feat(commit.ts): add support for gitpush config option

9426331

feat(config.ts): add gitpush config option and validator

docs(README.md): add instructions for turning off git push feature using

9fbbc65

oc config set OCO_GITPUSH=false command

fix(commit.ts): update condition to check if OCO_GITPUSH config is …

c6470be

…not set to true before prompting for `git push` confirmation

Moret84 force-pushed the add-push-config branch from 2c6d38c to c6470be Compare February 28, 2024 10:14

di-sukharev removed the no-pr-activity label Feb 28, 2024

Merge branch 'dev' into add-push-config

1a6d3c1

di-sukharev approved these changes Mar 29, 2024

View reviewed changes

di-sukharev merged commit c410486 into di-sukharev:dev Mar 29, 2024
1 of 2 checks passed

matscube mentioned this pull request Apr 13, 2024

✅ fix the broken E2E tests due to the addition of OCO_GITPUSH #321

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add push config #220

Add push config #220

Moret84 commented Jul 12, 2023 •

edited

Loading

github-actions bot commented Aug 22, 2023

di-sukharev commented Aug 24, 2023

Moret84 commented Aug 24, 2023 •

edited

Loading

di-sukharev commented Sep 3, 2023 •

edited

Loading

Moret84 commented Sep 21, 2023

Moret84 commented Oct 25, 2023

github-actions bot commented Dec 5, 2023

di-sukharev commented Feb 28, 2024

Moret84 commented Feb 28, 2024

di-sukharev commented Feb 29, 2024

di-sukharev commented Feb 29, 2024

Moret84 commented Feb 29, 2024 •

edited

Loading

dangnhdev commented Mar 27, 2024

di-sukharev commented Mar 29, 2024

di-sukharev commented Mar 29, 2024

Moret84 commented Mar 29, 2024 •

edited

Loading

di-sukharev commented Mar 29, 2024 •

edited

Loading

Add push config #220

Add push config #220

Conversation

Moret84 commented Jul 12, 2023 • edited Loading

github-actions bot commented Aug 22, 2023

di-sukharev commented Aug 24, 2023

Moret84 commented Aug 24, 2023 • edited Loading

di-sukharev commented Sep 3, 2023 • edited Loading

Moret84 commented Sep 21, 2023

Moret84 commented Oct 25, 2023

github-actions bot commented Dec 5, 2023

di-sukharev commented Feb 28, 2024

Moret84 commented Feb 28, 2024

di-sukharev commented Feb 29, 2024

di-sukharev commented Feb 29, 2024

Moret84 commented Feb 29, 2024 • edited Loading

dangnhdev commented Mar 27, 2024

di-sukharev commented Mar 29, 2024

di-sukharev commented Mar 29, 2024

Moret84 commented Mar 29, 2024 • edited Loading

di-sukharev commented Mar 29, 2024 • edited Loading

Moret84 commented Jul 12, 2023 •

edited

Loading

Moret84 commented Aug 24, 2023 •

edited

Loading

di-sukharev commented Sep 3, 2023 •

edited

Loading

Moret84 commented Feb 29, 2024 •

edited

Loading

Moret84 commented Mar 29, 2024 •

edited

Loading

di-sukharev commented Mar 29, 2024 •

edited

Loading