🐛Fix: prompt-module/@commitlint #336
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nfig loading to support both CJS and ESM modules 💡 (pwd-commitlint.ts): Add detailed comments and error handling for better clarity and robustness in commitlint module loading process
…ies for commitlint configurations 🔧 (setup.sh): Add shell script to set up commitlint configurations for e2e tests
…o define test mock type for testing purposes 📝 (config.ts): Update documentation for OCO_TEST_MOCK_TYPE configuration key in configValidators and getConfig functions 📝 (testAi.ts): Add TEST_MOCK_TYPES constant array to define supported test mock types 📝 (testAi.ts): Update generateCommitMessage function to use OCO_TEST_MOCK_TYPE from config for different test mock types 📝 (commitlint.test.ts): Add e2e test for running "oco commitlint force" with different @commitlint versions using CJS and ESM 📝 (utils.ts): Add wait function to introduce delay in milliseconds for testing purposes
… version parameter for better code organization and readability 📝 (commitlint.test.ts): add test case for commitlint@9 using CJS to ensure proper functionality and compatibility 📝 (commitlint.test.ts): add test case for commitlint@18 using CJS to ensure proper functionality and compatibility 📝 (commitlint.test.ts): add test case for commitlint@19 using ESM to ensure proper functionality and compatibility
… index.ts file before running tests
|
hi man, please calm down! haha <3 let me know when i can review and merge it |
…port configure style(test/e2e/prompt-module/commitlint.test.ts): add missing semicolon for consistency test(test/e2e/prompt-module/commitlint.test.ts): add e2e tests for @commitlint prompt-module integration
…n accuracy ♻️ (commitlint config): refactor commitlint.config.js to use ES module syntax ✨ (package.json): specify "type": "module" to support ES module syntax
matscube
commented
May 18, 2024
| @@ -1,11 +1,31 @@ | |||
| import { ChatCompletionRequestMessage } from 'openai'; | |||
| import { AiEngine } from './Engine'; | |||
| import { getConfig } from '../commands/config'; | |||
|
|
|||
| export const TEST_MOCK_TYPES = [ | |||
There was a problem hiding this comment.
In the testing of OCO_PROMPT_MODULE=@commitlint, a TestAi that returns JSON data, not just a string, was needed. Therefore, I added a setting to select the output type of TestAi for testing purposes.
matscube
commented
May 18, 2024
| @@ -0,0 +1,11 @@ | |||
| #!/bin/sh | |||
There was a problem hiding this comment.
In order to conduct E2E tests for OCO_PROMPT_MODULE=@commitlint, it was necessary to prepare an environment where the commitlint package is installed.
- Before running the E2E tests, we create node_modules according to the prepared package-lock.json (by setup.sh),
- We copy the node_modules with commitlint installed into the test environment within the E2E test suite,
- We are testing the commitlint command for each version of node_modules.
|
@di-sukharev |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current Issue
OCO_PROMPT_MODULE=@commitlintfunctionality is currently not working as expected. The following steps reproduce the issue:npm i @commitlint/clicommitlint.config.jsOCO_PROMPT_MODULE=@commitlintoco commitlint forceIdentified Problems
src/modules/commitlint/utils.ts#getJSONBlockconsistencyis not defined (a misspelling ofinput).src/modules/commitlint/pwd-commitlint.ts#getCommitLintPWDConfigonly supports the CJS version of the@commitlint/loadpackage.@commitlint/loadpackage usingrequire. However, commitlint v19 and onwards only support pure ESM.Proposed Changes
OCO_PROMPT_MODULE=@commitlintfunctionalitysrc/modules/commitlint/utils.ts#getJSONBlock.Checklist
git initnpm initnpm install --save-dev @commitlint/{cli,config-conventional}@19.x)echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.jstype: modulein package.jsonnpm install --save-dev @commitlint/{cli,config-conventional}@18.x)echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.jsoco config set OCO_PROMPT_MODULE=@commitlintoco commitlint forceoco.opencommit-commitlintconfigocoagain