Merge branch 'feature/refactoring' of https://github.com/coenm/RepoM …

…into feature/refactoring

docs/RepoM.Plugin.AzureDevOps.md

@@ -2,9 +2,9 @@
 
 The AzureDevops module enables integration with one azure devops environment. The integration currently focusses on Pull Requests.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_AzureDevOpsPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_AzureDevOpsPackage#desc.verified.md -->
 
 This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running.
 
@@ -24,11 +24,11 @@ Properties:
 
 - `PersonalAccessToken`: Personal access token (PAT) to access Azure Devops. The PAT should be granted access to `todo` rights.
 To create a PAT, goto `https://dev.azure.com/[my-organisation]/_usersSettings/tokens`.
-- `BaseUrl`: The base url of azure devops for your organisation (ie. `https://dev.azure.com/[my-organisation]/`). <!-- endInclude -->
+- `BaseUrl`: The base url of azure devops for your organisation (ie. `https://dev.azure.com/[my-organisation]/`).<!-- endInclude -->
 
-## azure-devops-create-prs@1 <!-- include: _plugins.azuredevops.action. path: /docs/mdsource/_plugins.azuredevops.action.include.md -->
+## azure-devops-create-prs@1<!-- include: _plugins.azuredevops.action. path: /docs/mdsource/_plugins.azuredevops.action.include.md -->
 
-Action menu item to create a pull request in Azure Devops. <!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionAzureDevOpsCreatePullRequestsV1.verified.md -->
+Action menu item to create a pull request in Azure Devops.<!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionAzureDevOpsCreatePullRequestsV1.verified.md -->
 
 Action specific properties:
 
