Skip to content

Commit 181ea4e

Browse files
authored
Merge pull request #431 from MikeyBronowski/patch-1
Fixed some typos
2 parents 8c10e74 + 78d65a4 commit 181ea4e

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

docs/DesignNotes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This document aims to lay out a rough design for a new module named Plaster whic
3434
dangerous because you can execute arbitrary code in $() e.g. `$(Remove-Item $home\* -Recurse -Force)` - with flexibility comes greater danger.
3535
The bigger issue here is that we can no longer guarantee `idempotency` when the template is invoked multiple times against the same destination.
3636
If we can prevent "side effects" from arbitrary code executing in an attribute like `destination` then we can provide a
37-
good (predictable) experience when invoking the template multiple times againt the same destination folder.
37+
good (predictable) experience when invoking the template multiple times against the same destination folder.
3838

3939
A better (safe) option is to have the user specify a `name` of a variable that will be created by PowerShell and that they
4040
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
4848
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
4949
it wants to do. One issue with these `<script>` directives is idempotency. It is not uncommon that a user might want to run the template again
5050
for the same output directory. The script needs to be "smart" about that and warn the user when it detects a `conflict` with an existing file.
51-
The user can then chose to allow the existing file to be overwritten or not.
51+
The user can then choose to allow the existing file to be overwritten or not.
5252

5353
This approach should eliminate arbitrary code execution but we will need to provide a set of predefined variables. Looking at
5454
[VSIX list of template parameters](https://msdn.microsoft.com/en-us/library/eehb4faa.aspx) gives a good idea of what we might want to predefine.

docs/en-US/New-PlasterManifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Accept wildcard characters: False
119119
120120
### -Description
121121
Description of the Plaster template.
122-
This describes what the the template is for.
122+
This describes what the template is for.
123123
It is typically used in
124124
an editor like VSCode when displaying additional information about a Plaster template.
125125
A typical title might be "Creates files required for a PowerShell module with optional support for Pester

docs/en-US/Plaster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ Retrieves available Plaster templates which can be scaffolded with Invoke-Plaste
2323
Creates a new Plaster template manifest file.
2424

2525
### [Test-PlasterManifest](Test-PlasterManifest.md)
26-
Verifies that a plaster manifest file is a valid.
26+
Verifies that a plaster manifest file is valid.
2727

docs/en-US/Test-PlasterManifest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Test-PlasterManifest
99

1010
## SYNOPSIS
11-
Verifies that a plaster manifest file is a valid.
11+
Verifies that a plaster manifest file is valid.
1212

1313
## SYNTAX
1414

@@ -17,7 +17,7 @@ Test-PlasterManifest [[-Path] <String[]>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
20-
Verifies that a plaster manifest file is a valid.
20+
Verifies that a plaster manifest file is valid.
2121
If there are any errors, the details of the errors can be viewed by using the
2222
Verbose parameter.
2323

docs/en-US/about_Plaster_CreatingAManifest.help.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ template. This field is automatically generated if not given a value.
4747
- `tags` - Tags used to describe the purpose of the template.
4848
- `author` - (Optional) Authors name or details.
4949

50-
An example of the settings explained above can be shown by running `New-PlasterManifest` this would give you something similar to the the following:
50+
An example of the settings explained above can be shown by running `New-PlasterManifest` this would give you something similar to the following:
5151
```xml
5252
<?xml version="1.0" encoding="utf-8"?>
5353
<plasterManifest
@@ -179,7 +179,7 @@ Choice[0]:
179179
```
180180

181181
### Parameter Type: Other
182-
The `user-fullname` and `user-email` parameter types are the same as the `text` type, except that they get their default values from from the user's .gitconfig file (if the user has one, and no default is set in the manifest).
182+
The `user-fullname` and `user-email` parameter types are the same as the `text` type, except that they get their default values from the user's .gitconfig file (if the user has one, and no default is set in the manifest).
183183

184184
Here is an example of the XML for this parameter.
185185
```xml
@@ -195,7 +195,7 @@ Enter your full name (Your Name):
195195
```
196196

197197
## Content
198-
There are a selection of elements in the `content` block that can be used to specify all of the content that should be included with your template and how it should be created and transformed into the end product that the template provides.
198+
There is a selection of elements in the `content` block that can be used to specify all of the content that should be included with your template and how it should be created and transformed into the end product that the template provides.
199199

200200
The available element types are:
201201
- `file` - Specify one or more files to copy under the destination folder.
@@ -311,7 +311,7 @@ Available attributes for this content element are:
311311
- `condition` - Used to determine whether a directive is executed. If the condition (a PowerShell expression) evaluates to true, it will execute.
312312
- `openInEditor` - Specifies whether the file should be opened in the editor (true) after scaffolding or not (false). The PowerShell extension for Visual Studio Code honors this setting.
313313

314-
Here is a simple example of the modify element, using a regular expressions:
314+
Here is a simple example of the modify element, using a regular expression:
315315

316316
```xml
317317
<modify path='.vscode\tasks.json' encoding='UTF8'
@@ -361,7 +361,7 @@ Available attributes for this content element:
361361
- `minimumVersion` - The required module's minimum version.
362362
- `maximumVersion` - The required module's maximum version.
363363
- `requiredVersion` - Specifies a specific version of the module. This attribute cannot be used with either the `minimumVersion` or `maximumVersion` attributes. Use this attribute rarely as any update to the module that changes its version will result in this check failing.
364-
- `message` - Specifies a custom message to display after the standard Plaster message when the specified module's is not available on the target machine. This message should be used to tell the user what functionality will not work without the specified module.
364+
- `message` - Specifies a custom message to display after the standard Plaster message when the specified module is not available on the target machine. This message should be used to tell the user what functionality will not work without the specified module.
365365
- `condition` - Used to determine whether a directive is executed. If the condition (a PowerShell expression) evaluates to true, it will execute.
366366

367367
#### NOTE: All versions in this element should be specified in the three part MAJOR.MINOR.PATCH (Semver) format.
@@ -407,7 +407,7 @@ In addition to these variables, Plaster defines a set of built-in variables:
407407

408408
- PLASTER_TemplatePath - The absolute path to the template directory.
409409
- PLASTER_DestinationPath - The absolute path to the destination directory.
410-
- PLASTER_DestinationName - The name of the destinaion directory.
410+
- PLASTER_DestinationName - The name of the destination directory.
411411
- PLASTER_FileContent - The contents of a file be modified via the `<modify>` directive.
412412
- PLASTER_DirSepChar - The directory separator char for the platform.
413413
- PLASTER_HostName - The PowerShell host name e.g. $Host.Name

0 commit comments

Comments
 (0)