Skip to content

Commit

Permalink
feat: Add translation feature and update settings docs
Browse files Browse the repository at this point in the history
- Added the ability to translate commit messages into multiple languages and updated the settings documentation accordingly.
- Added "commit ai" to the keywords in package.json.
  • Loading branch information
FrancoStino committed Sep 29, 2024
1 parent 56b8ab8 commit 1223eaf
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 10 deletions.
41 changes: 32 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ To use Commit Groq, you need to configure your Groq API key. Follow these steps:
- Automatic generation of commit messages based on modified code.
- Code analysis for improvement suggestions before committing.
- Seamless integration with Git workflow in VS Code.
- Ability to translate commit messages into multiple languages.

## Usage

Expand Down Expand Up @@ -134,15 +135,15 @@ This extension contributes the following settings:
- Custom Emojis: It allows you to write down the emojis you want to use in the next template object in the VSCode config.json.

```json
"commitgroq.commitEmojis": {
"feat": "",
"fix": "🐛",
"docs": "📝",
"style": "💎",
"refactor": "♻️",
"test": "🧪",
"chore": "📦",
"revert": ""
"commitgroq.commitEmojis": {
"feat": "",
"fix": "🐛",
"docs": "📝",
"style": "💎",
"refactor": "♻️",
"test": "🧪",
"chore": "📦",
"revert": ""
}
```

Expand All @@ -158,6 +159,28 @@ This extension contributes the following settings:

- Force Commit Without dot at the end: It allows you to enable or disable the commit message without dot at the end.

- Commit Language: It allows you to select the language for the commit message translation.
<table>
<thead>
<tr>
<th>Language</th>
</tr>
</thead>
<tbody>
<tr><td>🇬🇧 English</td></tr>
<tr><td>🇨🇳 Mandarin Chinese</td></tr>
<tr><td>🇮🇳 Hindi</td></tr>
<tr><td>🇪🇸 Spanish</td></tr>
<tr><td>🇫🇷 French</td></tr>
<tr><td>🇮🇹 Italian</td></tr>
<tr><td>🇸🇦 Arabic</td></tr>
<tr><td>🇧🇩 Bengali</td></tr>
<tr><td>🇷🇺 Russian</td></tr>
<tr><td>🇵🇹 Portuguese</td></tr>
<tr><td>🇯🇵 Japanese</td></tr>
</tbody>
</table>

#### Reset API Key

1. `CTRL+SHIFT+P` or `CMD+SHIFT+P`
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"ai",
"llm",
"commits",
"groq"
"groq",
"commit ai"
],
"activationEvents": [],
"main": "./out/extension.js",
Expand Down

0 comments on commit 1223eaf

Please sign in to comment.