@@ -42,7 +42,7 @@ Title will be the last part of the branchname split on `/`, so `feature/123-test
 - `draft-pr`: Boolean specifying if th PR should be marked as draft. (required, boolean, default: `false`)
 - `include-work-items`: Boolean specifying if workitems should be included in the PR. The workitems will be found by using the commit messages. (required, boolean, default: `true`)
 - `open-in-browser`: Boolean specifying if the Pull request should be opened in the browser after creation. (required, boolean, default: `false`)
-- `auto-complete`: Auto complete options. Please take a look at the same for more information (required, repositoryactionazuredevopscreatepullrequestsautocompleteoptionsv1) <!-- endInclude -->
+- `auto-complete`: Auto complete options. Please take a look at the same for more information (required, repositoryactionazuredevopscreatepullrequestsautocompleteoptionsv1)<!-- endInclude -->
 
 Example:
 
@@ -93,13 +93,13 @@ repository-actions:
 
 ## azure-devops-get-prs@1
 
-This action results in zero or more items in the contextmenu. For each open pullrequest for the given repository, it will show an action to go to the specific PullRequest in your favorite webbrowser. <!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionAzureDevOpsGetPullRequestsV1.verified.md -->
+This action results in zero or more items in the contextmenu. For each open pullrequest for the given repository, it will show an action to go to the specific PullRequest in your favorite webbrowser.<!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionAzureDevOpsGetPullRequestsV1.verified.md -->
 
 Action specific properties:
 
 - `project-id`: The azure devops project id. (required, evaluated, string)
 - `repository-id`: The repository Id. If not provided, the repository id is located using the remote url. (optional, evaluated, string)
-- `show-when-empty`: When no pull requests are available, this property is used to determine if no or a message item is showed. (optional, evaluated, string, default: `true`) <!-- endInclude -->
+- `show-when-empty`: When no pull requests are available, this property is used to determine if no or a message item is showed. (optional, evaluated, string, default: `true`)<!-- endInclude -->
 
 Example:
 

docs/RepoM.Plugin.Clipboard.md

@@ -2,19 +2,19 @@
 
 This module provides a repository actions to copy specific (evaluated) text to the clipboard using the action provider type `clipboard-copy`.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_ClipboardPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_ClipboardPackage#desc.verified.md -->
 
-This module has no configuration. <!-- endInclude -->
+This module has no configuration.<!-- endInclude -->
 
-## clipboard-copy@1 <!-- include: _plugins.clipboard.action. path: /docs/mdsource/_plugins.clipboard.action.include.md -->
+## clipboard-copy@1<!-- include: _plugins.clipboard.action. path: /docs/mdsource/_plugins.clipboard.action.include.md -->
 
-This action makes it possible to copy text to the clipboard. <!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionClipboardCopyV1.verified.md -->
+This action makes it possible to copy text to the clipboard.<!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionClipboardCopyV1.verified.md -->
 
 Action specific properties:
 
-- `text`: The text to copy to the clipboard. (required, evaluated, string) <!-- endInclude -->
+- `text`: The text to copy to the clipboard. (required, evaluated, string)<!-- endInclude -->
 
 Example:
 

docs/RepoM.Plugin.EverythingFileSearch.md

@@ -2,8 +2,8 @@
 
 This module integrates with VoidTool Everything in order to locate git repositories on your system. Using Everythings cache, this process will be much faster then locating git repositories the default way.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_EverythingPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_EverythingPackage#desc.verified.md -->
 
-This module has no configuration. <!-- endInclude -->
+This module has no configuration.<!-- endInclude -->

docs/RepoM.Plugin.Heidi.md

@@ -3,9 +3,9 @@
 This module integrates with a portable [HeidiSQL](https://www.heidisql.com/) installation. The portable Heidi DB saves it's database configuration in a portable configuration file.
 This module monitors this file and provides an action menu and a variable provider to access this information.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_HeidiPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_HeidiPackage#desc.verified.md -->
 
 This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running.
 
@@ -26,7 +26,7 @@ Properties:
 
 - `ConfigPath`: The full directory where the portable configuration file is stored.
 - `ConfigFilename`: The portable-configurration filename (without path). Most likely `portable_settings.txt`
-- `ExecutableFilename`: The full executable of Heidi. <!-- endInclude -->
+- `ExecutableFilename`: The full executable of Heidi.<!-- endInclude -->
 
 In order to let RepoM know what database configuration should be linked to what git repository the following should be added in the comment section when editing a database configuration in the Heidi's session manager.
 
@@ -45,16 +45,16 @@ Example:
 ![Screenshot](HeidiSQL.png)
 ![Screenshot](HeidiInRepoM.png)
 
-## heidi-databases@1 <!-- include: _plugins.heidi.action. path: /docs/mdsource/_plugins.heidi.action.include.md -->
+## heidi-databases@1<!-- include: _plugins.heidi.action. path: /docs/mdsource/_plugins.heidi.action.include.md -->
 
 <!-- todo, improve docs -->
-Action to list heidi databases and show action menus for them. <!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionHeidiDatabasesV1.verified.md -->
+Action to list heidi databases and show action menus for them.<!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionHeidiDatabasesV1.verified.md -->
 
 Action specific properties:
 
 - `key`: Repository key.
 If not provided, the repository `Remote.Origin.Name` is used as selector. (optional, string)
-- `executable`: The absolute path of the Heidi executable. If not provided, the default value from the plugin settings is used. (optional, evaluated, string) <!-- endInclude -->
+- `executable`: The absolute path of the Heidi executable. If not provided, the default value from the plugin settings is used. (optional, evaluated, string)<!-- endInclude -->
 
 Example:
 

docs/RepoM.Plugin.LuceneQueryParser.md

@@ -1,10 +1,10 @@
 # Lucene Query Parser
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_LuceneQueryParserPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_LuceneQueryParserPackage#desc.verified.md -->
 
-This module has no configuration. <!-- endInclude -->
+This module has no configuration.<!-- endInclude -->
 
 To search for repositories, you can use a repom-dialect of Lucene query syntax.
 

docs/RepoM.Plugin.SonarCloud.md

@@ -2,9 +2,9 @@
 
 This module integrates with SonarCloud. Currently, the only functionality is to star a given repository in SonarCloud using the repository action.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_SonarCloudPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_SonarCloudPackage#desc.verified.md -->
 
 This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running.
 
@@ -23,15 +23,15 @@ The following default configuration is used:
 Properties:
 
 - `PersonalAccessToken`: Personal Access Token to access SonarCloud.
-- `BaseUrl`: SonarCloud url. Most likely `https//sonarcloud.io`. <!-- endInclude -->
+- `BaseUrl`: SonarCloud url. Most likely `https//sonarcloud.io`.<!-- endInclude -->
 
