feat(config.ts): add OCO_MESSAGE_TEMPLATE_PLACEHOLDER configuration item to allow users to customize the message template placeholder (#208)

feat(commit.ts): add check for message templates in extraArgs and replace OCO_MESSAGE_TEMPLATE_PLACEHOLDER with generated commit message if found
docs(README.md): add documentation for OCO_MESSAGE_TEMPLATE_PLACEHOLDER configuration item and how to use it in the command line (#205)
This commit is contained in:
seho
2023-07-05 14:27:43 +08:00
committed by GitHub
parent ccfd24a9e5
commit 3c0a271bf8
3 changed files with 39 additions and 3 deletions
+9
View File
@@ -124,6 +124,7 @@ OCO_DESCRIPTION=<postface a message with ~3 sentences description>
OCO_EMOJI=<add GitMoji>
OCO_MODEL=<either gpt-3.5-turbo or gpt-4>
OCO_LANGUAGE=<locale, scroll to the bottom to see options>
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, example: '$msg'>
```
### Global config for all repos
@@ -193,6 +194,14 @@ is translated to :
git commit -m "${generatedMessage}" --no-verify
```
To include a message in the generated message, you can utilize the template function! For instance:
```sh
oco '$msg #205
```
> opencommit examines placeholders in the parameters, allowing you to append additional information before and after the placeholders, such as the relevant Issue or Pull Request. Similarly, you have the option to customize the OCO_MESSAGE_TEMPLATE_PLACEHOLDER configuration item, for example, simplifying it to $m!"
### Ignore files
You can ignore files from submission to OpenAI by creating a `.opencommitignore` file. For example: