Version 1.0.2.2

Author: PowerCommands

Docs/Configuration.md

@@ -18,6 +18,9 @@ The Example project on Github has extended the configuration and will therefore
 ### CodeEditor
 The path to your favorite code editor, that you could start with the ConfigCommand, this command is shipping with the creation of new PowerCommand Visual Studio solution.
 
+### Command design overrides
+You can override some of the values that are set in the **PowerCommandsDesignAttribute**, read more about this [here](OverrideDesignAttribute.md)
+
 ### Components
 Here you declare those dll components that the Core framework will use to find all available Commands.
 
@@ -45,10 +48,21 @@ Enable or disable the display of diagnostic output.
 version: 1.0
 configuration:
   showDiagnosticInformation: false
-  defaultCommand: commands  
+  defaultCommand: commands
   codeEditor: C:\Users\%USERNAME%\AppData\Local\Programs\Microsoft VS Code\Code.exe
   repository: https://github.com/PowerCommands/PowerCommands2022
-  backupPath: ..\..\..\..\Core\PainKiller.PowerCommands.Core\  
+  backupPath: ..\..\..\..\..\
+  defaultGitRepositoryPath: C:\repos\github\PowerCommands2022
+  commandDesignOverrides:
+  - name: demo
+    description: "Demo command just to try out how you could use the input, do not forget the MANDATORY option, will trigger a validation error otherwise! ;-)\n That is because the option name is typed with UPPERCASE letters, useful when you want a mandatory option\n The pause option on the other hand starts with a ! symbol meaning that if you add the --pause option you must also give it a value, an integer in this case."
+    arguments: "!<url>"
+    quotes: "!<local file path>"    
+    options: "!MANDATORY|!pause"
+    examples: "//Must provide the MANDATORY option, will trigger a validation error otherwise|demo MANDATORY|//Test the pause service|demo --pause 5 MANDATORY"
+    suggestions: ""
+    useAsync: true
+    showElapsedTime: false  
   metadata:
     name: Test
     description: En exempelbeskrivning
@@ -60,24 +74,22 @@ configuration:
     component: PainKiller.SerilogExtensions.dll
     checksum: 13b9944b55efe60362720a679f17a22c
     name: Serialog
-  components:
+  components:  
+  - component: PainKiller.PowerCommands.MyExampleCommands.dll
+    checksum: a2df61ea89e4f9ec265d921bfad87193
+    name: My Example Command  
   - component: PainKiller.PowerCommands.Core.dll
     checksum: 4f04313db8e67b2bc4b059c478a900af
     name: PainKiller Core
-  - component: PainKiller.PowerCommands.MyExampleCommands.dll
-    checksum: a2df61ea89e4f9ec265d921bfad87193
-    name: My Example Command
-  secret:
-    secrets:
-    - name: localDB
-      options:
-        target: User
+  bookmark:
+    bookmarks:
+    - name: Program
+      path: C:\Program Files
+      index: 0
   environment:
     variables:
