Expand repository with property has_local_changes in actionmenu. (#215)

* repository.has_local_changes

* Docs changes

---------

Co-authored-by: GitHub Action <[email protected]>

docs/mdsource/script_variables_repository.generated.source.md

@@ -6,6 +6,7 @@ This module contains the following methods, variables and/or constants:
 
 - [`repository.branch`](#branch)
 - [`repository.branches`](#branches)
+- [`repository.has_local_changes`](#has_local_changes)
 - [`repository.is_bare`](#is_bare)
 - [`repository.linux_path`](#linux_path)
 - [`repository.local_branches`](#local_branches)
@@ -35,6 +36,26 @@ Gets the current branch of the repository
 
 The name of the current branch.
 
+## has_local_changes
+
+`repository.has_local_changes`
+
+Gets if there are local changes
+
+### Returns
+
+true when there are local changes, false otherwise.
+
+### Example
+      
+#### Usage
+
+
+```
+repository.has_local_changes
+```
+
+
 ## is_bare
 
 `repository.is_bare`

docs/script_variables_repository.generated.md

@@ -6,6 +6,7 @@ This module contains the following methods, variables and/or constants:
 
 - [`repository.branch`](#branch)
 - [`repository.branches`](#branches)
+- [`repository.has_local_changes`](#has_local_changes)
 - [`repository.is_bare`](#is_bare)
 - [`repository.linux_path`](#linux_path)
 - [`repository.local_branches`](#local_branches)
@@ -35,6 +36,26 @@ Gets the current branch of the repository
 
 The name of the current branch.
 
+## has_local_changes
+
+`repository.has_local_changes`
+
+Gets if there are local changes
+
+### Returns
+
+true when there are local changes, false otherwise.
+
+### Example
+      
+#### Usage
+
+
+```
+repository.has_local_changes
+```
+
+
 ## is_bare
 
 `repository.is_bare`

src/RepoM.ActionMenu.Core/ActionMenu/Context/FileFunctions.cs

@@ -47,7 +47,7 @@ public FileFunctions()
     /// solution_files = file.find_files('C:\Project\', '*.sln');
     /// </code>
     /// <result/>
-    /// As a result, the variable `solution_files` is an ennumerable of strings, for example:
+    /// As a result, the variable `solution_files` is an enumerable of strings, for example:
     /// <code-file language='yaml' filename='file.find_files.verified.yaml' />
     /// <repository-action-sample/>
     /// <snippet name='find_files@actionmenu01' mode='snippet' />
@@ -58,19 +58,6 @@ public static string[] FindFiles(ActionMenuGenerationContext /*IMenuContext*/ co
         return FindFilesInner(context, span, rootPath, searchPattern);
     }
 
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    internal static string[] FindFilesInner(IMenuContext context, SourceSpan span, string rootPath, string searchPattern)
-    {
-        try
-        {
-            return GetFileEnumerator(context.FileSystem, rootPath, searchPattern).ToArray();
-        }
-        catch (Exception e)
-        {
-            throw new ScriptRuntimeException(span, "Could not get files.", e);
-        }
-    }
-
     /// <summary>
     /// Checks if the specified file path exists on the disk.
     /// </summary>
@@ -89,14 +76,7 @@ internal static string[] FindFilesInner(IMenuContext context, SourceSpan span, s
     [ActionMenuContextMember("file_exists")]
     public static bool FileExists(ActionMenuGenerationContext context, string path)
     {
-        return FileExistsInner(context as IMenuContext, path);
-    }
-
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    internal static bool FileExistsInner(IMenuContext context, string path)
-    {
-        ArgumentException.ThrowIfNullOrWhiteSpace(path);
-        return context.FileSystem.File.Exists(path);
+        return FileExistsInner(context, path);
     }
 
     /// <summary>
@@ -123,7 +103,20 @@ public static bool DirectoryExists(ActionMenuGenerationContext context, string p
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    internal static bool DirectoryExistsInner(IMenuContext context, string path)
+    internal static string[] FindFilesInner(IMenuContext context, SourceSpan span, string rootPath, string searchPattern)
+    {
+        try
+        {
+            return GetFileEnumerator(context.FileSystem, rootPath, searchPattern).ToArray();
+        }
+        catch (Exception e)
+        {
+            throw new ScriptRuntimeException(span, "Could not get files.", e);
+        }
+    }
+
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private static bool DirectoryExistsInner(IMenuContext context, string path)
     {
         ArgumentException.ThrowIfNullOrWhiteSpace(path);
         return context.FileSystem.Directory.Exists(path);
@@ -134,4 +127,11 @@ private static IEnumerable<string> GetFileEnumerator(IFileSystem fileSystem, str
     {
         return fileSystem.Directory.EnumerateFileSystemEntries(path, searchPattern, _findFilesOptions);
     }
+
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private static bool FileExistsInner(IMenuContext context, string path)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(path);
+        return context.FileSystem.File.Exists(path);
+    }
 }

src/RepoM.ActionMenu.Core/ActionMenu/Context/RepositoryFunctions.cs

@@ -45,8 +45,7 @@ public RepositoryFunctions(IRepository repository)
     /// </example>
     [ActionMenuContextMember("is_bare")]
     public bool IsBare => _repository.IsBare;
-
-
+
     /// <summary>
     /// Gets the path of the repository. The path is windows or linux based (depending on the running OS) and does NOT end with a (back)slash.
     /// </summary>
@@ -107,4 +106,17 @@ public RepositoryFunctions(IRepository repository)
     /// <returns>Remotes.</returns>
     [ActionMenuContextMember("remotes")]
     public IEnumerable Remotes => _repository.Remotes;
+
+    /// <summary>
+    /// Gets if there are local changes
+    /// </summary>
+    /// <returns><c>true</c> when there are local changes, <c>false</c> otherwise.</returns>
+    /// <example>
+    /// <usage/>
+    /// <code>
+    /// repository.has_local_changes
+    /// </code>
+    /// </example>
+    [ActionMenuContextMember("has_local_changes")]
+    public bool HasLocalChanges => _repository.HasLocalChanges;
 }

src/RepoM.ActionMenu.Core/RepoMCodeGen.generated.cs

@@ -31,6 +31,7 @@ protected sealed override void RegisterFunctions()
         {
             RegisterConstant("branch", CurrentBranch);
             RegisterConstant("branches", Branches);
+            RegisterConstant("has_local_changes", HasLocalChanges);
             RegisterConstant("is_bare", IsBare);
             RegisterConstant("linux_path", LinuxPath);
             RegisterConstant("local_branches", LocalBranches);

src/RepoM.Api/IO/AppDataPathProvider.cs

@@ -8,7 +8,6 @@ public sealed class AppDataPathProvider : IAppDataPathProvider
 { 
     public AppDataPathProvider(AppDataPathConfig config, IFileSystem fileSystem)
     {
-        ArgumentNullException.ThrowIfNull(config);
         ArgumentNullException.ThrowIfNull(fileSystem);
 
         if (!string.IsNullOrWhiteSpace(config.AppSettingsPath))

src/RepoM.Core.Plugin/Repository/IRepository.cs

@@ -34,8 +34,7 @@ public interface IRepository
     bool HasUnpushedChanges { get; }
 
     public string[] ReadAllBranches();
-
-
+
     public bool HasLocalChanges { get; }
 
     public bool IsBehind { get; }