From 30bcbbee3f6836b57615b19f8180b697d4da9a68 Mon Sep 17 00:00:00 2001 From: Mikey Bronowski Date: Wed, 8 Mar 2023 22:13:31 +0000 Subject: [PATCH 1/6] Update Get-PlasterTemplate.md --- docs/en-US/Get-PlasterTemplate.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en-US/Get-PlasterTemplate.md b/docs/en-US/Get-PlasterTemplate.md index 36a7711..97e0be1 100644 --- a/docs/en-US/Get-PlasterTemplate.md +++ b/docs/en-US/Get-PlasterTemplate.md @@ -49,7 +49,7 @@ PS C:\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ``` This will get the list of built-in Plaster templates. The first template returned is then used to -create a new module at the specifed path. +create a new module at the specified path. ### Example 2 ``` @@ -60,7 +60,7 @@ PS C:\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath This will get a list of Plaster templates, both built-in and included with installed modules. The first template returned is then used to create a new module at -the specifed path. +the specified path. ### Example 3 ``` @@ -70,7 +70,7 @@ PS C:\> Invoke-Plaster -TemplatePath $templates[0].TemplatePath -DestinationPath ``` This will get a list of Plaster templates found recursively under c:\MyPlasterTemplates -The first template returned is then used to create a new module at the specifed path. +The first template returned is then used to create a new module at the specified path. ### Example 4 ``` From 5adb1cb189ac4171f2722957a896e11220fb2289 Mon Sep 17 00:00:00 2001 From: Mikey Bronowski Date: Wed, 8 Mar 2023 22:19:07 +0000 Subject: [PATCH 2/6] Update New-PlasterManifest.md --- docs/en-US/New-PlasterManifest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en-US/New-PlasterManifest.md b/docs/en-US/New-PlasterManifest.md index eb79d22..a07a1b8 100644 --- a/docs/en-US/New-PlasterManifest.md +++ b/docs/en-US/New-PlasterManifest.md @@ -119,7 +119,7 @@ Accept wildcard characters: False ### -Description Description of the Plaster template. -This describes what the the template is for. +This describes what the template is for. It is typically used in an editor like VSCode when displaying additional information about a Plaster template. A typical title might be "Creates files required for a PowerShell module with optional support for Pester From 1ce0cfabffa88919e4f6bcd763c2975b0b90340c Mon Sep 17 00:00:00 2001 From: Mikey Bronowski Date: Wed, 8 Mar 2023 22:20:18 +0000 Subject: [PATCH 3/6] Update Plaster.md --- docs/en-US/Plaster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en-US/Plaster.md b/docs/en-US/Plaster.md index 8464e09..c1c1ede 100644 --- a/docs/en-US/Plaster.md +++ b/docs/en-US/Plaster.md @@ -23,5 +23,5 @@ Retrieves available Plaster templates which can be scaffolded with Invoke-Plaste Creates a new Plaster template manifest file. ### [Test-PlasterManifest](Test-PlasterManifest.md) -Verifies that a plaster manifest file is a valid. +Verifies that a plaster manifest file is valid. From 8cf89b93d368a93b8028424fddd60f3276b6eb5b Mon Sep 17 00:00:00 2001 From: Mikey Bronowski Date: Wed, 8 Mar 2023 22:20:57 +0000 Subject: [PATCH 4/6] Update Test-PlasterManifest.md --- docs/en-US/Test-PlasterManifest.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en-US/Test-PlasterManifest.md b/docs/en-US/Test-PlasterManifest.md index 9fed78c..1be7aff 100644 --- a/docs/en-US/Test-PlasterManifest.md +++ b/docs/en-US/Test-PlasterManifest.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Test-PlasterManifest ## SYNOPSIS -Verifies that a plaster manifest file is a valid. +Verifies that a plaster manifest file is valid. ## SYNTAX @@ -17,7 +17,7 @@ Test-PlasterManifest [[-Path] ] [] ``` ## DESCRIPTION -Verifies that a plaster manifest file is a valid. +Verifies that a plaster manifest file is valid. If there are any errors, the details of the errors can be viewed by using the Verbose parameter. From 83c1c5daee2e855d0ee32a89ce6e337adaffa562 Mon Sep 17 00:00:00 2001 From: Mikey Bronowski Date: Wed, 8 Mar 2023 22:26:28 +0000 Subject: [PATCH 5/6] Update about_Plaster_CreatingAManifest.help.md --- docs/en-US/about_Plaster_CreatingAManifest.help.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/en-US/about_Plaster_CreatingAManifest.help.md b/docs/en-US/about_Plaster_CreatingAManifest.help.md index da568e1..91a67e9 100644 --- a/docs/en-US/about_Plaster_CreatingAManifest.help.md +++ b/docs/en-US/about_Plaster_CreatingAManifest.help.md @@ -47,7 +47,7 @@ template. This field is automatically generated if not given a value. - `tags` - Tags used to describe the purpose of the template. - `author` - (Optional) Authors name or details. -An example of the settings explained above can be shown by running `New-PlasterManifest` this would give you something similar to the the following: +An example of the settings explained above can be shown by running `New-PlasterManifest` this would give you something similar to the following: ```xml ` directive. - PLASTER_DirSepChar - The directory separator char for the platform. - PLASTER_HostName - The PowerShell host name e.g. $Host.Name From 78d65a41d9efdc5306e55ea94096ffb3ac1d6cd5 Mon Sep 17 00:00:00 2001 From: Mikey Bronowski Date: Wed, 8 Mar 2023 22:28:07 +0000 Subject: [PATCH 6/6] Update DesignNotes.md --- docs/DesignNotes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/DesignNotes.md b/docs/DesignNotes.md index 4622816..af2ff0a 100644 --- a/docs/DesignNotes.md +++ b/docs/DesignNotes.md @@ -34,7 +34,7 @@ This document aims to lay out a rough design for a new module named Plaster whic dangerous because you can execute arbitrary code in $() e.g. `$(Remove-Item $home\* -Recurse -Force)` - with flexibility comes greater danger. The bigger issue here is that we can no longer guarantee `idempotency` when the template is invoked multiple times against the same destination. If we can prevent "side effects" from arbitrary code executing in an attribute like `destination` then we can provide a - good (predictable) experience when invoking the template multiple times againt the same destination folder. + good (predictable) experience when invoking the template multiple times against the same destination folder. A better (safe) option is to have the user specify a `name` of a variable that will be created by PowerShell and that they can later reference by name e.g. `${PLASTER_PARAM_ModuleName}` We in fact allow any accessible variables like `${env:COMPUTERNAME}` @@ -48,7 +48,7 @@ This document aims to lay out a rough design for a new module named Plaster whic script and ask the user if they trust the template. We might even give the user an option to open the script in an editor so they can see what it wants to do. One issue with these `