Vassiliy kudryashov/extended settings documentation #1501
Merged
Conversation
This file contains hidden or 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
alisevych
reviewed
Dec 9, 2022
docs/SettingsProperties.md
Outdated
| 3. Controls in "Generate" dialog | ||
|
|
||
|
|
||
| Properties from 2 and 3 are plugin-specific, and they are automatically persisted in `{projectDir}/.idea/utbot-settings.xml` |
There was a problem hiding this comment.
Actually not all settings on UI are plugin-specific. They are:
- Display detected errors on the Problems tool window
- Test sources root
Most of settings on UI can be used for CLI and CI as well (and they are not used in UtSettings and settings.properties:
- Generated test language
- Hanging test timeout
- Tests with exceptions : Pass/Fail
- Fuzzing/Symbolic proportion (fuzzingValue)
- Force mocking static methods
- Test framework
- Mocking strategy
docs/SettingsProperties.md
Outdated
| in **plugin configuration file** `{projectDir}/.idea/utbot-settings.xml` and nobody is expected to edit this file manually. | ||
|
|
||
| At the moment, these two kinds of settings (core and plugin-specific) | ||
| have very small intersection (that means some keys of different levels control the same behavior aspects). |
There was a problem hiding this comment.
The intersection of settings in global settings.properties file and IDEA UI:
- Test generation timeout (per execution dialog, not saved in project settings)
- useFuzzing (influences Test generation method on Settings > Tools)
- fuzzingTimeoutInMillis (can conflict with fuzzingValue - proportion - saved per project)
- enable Summaries (saved per project)
- useCustomJavaDocTags - Javadoc comment style (saved per project)
- treatOverflowAsError (saved per project)
…tings_documentation' into Vassiliy-Kudryashov/extended_settings_documentation
denis-fokin
approved these changes
Dec 15, 2022
Vassiliy-Kudryashov
deleted the
Vassiliy-Kudryashov/extended_settings_documentation
branch
tamarinvs19
pushed a commit
that referenced
this pull request
Dec 21, 2022
* Draft for extended settings documentation * Extended settings documentation * Small grammar fixes * Minor linguistic fixes Co-authored-by: Olga Naumenko <64418523+olganaumenko@users.noreply.github.com>
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.
Description
This update provides "wider vision" of our settings. After some discussion, we have to accept the concept as documentation or find a better solution to be implemented and then documented.