Skip to content

Commit

Permalink
Add guideline for disabling K2 mode for Kotlin
Browse files Browse the repository at this point in the history
  • Loading branch information
pderakhshanfar committed Oct 16, 2024
1 parent bcd8a08 commit ffc11ee
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ TestSpark currently supports two test generation strategies:
<p>For this type of test generation, TestSpark sends request to different Large Language Models. Also, it automatically checks if tests are valid before presenting it to users.</p>
<p>This feature needs a token from OpenAI, HuggingFace, or the AI Assistant platform.</p>
<ul>
<li>Supports Java (any version) and Kotlin.</li>
<li>Supports Java (any version) and Kotlin (K2 mode should be disabled, checkout the Settings section on README).</li>
<li>Generates unit tests for capturing failures.</li>
<li>Generate tests for Java classes, methods, and single lines.</li>
</ul>
Expand Down Expand Up @@ -70,6 +70,7 @@ If you are running the plugin for the first time, checkout the [Settings](#setti
- [Coverage](#coverage)
- [Integrating tests into the project](#integrating-tests-into-the-project)
- [Settings](#settings)
- [Disable K2 for Kotlin Test Generation](#disable-K2)
- [Telemetry](#telemetry-opt-in)

### Generating Tests
Expand Down Expand Up @@ -229,7 +230,9 @@ Or to a new file:

![Tests adding to a new file](readme-images/gifs/AddingToANewFile.gif#gh-light-mode-only)
![Tests adding to a new file_dark](readme-images/gifs/AddingToANewFile_dark.gif#gh-dark-mode-only)

### Disable-K2
For LLM-based Kotlin test generation, you need to disable the K2 mode for now.
![Disable K2 mode](readme-images/pngs/k2-mode/disable-k2.png)
### Settings
<!-- How can users configure the plugin to match their needs? -->
The plugin is configured mainly through the Settings menu. The plugin settings can be found under <kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>TestSpark</kbd>. Here, the user is able to select options for the plugin:
Expand Down
Binary file added readme-images/pngs/k2-mode/disable-k2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ffc11ee

Please sign in to comment.