-## sonarcloud-set-favorite@1 <!-- include: _plugins.sonarcloud.action. path: /docs/mdsource/_plugins.sonarcloud.action.include.md -->
+## sonarcloud-set-favorite@1<!-- include: _plugins.sonarcloud.action. path: /docs/mdsource/_plugins.sonarcloud.action.include.md -->
 
-Action to mark a repository as favorite within SonarCloud. <!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionSonarCloudSetFavoriteV1.verified.md -->
+Action to mark a repository as favorite within SonarCloud.<!-- include: DocsRepositoryActionsTests.DocsRepositoryActionsSettings_RepositoryActionSonarCloudSetFavoriteV1.verified.md -->
 
 Action specific properties:
 
-- `project`: The SonarCloud project key. (required, evaluated, string) <!-- endInclude -->
+- `project`: The SonarCloud project key. (required, evaluated, string)<!-- endInclude -->
 
 Example:
 

docs/RepoM.Plugin.Statistics.md

@@ -2,9 +2,9 @@
 
 This module add functionality to keep track of actions performed on repositories. This can be used in orderings (and mabye later on in filtering) of repositories.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_StatisticsPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_StatisticsPackage#desc.verified.md -->
 
 This plugin has specific configuration stored in a separate configuration file stored in `%APPDATA%/RepoM/Module/` directory. This configuration file should be edit manually. The safest way to do this is, is when RepoM is not running.
 
@@ -23,4 +23,4 @@ The following default configuration is used:
 Properties:
 
 - `PersistenceBuffer`: Timespan for buffered events before making them persistant (ie. `00:05:00` for five minutes). Must be greater then or equal to `00:00:10` (10 seconds).
-- `RetentionDays`: Number of days to keep statical information before deleting them.  <!-- endInclude -->
+- `RetentionDays`: Number of days to keep statical information before deleting them. <!-- endInclude -->

docs/RepoM.Plugin.WindowsExplorerGitInfo.md

@@ -6,8 +6,8 @@ As an extra goodie for Windows users, RepoM automatically detects open File Expl
 
 Note that for Windows 11 users, the title will not be updated but in the taskbar the additional git information is still visible.
 
-To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM. <!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
+To use this module, make sure it is enabled in RepoM by opening the menu and navigate to 'Plugins'. When enabling or disabling a plugin, you should restart RepoM.<!-- singleLineInclude: _plugin_enable. path: /docs/mdsource/_plugin_enable.include.md -->
 
-## Configuration <!-- include: DocsModuleSettingsTests.DocsModuleSettings_WindowsExplorerGitInfoPackage#desc.verified.md -->
+## Configuration<!-- include: DocsModuleSettingsTests.DocsModuleSettings_WindowsExplorerGitInfoPackage#desc.verified.md -->
 
-This module has no configuration. <!-- endInclude -->
+This module has no configuration.<!-- endInclude -->

docs/Settings.md

@@ -4,7 +4,7 @@ When RepoM starts for the first time, a configuration file wil be created. Most
 
 To do this, make sure RepoM is not running.
 
-Properties: <!-- include: DocsAppSettingsTests.AppSettingsDocumentationGeneration_AppSettings.verified.md -->
+Properties:<!-- include: DocsAppSettingsTests.AppSettingsDocumentationGeneration_AppSettings.verified.md -->
 
 - `SortKey`: The selected sorting strategy. Sorting strategies can be configured manually in `RepoM.Ordering.yaml`. (optional, UI configured)
 - `SelectedQueryParser`: The selected query parser. Query parsers can be added by plugins. (optional, UI configured)
@@ -14,4 +14,4 @@ Properties: <!-- include: DocsAppSettingsTests.AppSettingsDocumentationGeneratio
 - `MenuSize`: The menu size of RepoM. This is set when the window is resized. (optional, UI configured)
 - `ReposRootDirectories`: List of root directories where RepoM will search for git repositories. If null or empty, all fixed drives will be searched from the root. (optional, Manual configured)
 - `EnabledSearchProviders`: List of search providers. Search providers can be added by plugins. (optional, UI configured)
-- `Plugins`: List of plugins. (optional, UI configured) <!-- endInclude -->
+- `Plugins`: List of plugins. (optional, UI configured)<!-- endInclude -->