-    - name: VAULT_NAME
-      environmentVariableTarget: User
-    - name: CLIENT_ID
-      environmentVariableTarget: User
+    - name: OS
+      environmentVariableTarget: Machine
 ```
 
 Next step could be to [Extend your configuration](ExtendYourConfiguration.md)
@@ -86,6 +98,8 @@ Read more about:
 
 [Design your Command](Design_command.md)
 
+[Override Design attribute](OverrideDesignAttribute.md)
+
 [Documentation index](DocumentationIndexDB.md)
 
 [Back to start](https://github.com/PowerCommands/PowerCommands2022/blob/main/Docs/README.md)

Docs/OverrideDesignAttribute.md

@@ -0,0 +1,34 @@
+# Override PowerCommandsDesign Attribute
+## Edit PowerCommandsConfiguration.yaml file
+In some cases you may want to override the **PowerCommandsDesignAttribute** a typical use case could be that you want a different kind of suggestions or add suggestions to a certain command in your implementation but you do not want to change the source code and recompile it.
+Then this feature to override it in configuration comes in handy. 
+
+![Alt text](images/override_design_attribute.png?raw=true "Attribute")
+
+The image above illustrates how it could look like, the table below shows those properties of the design attribute you can override.
+### PLEASE NOTE
+In the configuration file you just add those properties you want to override, the **name** property is not a property of the design attribute, it is the name of the command that you are overriding the design attribute for.
+
+| Property Name    | Data Type |
+|------------------|-----------|
+| **name**         | string    |
+| description      | string    |
+| arguments        | string    |
+| quotes           | string    |
+| options          | string    |
+| examples         | string    |
+| suggestions      | string    |
+| useAsync         | boolean   |
+| showElapsedTime  | boolean   |
+
+### Read more about:
+
+[PowerCommandDesign Attribute](PowerCommandDesignAttribute.md)
+
+[Design your Command](Design_command.md)
+
+[Input](Input.md)
+
+[options](options.md)
+
+[Back to start](https://github.com/PowerCommands/PowerCommands2022/blob/main/Docs/README.md)

Docs/images/override_design_attribute.png

@@ -29,6 +29,8 @@ https://github.com/PowerCommands/PowerCommands2022/assets/102176789/d8ad92f0-93a
 
 [Power Commands Design attribute](Docs/PowerCommandDesignAttribute.md)
 
+[Override Design attribute in config file](Docs/OverrideDesignAttribute.md)
+
 [Patterns to use the Toolbar with dynamic content](Docs/PowerCommandToolbarAttribute.md)
 
 [Command base class](Docs/CommandBase.md)

README.md

@@ -14,6 +14,12 @@ I recommend you to use the option ```Place solution in the same directory``` som
 
 
 # What is new?
+## Version 1.0.2.2
+**Released 2023-09-09**
+- Some of the values set with ```PowerCommandsDesignAttribute``` is now possible to override in the **PowerCommandsConfiguration.yaml** file, look at the example that comes with the VS template or read the documentation on GitHub.
+- Removed checksum control at startup as it achieves no really security purpose.
+- Minor fixes in core dialogs.
+
 ## Version 1.0.2.1
 **Released 2023-07-24**
 - ```ReadLineService``` now has two static events by the ```OpenShortCutPressed``` Occurs when user press [`Ctrl + O`], ```SaveShortCutPressed``` Occurs when user press [`Ctrl + S`].

Templates/PowerCommands.zip

@@ -29,7 +29,7 @@ public virtual bool InitializeAndValidateInput(ICommandLineInput input, PowerCom
         if (IPowerCommandServices.DefaultInstance!.DefaultConsoleService.GetType().Name != _console.GetType().Name) _console = IPowerCommandServices.DefaultInstance.DefaultConsoleService;
         Input = input;
         DesignAttribute = designAttribute;
-        IPowerCommandServices.DefaultInstance.Diagnostic.ShowElapsedTime = DesignAttribute.ShowElapsedTime;
+        IPowerCommandServices.DefaultInstance.Diagnostic.ShowElapsedTime = DesignAttribute.ShowElapsedTime.GetValueOrDefault();
         var validationManager = new InputValidationManager(this, input, WriteError);
         var result = validationManager.ValidateAndInitialize();
         if (result.Options.Count > 0) Options.AddRange(result.Options);
@@ -70,8 +70,10 @@ public virtual void RunCompleted()
     #endregion
 
     #region RunResult
-    protected RunResult Ok() => new(this, Input, _ouput.ToString(), RunResultStatus.Ok);
-    protected RunResult Quit() => new(this, Input, _ouput.ToString(), RunResultStatus.Quit);
+    protected RunResult Ok(string message) => new(this, Input, $"{message} {_ouput}", RunResultStatus.Ok);
+    protected RunResult Ok() => Ok(_ouput.ToString());
+    protected RunResult Quit() => Quit(_ouput.ToString());
+    protected RunResult Quit(string message) => new(this, Input, $"{message} {_ouput}", RunResultStatus.Ok);
     protected RunResult BadParameterError(string output) => new(this, Input, output, RunResultStatus.ArgumentError);
     protected RunResult ExceptionError(string output) => new(this, Input, output, RunResultStatus.ExceptionThrown);
     protected RunResult ContinueWith(string rawInput) => new(this, Input, _ouput.ToString(), RunResultStatus.ExceptionThrown, rawInput);

Templates/README.md

@@ -1,10 +1,11 @@
 using PainKiller.PowerCommands.Security.Services;
 
 namespace $safeprojectname$.Commands;
+
 [PowerCommandDesign(description: "Get, creates, removes or view secrets, first you need to configure your encryption key with initialize argument",
-                        options: "initialize|configuration|create|get|remove|salt",
-             disableProxyOutput: true,
-                        example: "//View all declared secrets|secret|//Get the decrypted value of named secret|secret --get \"mycommand-pass\"|secret --create \"mycommand-pass\"|secret --remove \"mycommand-pass\"|//Initialize your machine with a new encryption key (stops if this is already done)|secret --initialize")]
+    options: "create|initialize|configuration|remove|salt",
+    disableProxyOutput: true,
+    example: "//View all declared secrets|secret|secret --create \"mycommand-pass\"|secret --remove \"mycommand-pass\"|//Initialize your machine with a new encryption key (stops if this is already done)|secret --initialize")]
 public class SecretCommand : CommandBase<CommandsConfiguration>
 {
     public SecretCommand(string identifier, CommandsConfiguration configuration) : base(identifier, configuration) { }
@@ -13,7 +14,6 @@ public override RunResult Run()
         if (Input.HasOption("initialize")) return Init();
         if (Input.HasOption("")) return CheckEncryptConfiguration();
         if (Input.HasOption("salt")) return Salt();
-        if (Input.HasOption("get")) return Get();
         if (Input.HasOption("create")) return Create();
         if (Input.HasOption("remove")) return Remove();
         if ((Input.Arguments.Length + Input.Quotes.Length < 2) && Input.Arguments.Length > 0) throw new MissingFieldException("Two parameters must be provided");
@@ -45,8 +45,8 @@ private RunResult Salt()
 
     private RunResult Init()
     {
-        var firstHalf = IEncryptionService.GetRandomSalt();;
-        var secondHalf = IEncryptionService.GetRandomSalt();;
+        var firstHalf = IEncryptionService.GetRandomSalt(); 
+        var secondHalf = IEncryptionService.GetRandomSalt(); 
         Environment.SetEnvironmentVariable("_encryptionManager", firstHalf, EnvironmentVariableTarget.User);
         var securityConfig = new SecurityConfiguration { Encryption = new EncryptionConfiguration { SharedSecretEnvironmentKey = "_encryptionManager", SharedSecretSalt = secondHalf } };
         var fileName = Path.Combine(ConfigurationGlobals.ApplicationDataFolder, ConfigurationGlobals.SecurityFileName);
@@ -57,31 +57,18 @@ private RunResult Init()
 
     private RunResult List()
     {
-        if (Configuration.Secret.Secrets == null) return Ok();
         foreach (var secret in Configuration.Secret.Secrets) ConsoleService.Service.WriteObjectDescription($"{GetType().Name}", secret.Name, $"{string.Join(',', secret.Options.Keys)}");
         return Ok();
     }
-    private RunResult Get()
-    {
-        var name = Input.SingleQuote;
-        var secret = Configuration.Secret.Secrets.FirstOrDefault(s => s.Name.ToLower() == name.ToLower());
-        if (secret == null) return BadParameterError($"No secret with name \"{name}\" found.");
-
-        var val = SecretService.Service.GetSecret(name, secret.Options, EncryptionService.Service.DecryptString);
-        ConsoleService.Service.WriteObjectDescription($"{GetType().Name}", name, val);
-
-        return Ok();
-    }
     private RunResult Create()
     {
         var name = Input.SingleQuote;
         var password = DialogService.SecretPromptDialog("Enter secret:");
         if (string.IsNullOrEmpty(password)) return BadParameterError("Passwords do not match");
-        
+
         var secret = new SecretItemConfiguration { Name = name };
         var val = SecretService.Service.SetSecret(name, password, secret.Options, EncryptionService.Service.EncryptString);
-
-        Configuration.Secret ??= new();
+        
         Configuration.Secret.Secrets ??= new();
         Configuration.Secret.Secrets.Add(secret);
         ConfigurationService.Service.SaveChanges(Configuration);

Templates/src/Core/PainKiller.PowerCommands.Core/BASECLASSES/CommandBase.cs

@@ -43,7 +43,12 @@ public static List<PropertyInfo> GetProperties(this Type instanceType)
     public static PowerCommandDesignAttribute GetPowerCommandAttribute(this IConsoleCommand command)
     {
         var attributes = command.GetType().GetCustomAttributes(typeof(PowerCommandDesignAttribute), inherit: false);
-        return attributes.Length == 0 ? new PowerCommandDesignAttribute(description:"Command have no description attribute") : (PowerCommandDesignAttribute)attributes.First();
+        var retVal = attributes.Length == 0 ? new PowerCommandDesignAttribute(description:"Command have no description attribute") : (PowerCommandDesignAttribute)attributes.First();
+        var cfgAttr = ReflectionService.CommandDesignOverrides.FirstOrDefault(c => c.Name == command.Identifier);
+        if (cfgAttr == null) return retVal;
+        //Not all values must be set in config so we have to create a new merged cfgDesign where does values that are not set is taken from the runtime attribute values
+        var cfgDesignMerged = new PowerCommandDesignConfiguration(cfgAttr, retVal);
+        return new PowerCommandDesignAttribute(description: cfgDesignMerged.Description, overrideHelpOption: retVal.OverrideHelpOption, arguments: cfgDesignMerged.Arguments, quotes: cfgDesignMerged.Quotes, example: cfgDesignMerged.Examples, options: cfgDesignMerged.Options, secrets: retVal.Secrets, suggestions: cfgDesignMerged.Suggestions, useAsync: cfgDesignMerged.UseAsync.GetValueOrDefault(), disableProxyOutput: retVal.DisableProxyOutput, showElapsedTime: cfgDesignMerged.ShowElapsedTime.GetValueOrDefault());
     }
     public static PowerCommandsToolbarAttribute? GetToolbarAttribute(this IConsoleCommand command)
     {

Templates/src/Core/PainKiller.PowerCommands.Core/COMMANDS/SecretCommand.cs

@@ -8,22 +8,6 @@ public ComponentManager(TConfiguration configuration, IDiagnosticManager diagnos
         _configuration = configuration;
         _diagnostic = diagnostic;
     }
-    public bool ValidateConfigurationWithComponents()
-    {
-        var retVal = true;
-        var components = typeof(TConfiguration).GetPropertiesOfT<BaseComponentConfiguration>().Select(c => c.GetValue(_configuration) as BaseComponentConfiguration).ToList();
-        if(_configuration.Components.Count > 0) components.AddRange(_configuration.Components);
-        _diagnostic.Header("\nChecksum validations:");
-        foreach (var component in components)
-        {
-            if(component is null) continue;
-            var fileCheckSum = new FileChecksum(component.Component);
-            var validateCheckSum = fileCheckSum.CompareFileChecksum(component.Checksum) ? "Valid" : "Not valid";
-            if(validateCheckSum == "Not valid") retVal = false;
-            _diagnostic.Message($"{component.Name} Checksum {fileCheckSum.Mde5Hash} {validateCheckSum}");
-        }
-        return retVal;
-    }
     public List<BaseComponentConfiguration> AutofixConfigurationComponents<T>(T configuration) where T : CommandsConfiguration, new()
     {
         var retVal = new List<BaseComponentConfiguration>();