From 9448e171a9bcb8f1032230e1e7e81eb7a727678c Mon Sep 17 00:00:00 2001 From: Timothy Aldrich Date: Fri, 13 Oct 2023 18:33:35 -0400 Subject: [PATCH 1/3] docs: Initial export of markdown with platyps --- docs/stitch/Add-ChangelogEntry.md | 87 ++++++ docs/stitch/Add-GitFile.md | 125 ++++++++ docs/stitch/Checkpoint-GitWorkingDirectory.md | 59 ++++ docs/stitch/Clear-MergedGitBranch.md | 109 +++++++ docs/stitch/Confirm-Path.md | 73 +++++ docs/stitch/Convert-ConfigurationFile.md | 78 +++++ docs/stitch/Convert-LineEnding.md | 100 +++++++ docs/stitch/ConvertFrom-Changelog.md | 72 +++++ docs/stitch/ConvertFrom-CommentedProperty.md | 74 +++++ docs/stitch/ConvertFrom-ConventionalCommit.md | 127 +++++++++ docs/stitch/ConvertTo-Changelog.md | 57 ++++ docs/stitch/Export-ReleaseNotes.md | 90 ++++++ .../Find-BuildConfigurationDirectory.md | 57 ++++ .../Find-BuildConfigurationRootDirectory.md | 62 ++++ docs/stitch/Find-BuildProfileRootDirectory.md | 57 ++++ docs/stitch/Find-BuildRunBook.md | 60 ++++ docs/stitch/Find-InvokeBuildScript.md | 61 ++++ docs/stitch/Find-InvokeBuildTaskFile.md | 63 ++++ docs/stitch/Find-LocalUserStitchDirectory.md | 57 ++++ docs/stitch/Find-ParseToken.md | 89 ++++++ docs/stitch/Find-StitchConfigurationFile.md | 60 ++++ docs/stitch/Find-TodoItem.md | 56 ++++ docs/stitch/Format-File.md | 72 +++++ docs/stitch/Get-BuildConfiguration.md | 150 ++++++++++ docs/stitch/Get-BuildTask.md | 60 ++++ docs/stitch/Get-ChangelogConfig.md | 57 ++++ docs/stitch/Get-CurrentEditorFile.md | 45 +++ docs/stitch/Get-FeatureFlag.md | 57 ++++ docs/stitch/Get-GitFile.md | 58 ++++ docs/stitch/Get-GitHistory.md | 45 +++ docs/stitch/Get-GitHubDefaultBranch.md | 57 ++++ docs/stitch/Get-GitMergedBranch.md | 57 ++++ docs/stitch/Get-GitModifiedFile.md | 42 +++ docs/stitch/Get-GitRemoteTrackingBranch.md | 42 +++ docs/stitch/Get-GitStagedFile.md | 42 +++ docs/stitch/Get-GitUntrackedFile.md | 42 +++ docs/stitch/Get-ModuleExtension.md | 88 ++++++ docs/stitch/Get-ModuleItem.md | 78 +++++ docs/stitch/Get-ModulePath.md | 45 +++ docs/stitch/Get-ParseToken.md | 73 +++++ docs/stitch/Get-ProjectPath.md | 43 +++ docs/stitch/Get-ProjectVersionInfo.md | 60 ++++ docs/stitch/Get-SourceItem.md | 75 +++++ docs/stitch/Get-SourceTypeMap.md | 60 ++++ docs/stitch/Get-StitchTemplate.md | 75 +++++ docs/stitch/Get-TaskConfiguration.md | 74 +++++ docs/stitch/Get-TaskHelp.md | 72 +++++ docs/stitch/Get-TestItem.md | 60 ++++ docs/stitch/Get-VSCodeSetting.md | 75 +++++ docs/stitch/Initialize-StitchProject.md | 121 ++++++++ docs/stitch/Invoke-BuildNotification.md | 85 ++++++ docs/stitch/Invoke-ReplaceToken.md | 136 +++++++++ docs/stitch/Join-PullRequest.md | 98 +++++++ docs/stitch/Measure-File.md | 87 ++++++ docs/stitch/Merge-BuildConfiguration.md | 90 ++++++ docs/stitch/Merge-FileCollection.md | 86 ++++++ docs/stitch/Merge-SourceItem.md | 90 ++++++ docs/stitch/New-FunctionItem.md | 182 ++++++++++++ docs/stitch/New-SourceComponent.md | 108 +++++++ docs/stitch/New-SourceItem.md | 164 +++++++++++ docs/stitch/New-StitchBuildProfile.md | 90 ++++++ docs/stitch/New-StitchBuildRunner.md | 118 ++++++++ docs/stitch/New-StitchConfigurationFile.md | 119 ++++++++ docs/stitch/New-StitchConfigurationPath.md | 76 +++++ .../stitch/New-StitchPathConfigurationFile.md | 182 ++++++++++++ docs/stitch/New-StitchRunBook.md | 119 ++++++++ docs/stitch/New-TestItem.md | 87 ++++++ docs/stitch/Rename-SourceItem.md | 87 ++++++ docs/stitch/Resolve-ProjectName.md | 45 +++ docs/stitch/Resolve-ProjectRoot.md | 167 +++++++++++ docs/stitch/Select-BuildRunBook.md | 73 +++++ docs/stitch/Set-ChangelogRelease.md | 135 +++++++++ docs/stitch/Start-GitBranch.md | 57 ++++ docs/stitch/Sync-GitRepository.md | 73 +++++ docs/stitch/Test-CommentedProperty.md | 70 +++++ docs/stitch/Test-FeatureFlag.md | 58 ++++ docs/stitch/Test-InInvokeBuild.md | 45 +++ docs/stitch/Test-PathIsIn.md | 91 ++++++ docs/stitch/Test-ProjectPath.md | 45 +++ docs/stitch/Test-ProjectRoot.md | 167 +++++++++++ docs/stitch/Test-WindowsLineEnding.md | 57 ++++ docs/stitch/Undo-GitCommit.md | 80 ++++++ docs/stitch/Update-GitRepository.md | 73 +++++ docs/stitch/Update-ManifestField.md | 90 ++++++ docs/stitch/Write-StitchLogo.md | 76 +++++ docs/stitch/stitch.md | 268 ++++++++++++++++++ 86 files changed, 7172 insertions(+) create mode 100644 docs/stitch/Add-ChangelogEntry.md create mode 100644 docs/stitch/Add-GitFile.md create mode 100644 docs/stitch/Checkpoint-GitWorkingDirectory.md create mode 100644 docs/stitch/Clear-MergedGitBranch.md create mode 100644 docs/stitch/Confirm-Path.md create mode 100644 docs/stitch/Convert-ConfigurationFile.md create mode 100644 docs/stitch/Convert-LineEnding.md create mode 100644 docs/stitch/ConvertFrom-Changelog.md create mode 100644 docs/stitch/ConvertFrom-CommentedProperty.md create mode 100644 docs/stitch/ConvertFrom-ConventionalCommit.md create mode 100644 docs/stitch/ConvertTo-Changelog.md create mode 100644 docs/stitch/Export-ReleaseNotes.md create mode 100644 docs/stitch/Find-BuildConfigurationDirectory.md create mode 100644 docs/stitch/Find-BuildConfigurationRootDirectory.md create mode 100644 docs/stitch/Find-BuildProfileRootDirectory.md create mode 100644 docs/stitch/Find-BuildRunBook.md create mode 100644 docs/stitch/Find-InvokeBuildScript.md create mode 100644 docs/stitch/Find-InvokeBuildTaskFile.md create mode 100644 docs/stitch/Find-LocalUserStitchDirectory.md create mode 100644 docs/stitch/Find-ParseToken.md create mode 100644 docs/stitch/Find-StitchConfigurationFile.md create mode 100644 docs/stitch/Find-TodoItem.md create mode 100644 docs/stitch/Format-File.md create mode 100644 docs/stitch/Get-BuildConfiguration.md create mode 100644 docs/stitch/Get-BuildTask.md create mode 100644 docs/stitch/Get-ChangelogConfig.md create mode 100644 docs/stitch/Get-CurrentEditorFile.md create mode 100644 docs/stitch/Get-FeatureFlag.md create mode 100644 docs/stitch/Get-GitFile.md create mode 100644 docs/stitch/Get-GitHistory.md create mode 100644 docs/stitch/Get-GitHubDefaultBranch.md create mode 100644 docs/stitch/Get-GitMergedBranch.md create mode 100644 docs/stitch/Get-GitModifiedFile.md create mode 100644 docs/stitch/Get-GitRemoteTrackingBranch.md create mode 100644 docs/stitch/Get-GitStagedFile.md create mode 100644 docs/stitch/Get-GitUntrackedFile.md create mode 100644 docs/stitch/Get-ModuleExtension.md create mode 100644 docs/stitch/Get-ModuleItem.md create mode 100644 docs/stitch/Get-ModulePath.md create mode 100644 docs/stitch/Get-ParseToken.md create mode 100644 docs/stitch/Get-ProjectPath.md create mode 100644 docs/stitch/Get-ProjectVersionInfo.md create mode 100644 docs/stitch/Get-SourceItem.md create mode 100644 docs/stitch/Get-SourceTypeMap.md create mode 100644 docs/stitch/Get-StitchTemplate.md create mode 100644 docs/stitch/Get-TaskConfiguration.md create mode 100644 docs/stitch/Get-TaskHelp.md create mode 100644 docs/stitch/Get-TestItem.md create mode 100644 docs/stitch/Get-VSCodeSetting.md create mode 100644 docs/stitch/Initialize-StitchProject.md create mode 100644 docs/stitch/Invoke-BuildNotification.md create mode 100644 docs/stitch/Invoke-ReplaceToken.md create mode 100644 docs/stitch/Join-PullRequest.md create mode 100644 docs/stitch/Measure-File.md create mode 100644 docs/stitch/Merge-BuildConfiguration.md create mode 100644 docs/stitch/Merge-FileCollection.md create mode 100644 docs/stitch/Merge-SourceItem.md create mode 100644 docs/stitch/New-FunctionItem.md create mode 100644 docs/stitch/New-SourceComponent.md create mode 100644 docs/stitch/New-SourceItem.md create mode 100644 docs/stitch/New-StitchBuildProfile.md create mode 100644 docs/stitch/New-StitchBuildRunner.md create mode 100644 docs/stitch/New-StitchConfigurationFile.md create mode 100644 docs/stitch/New-StitchConfigurationPath.md create mode 100644 docs/stitch/New-StitchPathConfigurationFile.md create mode 100644 docs/stitch/New-StitchRunBook.md create mode 100644 docs/stitch/New-TestItem.md create mode 100644 docs/stitch/Rename-SourceItem.md create mode 100644 docs/stitch/Resolve-ProjectName.md create mode 100644 docs/stitch/Resolve-ProjectRoot.md create mode 100644 docs/stitch/Select-BuildRunBook.md create mode 100644 docs/stitch/Set-ChangelogRelease.md create mode 100644 docs/stitch/Start-GitBranch.md create mode 100644 docs/stitch/Sync-GitRepository.md create mode 100644 docs/stitch/Test-CommentedProperty.md create mode 100644 docs/stitch/Test-FeatureFlag.md create mode 100644 docs/stitch/Test-InInvokeBuild.md create mode 100644 docs/stitch/Test-PathIsIn.md create mode 100644 docs/stitch/Test-ProjectPath.md create mode 100644 docs/stitch/Test-ProjectRoot.md create mode 100644 docs/stitch/Test-WindowsLineEnding.md create mode 100644 docs/stitch/Undo-GitCommit.md create mode 100644 docs/stitch/Update-GitRepository.md create mode 100644 docs/stitch/Update-ManifestField.md create mode 100644 docs/stitch/Write-StitchLogo.md create mode 100644 docs/stitch/stitch.md diff --git a/docs/stitch/Add-ChangelogEntry.md b/docs/stitch/Add-ChangelogEntry.md new file mode 100644 index 0000000..a36e298 --- /dev/null +++ b/docs/stitch/Add-ChangelogEntry.md @@ -0,0 +1,87 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Add-ChangelogEntry + +## SYNOPSIS +Add an entry to the changelog + +## SYNTAX + +``` +Add-ChangelogEntry [[-Commit] ] [[-Path] ] [[-Release] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Commit +The commit to add + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Path +Specifies a path to the changelog file + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Release +The release to add the entry to + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: Unreleased +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Add-GitFile.md b/docs/stitch/Add-GitFile.md new file mode 100644 index 0000000..5f3febe --- /dev/null +++ b/docs/stitch/Add-GitFile.md @@ -0,0 +1,125 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Add-GitFile + +## SYNOPSIS + +## SYNTAX + +### asPath (Default) +``` +Add-GitFile [[-Path] ] [-All] [-RepoRoot ] [-PassThru] [] +``` + +### asEntry +``` +Add-GitFile [-Entry ] [-All] [-RepoRoot ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-ChildItem *.md | function Add-GitFile +``` + +### EXAMPLE 2 +``` +Get-GitStatus | function Add-GitFile +``` + +## PARAMETERS + +### -Entry +Accept a statusentry + +```yaml +Type: RepositoryStatus[] +Parameter Sets: asEntry +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Path +Paths to files to add + +```yaml +Type: String[] +Parameter Sets: asPath +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -All +Add All items + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepoRoot +The repository root + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return objects to the pipeline + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Checkpoint-GitWorkingDirectory.md b/docs/stitch/Checkpoint-GitWorkingDirectory.md new file mode 100644 index 0000000..9921786 --- /dev/null +++ b/docs/stitch/Checkpoint-GitWorkingDirectory.md @@ -0,0 +1,59 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Checkpoint-GitWorkingDirectory + +## SYNOPSIS +Save all changes (including untracked) and push to upstream + +## SYNTAX + +``` +Checkpoint-GitWorkingDirectory [[-Message] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Message +Message to use for the checkpoint commit. +Defaults to: +\`\[checkpoint\] Creating checkpoint before continuing \\` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Clear-MergedGitBranch.md b/docs/stitch/Clear-MergedGitBranch.md new file mode 100644 index 0000000..3b11094 --- /dev/null +++ b/docs/stitch/Clear-MergedGitBranch.md @@ -0,0 +1,109 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Clear-MergedGitBranch + +## SYNOPSIS +Prune remote branches and local branches with no tracking branch + +## SYNTAX + +### Remote +``` +Clear-MergedGitBranch [-RemoteOnly] [-WhatIf] [-Confirm] [] +``` + +### Local +``` +Clear-MergedGitBranch [-LocalOnly] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RemoteOnly +Only clear remote branches + +```yaml +Type: SwitchParameter +Parameter Sets: Remote +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalOnly +Only clear remote branches + +```yaml +Type: SwitchParameter +Parameter Sets: Local +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Confirm-Path.md b/docs/stitch/Confirm-Path.md new file mode 100644 index 0000000..8da355b --- /dev/null +++ b/docs/stitch/Confirm-Path.md @@ -0,0 +1,73 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Confirm-Path + +## SYNOPSIS +Tests if the directory exists and if it does not, creates it. + +## SYNTAX + +``` +Confirm-Path [[-Path] ] [-ItemType ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +The path to confirm + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ItemType +The type of item to confirm + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Directory +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Convert-ConfigurationFile.md b/docs/stitch/Convert-ConfigurationFile.md new file mode 100644 index 0000000..e42a5a0 --- /dev/null +++ b/docs/stitch/Convert-ConfigurationFile.md @@ -0,0 +1,78 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +... + +# Convert-ConfigurationFile + + +## SYNOPSIS + +Convert a configuration file into a powershell hashtable. +Can be psd1, yaml, or json + + +## SYNTAX + + +```powershell +Convert-ConfigurationFile [[-Path] ] [] +``` + + +## DESCRIPTION + +{{ Fill in the Description }} + + +## EXAMPLES + + +### Example 1 + +```powershell +PS C:\> {{ Add example code here }} +``` + + +{{ Add example description here }} + + +## PARAMETERS + + +### -Path + +Specifies a path to one or more configuration files. + + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + + +## INPUTS + + +## OUTPUTS + + +## NOTES + + +## RELATED LINKS diff --git a/docs/stitch/Convert-LineEnding.md b/docs/stitch/Convert-LineEnding.md new file mode 100644 index 0000000..b29d015 --- /dev/null +++ b/docs/stitch/Convert-LineEnding.md @@ -0,0 +1,100 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Convert-LineEnding + +## SYNOPSIS +Convert the line endings in the given file to "Windows" (CRLF) or "Unix" (LF) + +## SYNTAX + +### Unix (Default) +``` +Convert-LineEnding [[-Path] ] [-LF] [] +``` + +### Windows +``` +Convert-LineEnding [[-Path] ] [-CRLF] [] +``` + +## DESCRIPTION +\`Convert-LineEnding\` will convert all of the line endings in the given file to the type specified. +If +'Windows' or 'CRLF' is given, all line endings will be '\r\n' and if 'Unix' or 'LF' is given all line +endings will be '\n' + +'Unix' (LF) is the default + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-ChildItem . -Filter "*.txt" | Convert-LineEnding -LF +``` + +Convert all txt files in the current directory to '\n' + +## PARAMETERS + +### -Path +The file to be converted + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LF +Convert line endings to 'Unix' (LF) + +```yaml +Type: SwitchParameter +Parameter Sets: Unix +Aliases: + +Required: False +Position: 2 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CRLF +Convert line endings to 'Windows' (CRLF) + +```yaml +Type: SwitchParameter +Parameter Sets: Windows +Aliases: + +Required: False +Position: 2 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +WARNING! +this can corrupt a binary file. + +## RELATED LINKS diff --git a/docs/stitch/ConvertFrom-Changelog.md b/docs/stitch/ConvertFrom-Changelog.md new file mode 100644 index 0000000..e74b82d --- /dev/null +++ b/docs/stitch/ConvertFrom-Changelog.md @@ -0,0 +1,72 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# ConvertFrom-Changelog + +## SYNOPSIS +Convert a Changelog file into a PSObject + +## SYNTAX + +``` +ConvertFrom-Changelog [-Path] [-AsHashTable] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AsHashTable +Optionally return a hashtable instead of an object + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/ConvertFrom-CommentedProperty.md b/docs/stitch/ConvertFrom-CommentedProperty.md new file mode 100644 index 0000000..a036be7 --- /dev/null +++ b/docs/stitch/ConvertFrom-CommentedProperty.md @@ -0,0 +1,74 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# ConvertFrom-CommentedProperty + +## SYNOPSIS +Uncomment the given Manifest Item + +## SYNTAX + +``` +ConvertFrom-CommentedProperty [-Path ] [[-Property] ] [] +``` + +## DESCRIPTION +In a typical manifest, unused properties are listed, but commented out with a '#' +like \`# ReleaseNotes = ''\` +Update-Metadata, Import-Psd and similar functions need to have these fields available. +\`ConvertFrom-CommentedProperty\` will remove the '#' from the line so that those functions can use the given +property + +## EXAMPLES + +### EXAMPLE 1 +``` +$manifest | ConvertFrom-CommentedProperty 'ReleaseNotes' +``` + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Property +The item to uncomment + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PropertyName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/ConvertFrom-ConventionalCommit.md b/docs/stitch/ConvertFrom-ConventionalCommit.md new file mode 100644 index 0000000..434049e --- /dev/null +++ b/docs/stitch/ConvertFrom-ConventionalCommit.md @@ -0,0 +1,127 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# ConvertFrom-ConventionalCommit + +## SYNOPSIS +Convert a git commit message (such as from PowerGit\Get-GitCommit) into an object on the pipeline + +## SYNTAX + +``` +ConvertFrom-ConventionalCommit [[-Message] ] [[-Sha] ] [[-Author] ] + [[-Committer] ] [] +``` + +## DESCRIPTION +A git commit message is technically unstructured text. +However, a long standing convention is to structure +the message should be a single line title, followed by a blank line and then any amount of text in the body. +Conventional Commits provide additional structure by adding "metadata" to the title: + +- +| |\<------ title ----------------------| \<- 50 char or less +| \\[optional scope\]: \ +message +| \[optional body\] \<- 72 char or less +| +| \[optional footer(s)\] \<- 72 char or less +- +Recommended types are: +- build +- chore +- ci +- docs +- feat +- fix +- perf +- refactor +- revert +- style +- test + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Message +The commit message to parse + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Sha +{{ Fill Sha Description }} + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Author +{{ Fill Author Description }} + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Committer +{{ Fill Committer Description }} + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/ConvertTo-Changelog.md b/docs/stitch/ConvertTo-Changelog.md new file mode 100644 index 0000000..c389f60 --- /dev/null +++ b/docs/stitch/ConvertTo-Changelog.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# ConvertTo-Changelog + +## SYNOPSIS +Convert Git-History to a Changelog + +## SYNTAX + +``` +ConvertTo-Changelog [[-History] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -History +A git history table to be converted + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Export-ReleaseNotes.md b/docs/stitch/Export-ReleaseNotes.md new file mode 100644 index 0000000..f87b722 --- /dev/null +++ b/docs/stitch/Export-ReleaseNotes.md @@ -0,0 +1,90 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Export-ReleaseNotes + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Export-ReleaseNotes [[-Path] ] [[-Destination] ] [-Release ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Destination +{{ Fill Destination Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Release +{{ Fill Release Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-BuildConfigurationDirectory.md b/docs/stitch/Find-BuildConfigurationDirectory.md new file mode 100644 index 0000000..f7591e6 --- /dev/null +++ b/docs/stitch/Find-BuildConfigurationDirectory.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-BuildConfigurationDirectory + +## SYNOPSIS +Find the directory that contains the build configuration for the given profile + +## SYNTAX + +``` +Find-BuildConfigurationDirectory [[-BuildProfile] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -BuildProfile +The BuildProfile to use + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-BuildConfigurationRootDirectory.md b/docs/stitch/Find-BuildConfigurationRootDirectory.md new file mode 100644 index 0000000..08a54df --- /dev/null +++ b/docs/stitch/Find-BuildConfigurationRootDirectory.md @@ -0,0 +1,62 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-BuildConfigurationRootDirectory + +## SYNOPSIS +Find the build configuration root directory for this project + +## SYNTAX + +``` +Find-BuildConfigurationRootDirectory [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Find-BuildConfigurationRootDirectory -Path $BuildRoot +``` + +### EXAMPLE 2 +``` +$BuildRoot | Find-BuildConfigurationRootDirectory +``` + +## PARAMETERS + +### -Path +Specifies a path to a location to look for the build configuration root + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.IO.DirectoryInfo +## NOTES +\`Find-BuildConfigurationRootDirectory\` looks in the current directory of the caller if no Path is given + +## RELATED LINKS diff --git a/docs/stitch/Find-BuildProfileRootDirectory.md b/docs/stitch/Find-BuildProfileRootDirectory.md new file mode 100644 index 0000000..6261595 --- /dev/null +++ b/docs/stitch/Find-BuildProfileRootDirectory.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-BuildProfileRootDirectory + +## SYNOPSIS +Find the directory that has the profiles defined + +## SYNTAX + +``` +Find-BuildProfileRootDirectory [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to a location that contains Build Profiles (This should be BuildConfigPath) + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-BuildRunBook.md b/docs/stitch/Find-BuildRunBook.md new file mode 100644 index 0000000..8c30b03 --- /dev/null +++ b/docs/stitch/Find-BuildRunBook.md @@ -0,0 +1,60 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-BuildRunBook + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Find-BuildRunBook [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-InvokeBuildScript.md b/docs/stitch/Find-InvokeBuildScript.md new file mode 100644 index 0000000..1ab7f52 --- /dev/null +++ b/docs/stitch/Find-InvokeBuildScript.md @@ -0,0 +1,61 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-InvokeBuildScript + +## SYNOPSIS +Find all "build script" files. +These are files that contain tasks to be executed by Invoke-Build + +## SYNTAX + +``` +Find-InvokeBuildScript [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations to look for build scripts. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Find-InvokeBuildTaskFile]() + diff --git a/docs/stitch/Find-InvokeBuildTaskFile.md b/docs/stitch/Find-InvokeBuildTaskFile.md new file mode 100644 index 0000000..85a2035 --- /dev/null +++ b/docs/stitch/Find-InvokeBuildTaskFile.md @@ -0,0 +1,63 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-InvokeBuildTaskFile + +## SYNOPSIS +Find all "task type" files. +These are files that contain "extensions" to the task types. +They define a +function that creates tasks. + +## SYNTAX + +``` +Find-InvokeBuildTaskFile [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations to look for task files. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Find-InvokeBuildScript]() + diff --git a/docs/stitch/Find-LocalUserStitchDirectory.md b/docs/stitch/Find-LocalUserStitchDirectory.md new file mode 100644 index 0000000..93fd50c --- /dev/null +++ b/docs/stitch/Find-LocalUserStitchDirectory.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-LocalUserStitchDirectory + +## SYNOPSIS +Find the directory in the users home directory that contains stitch configuration items + +## SYNTAX + +``` +Find-LocalUserStitchDirectory [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations to look for the users local stitch directory + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-ParseToken.md b/docs/stitch/Find-ParseToken.md new file mode 100644 index 0000000..69d0031 --- /dev/null +++ b/docs/stitch/Find-ParseToken.md @@ -0,0 +1,89 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-ParseToken + +## SYNOPSIS +Return an array of tokens that match the given pattern + +## SYNTAX + +``` +Find-ParseToken [[-Pattern] ] [[-Type] ] [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Pattern +The token to find, as a regex + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The type of token to look in + +```yaml +Type: PSTokenType +Parameter Sets: (All) +Aliases: +Accepted values: Unknown, Command, CommandParameter, CommandArgument, Number, String, Variable, Member, LoopLabel, Attribute, Type, Operator, GroupStart, GroupEnd, Keyword, Comment, StatementSeparator, NewLine, LineContinuation, Position + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Array +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-StitchConfigurationFile.md b/docs/stitch/Find-StitchConfigurationFile.md new file mode 100644 index 0000000..6f95f65 --- /dev/null +++ b/docs/stitch/Find-StitchConfigurationFile.md @@ -0,0 +1,60 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-StitchConfigurationFile + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Find-StitchConfigurationFile [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Find-TodoItem.md b/docs/stitch/Find-TodoItem.md new file mode 100644 index 0000000..8cbc717 --- /dev/null +++ b/docs/stitch/Find-TodoItem.md @@ -0,0 +1,56 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Find-TodoItem + +## SYNOPSIS +Find all comments in the code base that have the 'TODO' keyword + +## SYNTAX + +``` +Find-TodoItem [[-Path] ] [] +``` + +## DESCRIPTION +Show a list of all "TODO comments" in the code base starting at the directory specified in Path + +## EXAMPLES + +### EXAMPLE 1 +``` +Find-TodoItem $BuildRoot +``` + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Stitch.SourceItem.Todo +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Format-File.md b/docs/stitch/Format-File.md new file mode 100644 index 0000000..a01507e --- /dev/null +++ b/docs/stitch/Format-File.md @@ -0,0 +1,72 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Format-File + +## SYNOPSIS +Run PSSA formatter on the given files + +## SYNTAX + +``` +Format-File [[-Path] ] [[-Settings] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Settings +Path to the code format settings + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: CodeFormatting.psd1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-BuildConfiguration.md b/docs/stitch/Get-BuildConfiguration.md new file mode 100644 index 0000000..ff571cc --- /dev/null +++ b/docs/stitch/Get-BuildConfiguration.md @@ -0,0 +1,150 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-BuildConfiguration + +## SYNOPSIS +Gather information about the project for use in tasks + +## SYNTAX + +``` +Get-BuildConfiguration [[-Path] ] [-ConfigurationFiles ] [-Source ] [-Tests ] + [-Staging ] [-Artifact ] [-Docs ] [] +``` + +## DESCRIPTION +\`Get-BuildConfiguration\` collects information about paths, source items, versions and modules that it finds +in -Path. +Configuration information can be added/updated using configuration files. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-BuildConfiguration . -ConfigurationFiles ./.build/config +gci .build\config | Get-BuildConfiguration . +``` + +## PARAMETERS + +### -Path +Specifies a path to the folder to build the configuration for + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: (Get-Location) +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ConfigurationFiles +Path to the build configuration file + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Source +Default Source directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tests +Default Tests directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Staging +Default Staging directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Artifact +Default Artifact directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Docs +Default Docs directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Collections.Specialized.OrderedDictionary +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-BuildTask.md b/docs/stitch/Get-BuildTask.md new file mode 100644 index 0000000..82a35a6 --- /dev/null +++ b/docs/stitch/Get-BuildTask.md @@ -0,0 +1,60 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-BuildTask + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-BuildTask [[-Name] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-ChangelogConfig.md b/docs/stitch/Get-ChangelogConfig.md new file mode 100644 index 0000000..fae25a3 --- /dev/null +++ b/docs/stitch/Get-ChangelogConfig.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ChangelogConfig + +## SYNOPSIS +Look for a psd1 configuration file in the local folder, the path specified, or the module folder + +## SYNTAX + +``` +Get-ChangelogConfig [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-CurrentEditorFile.md b/docs/stitch/Get-CurrentEditorFile.md new file mode 100644 index 0000000..7041468 --- /dev/null +++ b/docs/stitch/Get-CurrentEditorFile.md @@ -0,0 +1,45 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-CurrentEditorFile + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-CurrentEditorFile [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-FeatureFlag.md b/docs/stitch/Get-FeatureFlag.md new file mode 100644 index 0000000..79f26d2 --- /dev/null +++ b/docs/stitch/Get-FeatureFlag.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-FeatureFlag + +## SYNOPSIS +Retrieve feature flags for the stitch module + +## SYNTAX + +``` +Get-FeatureFlag [[-Name] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +The name of the feature flag to test + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitFile.md b/docs/stitch/Get-GitFile.md new file mode 100644 index 0000000..54f4333 --- /dev/null +++ b/docs/stitch/Get-GitFile.md @@ -0,0 +1,58 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitFile + +## SYNOPSIS +Return a list of the files listed in git status + +## SYNTAX + +``` +Get-GitFile [[-Type] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Type +The type of files to return + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.IO.FileInfo +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitHistory.md b/docs/stitch/Get-GitHistory.md new file mode 100644 index 0000000..ea42fc0 --- /dev/null +++ b/docs/stitch/Get-GitHistory.md @@ -0,0 +1,45 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitHistory + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-GitHistory [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitHubDefaultBranch.md b/docs/stitch/Get-GitHubDefaultBranch.md new file mode 100644 index 0000000..0c9957e --- /dev/null +++ b/docs/stitch/Get-GitHubDefaultBranch.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitHubDefaultBranch + +## SYNOPSIS +Returns the default branch of the given github repository + +## SYNTAX + +``` +Get-GitHubDefaultBranch [[-RepositoryName] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RepositoryName +The repository to find the default brach in + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitMergedBranch.md b/docs/stitch/Get-GitMergedBranch.md new file mode 100644 index 0000000..660b0a4 --- /dev/null +++ b/docs/stitch/Get-GitMergedBranch.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitMergedBranch + +## SYNOPSIS +Return a list of branches that have been merged into the given branch (or default branch if none specified) + +## SYNTAX + +``` +Get-GitMergedBranch [[-FriendlyName] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -FriendlyName +The branch to use for the "base" (the branch the returned branches are merged into) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: (Get-GitHubDefaultBranch) +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitModifiedFile.md b/docs/stitch/Get-GitModifiedFile.md new file mode 100644 index 0000000..6cea965 --- /dev/null +++ b/docs/stitch/Get-GitModifiedFile.md @@ -0,0 +1,42 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitModifiedFile + +## SYNOPSIS +Return a list of the files modified in the current repository + +## SYNTAX + +``` +Get-GitModifiedFile [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitRemoteTrackingBranch.md b/docs/stitch/Get-GitRemoteTrackingBranch.md new file mode 100644 index 0000000..657ca23 --- /dev/null +++ b/docs/stitch/Get-GitRemoteTrackingBranch.md @@ -0,0 +1,42 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitRemoteTrackingBranch + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-GitRemoteTrackingBranch +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitStagedFile.md b/docs/stitch/Get-GitStagedFile.md new file mode 100644 index 0000000..69c0309 --- /dev/null +++ b/docs/stitch/Get-GitStagedFile.md @@ -0,0 +1,42 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitStagedFile + +## SYNOPSIS +Return a list of the files modified in the current repository + +## SYNTAX + +``` +Get-GitStagedFile [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-GitUntrackedFile.md b/docs/stitch/Get-GitUntrackedFile.md new file mode 100644 index 0000000..20947d2 --- /dev/null +++ b/docs/stitch/Get-GitUntrackedFile.md @@ -0,0 +1,42 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-GitUntrackedFile + +## SYNOPSIS +Return a list of the files untracked in the current repository + +## SYNTAX + +``` +Get-GitUntrackedFile [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-ModuleExtension.md b/docs/stitch/Get-ModuleExtension.md new file mode 100644 index 0000000..845cfd3 --- /dev/null +++ b/docs/stitch/Get-ModuleExtension.md @@ -0,0 +1,88 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ModuleExtension + +## SYNOPSIS +Find modules with the \`Extension\` key in the manifest + +## SYNTAX + +``` +Get-ModuleExtension [[-ModuleName] ] [[-ModuleVersion] ] [-ListAvailable] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ModuleName +{{ Fill ModuleName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleVersion +{{ Fill ModuleVersion Description }} + +```yaml +Type: Version +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListAvailable +{{ Fill ListAvailable Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +This function was pulled from the Plaster Source at commit #d048667 + +## RELATED LINKS diff --git a/docs/stitch/Get-ModuleItem.md b/docs/stitch/Get-ModuleItem.md new file mode 100644 index 0000000..ab3b0f4 --- /dev/null +++ b/docs/stitch/Get-ModuleItem.md @@ -0,0 +1,78 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ModuleItem + +## SYNOPSIS +Retrieve the modules in the given path + +## SYNTAX + +``` +Get-ModuleItem [-Path] [-AsHashTable] [] +``` + +## DESCRIPTION +Get-ModuleItem returns an object representing the information about the modules in the directory given in +Path. +It returns information from the manifest such as version number, etc. +as well as SourceItemInfo +objects for all of the source items found in it's subdirectories + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-ModuleItem .\source +``` + +## PARAMETERS + +### -Path +Specifies a path to one or more locations containing Module Source + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AsHashTable +Optionally return a hashtable instead of an object + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Stitch.ModuleItemInfo +## NOTES + +## RELATED LINKS + +[Get-SourceItem]() + diff --git a/docs/stitch/Get-ModulePath.md b/docs/stitch/Get-ModulePath.md new file mode 100644 index 0000000..e086a99 --- /dev/null +++ b/docs/stitch/Get-ModulePath.md @@ -0,0 +1,45 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ModulePath + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-ModulePath [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-ParseToken.md b/docs/stitch/Get-ParseToken.md new file mode 100644 index 0000000..8341e08 --- /dev/null +++ b/docs/stitch/Get-ParseToken.md @@ -0,0 +1,73 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ParseToken + +## SYNOPSIS +Return an array of Tokens from parsing a file + +## SYNTAX + +``` +Get-ParseToken [[-Path] ] [-Type ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Type +The type of token to return + +```yaml +Type: PSTokenType +Parameter Sets: (All) +Aliases: +Accepted values: Unknown, Command, CommandParameter, CommandArgument, Number, String, Variable, Member, LoopLabel, Attribute, Type, Operator, GroupStart, GroupEnd, Keyword, Comment, StatementSeparator, NewLine, LineContinuation, Position + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-ProjectPath.md b/docs/stitch/Get-ProjectPath.md new file mode 100644 index 0000000..ba27473 --- /dev/null +++ b/docs/stitch/Get-ProjectPath.md @@ -0,0 +1,43 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ProjectPath + +## SYNOPSIS +Retrieve the paths to the major project components. +(Source, Tests, Docs, Artifacts, Staging) + +## SYNTAX + +``` +Get-ProjectPath [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-ProjectVersionInfo.md b/docs/stitch/Get-ProjectVersionInfo.md new file mode 100644 index 0000000..c75f800 --- /dev/null +++ b/docs/stitch/Get-ProjectVersionInfo.md @@ -0,0 +1,60 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-ProjectVersionInfo + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-ProjectVersionInfo [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-SourceItem.md b/docs/stitch/Get-SourceItem.md new file mode 100644 index 0000000..f2093e8 --- /dev/null +++ b/docs/stitch/Get-SourceItem.md @@ -0,0 +1,75 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-SourceItem + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SourceItem [[-Path] ] [-TypeMap ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -TypeMap +{{ Fill TypeMap Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-SourceTypeMap.md b/docs/stitch/Get-SourceTypeMap.md new file mode 100644 index 0000000..c6121fd --- /dev/null +++ b/docs/stitch/Get-SourceTypeMap.md @@ -0,0 +1,60 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-SourceTypeMap + +## SYNOPSIS +Retrieve the table that maps source items to the appropriate Visibility and Type + +## SYNTAX + +``` +Get-SourceTypeMap [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to the source type map file. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-SourceItemInfo]() + diff --git a/docs/stitch/Get-StitchTemplate.md b/docs/stitch/Get-StitchTemplate.md new file mode 100644 index 0000000..bef688e --- /dev/null +++ b/docs/stitch/Get-StitchTemplate.md @@ -0,0 +1,75 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-StitchTemplate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-StitchTemplate [[-Type] ] [[-Name] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +{{ Fill Type Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-TaskConfiguration.md b/docs/stitch/Get-TaskConfiguration.md new file mode 100644 index 0000000..903f054 --- /dev/null +++ b/docs/stitch/Get-TaskConfiguration.md @@ -0,0 +1,74 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-TaskConfiguration + +## SYNOPSIS +Get the configuration file for the given task if it exists. +First looks in the local user's stitch +directory, and then the local build configuration directory + +## SYNTAX + +``` +Get-TaskConfiguration [[-Name] ] [[-TaskConfigPath] ] [] +``` + +## DESCRIPTION +Look for the given task's configuration in \`\/config/tasks\` + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +The task object + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -TaskConfigPath +{{ Fill TaskConfigPath Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-TaskHelp.md b/docs/stitch/Get-TaskHelp.md new file mode 100644 index 0000000..4e4c54e --- /dev/null +++ b/docs/stitch/Get-TaskHelp.md @@ -0,0 +1,72 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-TaskHelp + +## SYNOPSIS +Retrieve the comment based help for the given task + +## SYNTAX + +``` +Get-TaskHelp [[-Name] ] [[-InvocationInfo] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +The name of the task to get the help documentation for + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -InvocationInfo +The InvocationInfo of a task + +```yaml +Type: InvocationInfo +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-TestItem.md b/docs/stitch/Get-TestItem.md new file mode 100644 index 0000000..10948bf --- /dev/null +++ b/docs/stitch/Get-TestItem.md @@ -0,0 +1,60 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-TestItem + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-TestItem [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Get-VSCodeSetting.md b/docs/stitch/Get-VSCodeSetting.md new file mode 100644 index 0000000..a302979 --- /dev/null +++ b/docs/stitch/Get-VSCodeSetting.md @@ -0,0 +1,75 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Get-VSCodeSetting + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-VSCodeSetting [[-Name] ] [-Regex] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Regex +{{ Fill Regex Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Initialize-StitchProject.md b/docs/stitch/Initialize-StitchProject.md new file mode 100644 index 0000000..b39377a --- /dev/null +++ b/docs/stitch/Initialize-StitchProject.md @@ -0,0 +1,121 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Initialize-StitchProject + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Initialize-StitchProject [[-Destination] ] [-Force] [-Quiet] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +{{ Fill Destination Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quiet +{{ Fill Quiet Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Invoke-BuildNotification.md b/docs/stitch/Invoke-BuildNotification.md new file mode 100644 index 0000000..d542daf --- /dev/null +++ b/docs/stitch/Invoke-BuildNotification.md @@ -0,0 +1,85 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Invoke-BuildNotification + +## SYNOPSIS +Display a Toast notification for a completed build + +## SYNTAX + +``` +Invoke-BuildNotification [[-Text] ] [[-Status] ] [[-LogFile] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +Invoke-BuildNotification -LogFile .\out\logs\build-20230525T2051223032Z.log -Status Passed +``` + +## PARAMETERS + +### -Text +The text to add to the notification + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Build status + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogFile +Path to the log file + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Invoke-ReplaceToken.md b/docs/stitch/Invoke-ReplaceToken.md new file mode 100644 index 0000000..1615caf --- /dev/null +++ b/docs/stitch/Invoke-ReplaceToken.md @@ -0,0 +1,136 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Invoke-ReplaceToken + +## SYNOPSIS +Replace a given string 'Token' with another string in a given file. + +## SYNTAX + +``` +Invoke-ReplaceToken -In [-Token] [-With] [[-Destination] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -In +File(s) to replace tokens in + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath, Path + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Token +The token to replace, written as a regular-expression + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -With +The value to replace the token with + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Value + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The destination file to write the new content to +If destination is a directory, \`Invoke-ReplaceToken\` will put the content in a file named the same as +the input, but in the given directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Out + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Join-PullRequest.md b/docs/stitch/Join-PullRequest.md new file mode 100644 index 0000000..54ad0eb --- /dev/null +++ b/docs/stitch/Join-PullRequest.md @@ -0,0 +1,98 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Join-PullRequest + +## SYNOPSIS +Merge the current branch's pull request, then pull them into '$DefaultBranch' (usually 'main' or 'master') + +## SYNTAX + +``` +Join-PullRequest [[-RepositoryName] ] [-DontDelete] [[-DefaultBranch] ] [] +``` + +## DESCRIPTION +Ensuring the current branch is up-to-date on the remote, and that it has a pull-request, +this function will then: +1. +Merge the current pull request +1. +Switch to the \`$DefaultBranch\` branch +1. +Pull the latest changes + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RepositoryName +The name of the repository. +Uses the current repository if not specified + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DontDelete +By default the remote and local branches are deleted if successfully merged. +Add -DontDelete to +keep the branches + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultBranch +The default branch. +usually 'main' or 'master' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Measure-File.md b/docs/stitch/Measure-File.md new file mode 100644 index 0000000..f7bbaf0 --- /dev/null +++ b/docs/stitch/Measure-File.md @@ -0,0 +1,87 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Measure-File + +## SYNOPSIS +Run PSSA analyzer on the given files + +## SYNTAX + +``` +Measure-File [[-Path] ] [-Settings ] [-Fix] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Settings +Path to the code format settings + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: PSScriptAnalyzerSettings.psd1 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fix +Optionally apply fixes + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Merge-BuildConfiguration.md b/docs/stitch/Merge-BuildConfiguration.md new file mode 100644 index 0000000..a080cb6 --- /dev/null +++ b/docs/stitch/Merge-BuildConfiguration.md @@ -0,0 +1,90 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Merge-BuildConfiguration + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Merge-BuildConfiguration [-Object] [[-Key] ] [[-Path] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Key +{{ Fill Key Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Object +{{ Fill Object Description }} + +```yaml +Type: PSReference +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Merge-FileCollection.md b/docs/stitch/Merge-FileCollection.md new file mode 100644 index 0000000..e781216 --- /dev/null +++ b/docs/stitch/Merge-FileCollection.md @@ -0,0 +1,86 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Merge-FileCollection + +## SYNOPSIS + +Merge an array of files into an existing collection, overwritting any that have the same basename + +## SYNTAX + +``` +Merge-FileCollection [-Collection] [-UpdateFiles] [] +``` + +## DESCRIPTION + +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 + +``` +$updates | Merge-FileCollection [ref]$allFiles +``` + +### EXAMPLE 2 + +``` +Get-ChildItem -Path . -Filter *.ps1 | Merge-FileCollection [ref]$allScripts +``` + +## PARAMETERS + +### -Collection + +The collection of files to merge the updates into + +```yaml +Type: PSReference +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateFiles + +The additional files to update the collection with + +```yaml +Type: Array +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +The collection is passed in by reference. +This is so that the collection is updated without having to +reapply the result. + +## RELATED LINKS diff --git a/docs/stitch/Merge-SourceItem.md b/docs/stitch/Merge-SourceItem.md new file mode 100644 index 0000000..0cbe7c0 --- /dev/null +++ b/docs/stitch/Merge-SourceItem.md @@ -0,0 +1,90 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Merge-SourceItem + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Merge-SourceItem [-SourceItem ] [[-Path] ] [-AsSection ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AsSection +{{ Fill AsSection Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceItem +{{ Fill SourceItem Description }} + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Object[] + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-FunctionItem.md b/docs/stitch/New-FunctionItem.md new file mode 100644 index 0000000..5ed39e2 --- /dev/null +++ b/docs/stitch/New-FunctionItem.md @@ -0,0 +1,182 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-FunctionItem + +## SYNOPSIS +Create a new function source item in the given module's source folder with the give visibility + +## SYNTAX + +``` +New-FunctionItem [-Name] [-Module] [[-Visibility] ] [-Begin ] + [-Process ] [-End ] [-Component ] [-Force] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +$module | New-FunctionItem Get-FooItem public +``` + +### EXAMPLE 2 +``` +New-FunctionItem Get-FooItem Foo public +``` + +## PARAMETERS + +### -Name +The name of the Function to create + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Module +The name of the module to create the function for + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ModuleName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Visibility +Visibility of the function ('public' for exported commands, 'private' for internal commands) +defaults to 'public' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: Public +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Begin +Code to be added to the begin block of the function + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Process +Code to be added to the process block of the function + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -End +Code to be added to the End block of the function + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Component +Optionally provide a component folder + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite an existing file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the path to the generated file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-SourceComponent.md b/docs/stitch/New-SourceComponent.md new file mode 100644 index 0000000..f3e9e96 --- /dev/null +++ b/docs/stitch/New-SourceComponent.md @@ -0,0 +1,108 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-SourceComponent + +## SYNOPSIS +Add a new Component folder to the module's source + +## SYNTAX + +### public +``` +New-SourceComponent [[-Name] ] [[-Module] ] [-PublicOnly] [] +``` + +### private +``` +New-SourceComponent [[-Name] ] [[-Module] ] [-PrivateOnly] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +The name of the component to add + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Module +The name of the module to add the component to + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PublicOnly +Only add the component to the public functions + +```yaml +Type: SwitchParameter +Parameter Sets: public +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateOnly +Only add the component to the private functions + +```yaml +Type: SwitchParameter +Parameter Sets: private +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-SourceItem.md b/docs/stitch/New-SourceItem.md new file mode 100644 index 0000000..a6e5dfa --- /dev/null +++ b/docs/stitch/New-SourceItem.md @@ -0,0 +1,164 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-SourceItem + +## SYNOPSIS +Create a new source item using templates + +## SYNTAX + +``` +New-SourceItem [[-Type] ] [[-Name] ] [[-Data] ] [-Destination ] [-Force] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +\`New-SourceItem + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Type +The type of file to create + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The file name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Data +The data to pass into the template binding + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Destination +The directory to place the new file in + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite an existing file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the path to the generated file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-StitchBuildProfile.md b/docs/stitch/New-StitchBuildProfile.md new file mode 100644 index 0000000..4d8c243 --- /dev/null +++ b/docs/stitch/New-StitchBuildProfile.md @@ -0,0 +1,90 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-StitchBuildProfile + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-StitchBuildProfile [-Name] [[-ProfileRoot] ] [-Force] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProfileRoot +{{ Fill ProfileRoot Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-StitchBuildRunner.md b/docs/stitch/New-StitchBuildRunner.md new file mode 100644 index 0000000..829cd92 --- /dev/null +++ b/docs/stitch/New-StitchBuildRunner.md @@ -0,0 +1,118 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-StitchBuildRunner + +## SYNOPSIS +Create the main stitch build script + +## SYNTAX + +``` +New-StitchBuildRunner [[-Path] ] [-Name ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +New-StitchBuildRunner $BuildRoot +``` + +Creates the file $BuildRoot\.build.ps1 + +## PARAMETERS + +### -Path +Specifies a path to the folder where the runbook should be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the main build script. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the file if it exists + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-StitchConfigurationFile.md b/docs/stitch/New-StitchConfigurationFile.md new file mode 100644 index 0000000..6bf518a --- /dev/null +++ b/docs/stitch/New-StitchConfigurationFile.md @@ -0,0 +1,119 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-StitchConfigurationFile + +## SYNOPSIS +Create a configuration in the folder specified in Path. + +## SYNTAX + +``` +New-StitchConfigurationFile [[-Path] ] [-Name ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +New-StitchConfigurationFile $BuildRoot\.stitch\profiles\site +``` + +Creates the file $BuildRoot\.stitch\profiles\site\stitch.config.ps1 + +## PARAMETERS + +### -Path +Specifies a path to the folder where the runbook should be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the configuration file. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the file if it exists + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-StitchConfigurationPath.md b/docs/stitch/New-StitchConfigurationPath.md new file mode 100644 index 0000000..8e2828e --- /dev/null +++ b/docs/stitch/New-StitchConfigurationPath.md @@ -0,0 +1,76 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-StitchConfigurationPath + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-StitchConfigurationPath [[-Path] ] [-Name ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: .build, .stitch + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-StitchPathConfigurationFile.md b/docs/stitch/New-StitchPathConfigurationFile.md new file mode 100644 index 0000000..8d7268e --- /dev/null +++ b/docs/stitch/New-StitchPathConfigurationFile.md @@ -0,0 +1,182 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-StitchPathConfigurationFile + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-StitchPathConfigurationFile [[-Source] ] [[-Tests] ] [[-Staging] ] + [[-Artifact] ] [[-Docs] ] [-DontValidate] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Artifact +{{ Fill Artifact Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Docs +{{ Fill Docs Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DontValidate +{{ Fill DontValidate Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +{{ Fill Source Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Staging +{{ Fill Staging Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tests +{{ Fill Tests Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-StitchRunBook.md b/docs/stitch/New-StitchRunBook.md new file mode 100644 index 0000000..a7a1abe --- /dev/null +++ b/docs/stitch/New-StitchRunBook.md @@ -0,0 +1,119 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-StitchRunBook + +## SYNOPSIS +Create a runbook in the folder specified in Path. + +## SYNTAX + +``` +New-StitchRunBook [[-Path] ] [-Name ] [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +New-StitchRunBook $BuildRoot\.stitch\profiles\site +``` + +Creates the file $BuildRoot\.stitch\profiles\site\runbook.ps1 + +## PARAMETERS + +### -Path +Specifies a path to the folder where the runbook should be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the runbook. +Not needed if using profiles + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Overwrite the file if it exists + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/New-TestItem.md b/docs/stitch/New-TestItem.md new file mode 100644 index 0000000..1985012 --- /dev/null +++ b/docs/stitch/New-TestItem.md @@ -0,0 +1,87 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# New-TestItem + +## SYNOPSIS +Create a test item from a source item using the test template + +## SYNTAX + +``` +New-TestItem [[-SourceItem] ] [-Force] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SourceItem +The SourceItemInfo object to create the test from + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Force +Overwrite an existing file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the path to the generated file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Rename-SourceItem.md b/docs/stitch/Rename-SourceItem.md new file mode 100644 index 0000000..f8b675e --- /dev/null +++ b/docs/stitch/Rename-SourceItem.md @@ -0,0 +1,87 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Rename-SourceItem + +## SYNOPSIS +Rename the file and the function, enum or class in the file + +## SYNTAX + +``` +Rename-SourceItem [[-Path] ] [-NewName ] [-PassThru] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -NewName +The New name of the function + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Return the new file object + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Resolve-ProjectName.md b/docs/stitch/Resolve-ProjectName.md new file mode 100644 index 0000000..206ce38 --- /dev/null +++ b/docs/stitch/Resolve-ProjectName.md @@ -0,0 +1,45 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Resolve-ProjectName + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Resolve-ProjectName [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Resolve-ProjectRoot.md b/docs/stitch/Resolve-ProjectRoot.md new file mode 100644 index 0000000..af3ca2d --- /dev/null +++ b/docs/stitch/Resolve-ProjectRoot.md @@ -0,0 +1,167 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Resolve-ProjectRoot + +## SYNOPSIS +Find the root of the current project + +## SYNTAX + +``` +Resolve-ProjectRoot [[-Path] ] [[-Depth] ] [[-Defaults] ] [[-Source] ] + [[-Tests] ] [[-Staging] ] [[-Artifact] ] [[-Docs] ] [] +``` + +## DESCRIPTION +Resolve-ProjectRoot will recurse directories toward the root folder looking for a directory that passes +\`Test-ProjectRoot\`, unless \`$BuildRoot\` is already set + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Optionally set the starting path to search from + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: (Get-Location).ToString() +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Depth +Optionally limit the number of levels to seach + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 8 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Defaults +Powershell Data File with defaults + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Default Source directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: .\source +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tests +Default Tests directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: .\tests +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Staging +Default Staging directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: .\stage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Artifact +Default Artifact directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: .\out +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Docs +Default Docs directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: .\docs +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Test-ProjectRoot]() + diff --git a/docs/stitch/Select-BuildRunBook.md b/docs/stitch/Select-BuildRunBook.md new file mode 100644 index 0000000..f725374 --- /dev/null +++ b/docs/stitch/Select-BuildRunBook.md @@ -0,0 +1,73 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Select-BuildRunBook + +## SYNOPSIS +Locate the runbook for the given BuildProfile + +## SYNTAX + +``` +Select-BuildRunBook [[-Path] ] [[-BuildProfile] ] [] +``` + +## DESCRIPTION +Select-BuildRunBook locates the runbook associated with the BuildProfile. +If no BuildProfile is given, +Select-BuildRunBook will use default names to search for + +## EXAMPLES + +### EXAMPLE 1 +``` +$ProfilePath | Select-BuildRunBook 'default' +$ProfilePath | Select-BuildRunBook 'site' +``` + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -BuildProfile +The build profile to select the runbook for + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Set-ChangelogRelease.md b/docs/stitch/Set-ChangelogRelease.md new file mode 100644 index 0000000..350bccb --- /dev/null +++ b/docs/stitch/Set-ChangelogRelease.md @@ -0,0 +1,135 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Set-ChangelogRelease + +## SYNOPSIS +Create a new release section in the Changelog based on the changes in 'Unreleased' and creates a new blank +'Unreleased' section + +## SYNTAX + +``` +Set-ChangelogRelease [[-Path] ] [[-Release] ] [[-releaseDate] ] [-SkipGitTag] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to the changelog file + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Release +The unreleased section will be moved to this version + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -releaseDate +The date of the release + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipGitTag +Skip checking the current git tag information + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Start-GitBranch.md b/docs/stitch/Start-GitBranch.md new file mode 100644 index 0000000..1efc729 --- /dev/null +++ b/docs/stitch/Start-GitBranch.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Start-GitBranch + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-GitBranch [[-Name] ] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Sync-GitRepository.md b/docs/stitch/Sync-GitRepository.md new file mode 100644 index 0000000..5ae4c67 --- /dev/null +++ b/docs/stitch/Sync-GitRepository.md @@ -0,0 +1,73 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Sync-GitRepository + +## SYNOPSIS +Update the working directory of the current branch + +## SYNTAX + +``` +Sync-GitRepository [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This is equivelant to \`git pull --rebase + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Test-CommentedProperty.md b/docs/stitch/Test-CommentedProperty.md new file mode 100644 index 0000000..5ed32ce --- /dev/null +++ b/docs/stitch/Test-CommentedProperty.md @@ -0,0 +1,70 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-CommentedProperty + +## SYNOPSIS +Test if the given property is commented in the given manifest + +## SYNTAX + +``` +Test-CommentedProperty [-Path ] [[-Property] ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### EXAMPLE 1 +``` +$manifest | Test-CommentedProperty 'ReleaseNotes' +``` + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Property +The item to uncomment + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PropertyName + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Test-FeatureFlag.md b/docs/stitch/Test-FeatureFlag.md new file mode 100644 index 0000000..13f58b9 --- /dev/null +++ b/docs/stitch/Test-FeatureFlag.md @@ -0,0 +1,58 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-FeatureFlag + +## SYNOPSIS +Test if a feature flag is enabled + +## SYNTAX + +``` +Test-FeatureFlag [-Name] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +The name of the feature flag to test + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Test-InInvokeBuild.md b/docs/stitch/Test-InInvokeBuild.md new file mode 100644 index 0000000..b75e1a0 --- /dev/null +++ b/docs/stitch/Test-InInvokeBuild.md @@ -0,0 +1,45 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-InInvokeBuild + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-InInvokeBuild [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Test-PathIsIn.md b/docs/stitch/Test-PathIsIn.md new file mode 100644 index 0000000..f5b2392 --- /dev/null +++ b/docs/stitch/Test-PathIsIn.md @@ -0,0 +1,91 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-PathIsIn + +## SYNOPSIS +Confirm if the given path is within the other + +## SYNTAX + +``` +Test-PathIsIn -Path [[-Parent] ] [-CaseSensitive] [] +``` + +## DESCRIPTION +\`Test-PathIsIn\` checks if the given path (-Path) is a subdirectory of the other (-Parent) + +## EXAMPLES + +### EXAMPLE 1 +``` +Test-PathIsIn "C:\Windows" -Path "C:\Windows\System32\" +``` + +### EXAMPLE 2 +``` +"C:\Windows\System32" | Test-PathIsIn "C:\Windows" +``` + +## PARAMETERS + +### -Path +The path to test (the subdirectory) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Parent +The path to test (the subdirectory) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CaseSensitive +Compare paths using case sensitivity + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Test-ProjectPath.md b/docs/stitch/Test-ProjectPath.md new file mode 100644 index 0000000..2bad13e --- /dev/null +++ b/docs/stitch/Test-ProjectPath.md @@ -0,0 +1,45 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-ProjectPath + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-ProjectPath [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Test-ProjectRoot.md b/docs/stitch/Test-ProjectRoot.md new file mode 100644 index 0000000..adc299a --- /dev/null +++ b/docs/stitch/Test-ProjectRoot.md @@ -0,0 +1,167 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-ProjectRoot + +## SYNOPSIS +Test if the given directory is the root directory of a project + +## SYNTAX + +``` +Test-ProjectRoot [[-Path] ] [[-Defaults] ] [[-Source] ] [[-Tests] ] + [[-Staging] ] [[-Artifact] ] [[-Docs] ] [] +``` + +## DESCRIPTION +\`Test-ProjectRoot\` looks for "typical" project directories in the given -Path and returns true if at least +two of them exist. + +Typical project directories are: +- A source directory (this may be controlled by the variable $Source) +- A staging directory (the variable $Staging) +- A tests directory (the variable $Tests) +- A artifact/output directory (the variable $Artifact) +- A documentation directory (the variable $Docs) + +## EXAMPLES + +### EXAMPLE 1 +``` +Test-ProjectRoot +``` + +Without a -Path, tests the current directory for default project directories + +### EXAMPLE 2 +``` +$projectPath | Test-ProjectRoot +``` + +## PARAMETERS + +### -Path +Optionally give a path to start in + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: (Get-Location).ToString() +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Defaults +Powershell Data File with defaults + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Default Source directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: .\source +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tests +Default Tests directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: .\tests +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Staging +Default Staging directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: .\stage +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Artifact +Default Artifact directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: .\out +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Docs +Default Docs directory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: .\docs +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES +Defaults are: +- Source : .\source +- Staging : .\stage +- Tests : .\tests +- Artifact : .\out +- Docs : .\docs + +## RELATED LINKS diff --git a/docs/stitch/Test-WindowsLineEnding.md b/docs/stitch/Test-WindowsLineEnding.md new file mode 100644 index 0000000..77d81e2 --- /dev/null +++ b/docs/stitch/Test-WindowsLineEnding.md @@ -0,0 +1,57 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Test-WindowsLineEnding + +## SYNOPSIS +Test for "Windows Line Endings" (CRLF) in the given file + +## SYNTAX + +``` +Test-WindowsLineEnding [[-Path] ] [] +``` + +## DESCRIPTION +\`Test-WindowsLineEnding\` returns true if the file contains CRLF endings, and false if not + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Specifies a path to one or more locations. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Undo-GitCommit.md b/docs/stitch/Undo-GitCommit.md new file mode 100644 index 0000000..78f858f --- /dev/null +++ b/docs/stitch/Undo-GitCommit.md @@ -0,0 +1,80 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Undo-GitCommit + +## SYNOPSIS +Reset the branch to before the previous commit + +## SYNTAX + +### Hard +``` +Undo-GitCommit [-Hard] [] +``` + +### Soft +``` +Undo-GitCommit [-Soft] [] +``` + +## DESCRIPTION +There are three types of reset: +but keep all the changes in the working directory +Without This is equivelant to \`git reset HEAD~1 --mixed + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Hard +Hard reset + +```yaml +Type: SwitchParameter +Parameter Sets: Hard +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Soft +Soft reset + +```yaml +Type: SwitchParameter +Parameter Sets: Soft +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Update-GitRepository.md b/docs/stitch/Update-GitRepository.md new file mode 100644 index 0000000..0e05f53 --- /dev/null +++ b/docs/stitch/Update-GitRepository.md @@ -0,0 +1,73 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Update-GitRepository + +## SYNOPSIS +Update the working directory of the current branch + +## SYNTAX + +``` +Update-GitRepository [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This is equivelant to \`git pull --rebase + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Update-ManifestField.md b/docs/stitch/Update-ManifestField.md new file mode 100644 index 0000000..375ca5d --- /dev/null +++ b/docs/stitch/Update-ManifestField.md @@ -0,0 +1,90 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Update-ManifestField + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Update-ManifestField [[-Path] ] [-PropertyName] [-Value] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +{{ Fill Path Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: PSPath + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -PropertyName +{{ Fill PropertyName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +{{ Fill Value Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/Write-StitchLogo.md b/docs/stitch/Write-StitchLogo.md new file mode 100644 index 0000000..aa3b0b9 --- /dev/null +++ b/docs/stitch/Write-StitchLogo.md @@ -0,0 +1,76 @@ +--- +external help file: stitch-help.xml +Module Name: stitch +online version: +schema: 2.0.0 +--- + +# Write-StitchLogo + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Write-StitchLogo [[-Size] ] [-NoColor] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -NoColor +{{ Fill NoColor Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +{{ Fill Size Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: small, large + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/stitch/stitch.md b/docs/stitch/stitch.md new file mode 100644 index 0000000..d673f4d --- /dev/null +++ b/docs/stitch/stitch.md @@ -0,0 +1,268 @@ +--- +Module Name: stitch +Module Guid: de471cc1-be4b-48e7-a033-6a1f16d7fae8 +Download Help Link: {{ Update Download Link }} +Help Version: {{ Please enter version of help manually (X.X.X.X) format }} +Locale: en-US +--- + +# stitch Module +## Description +{{ Fill in the Description }} + +## stitch Cmdlets +### [Add-ChangelogEntry](Add-ChangelogEntry.md) +{{ Fill in the Description }} + +### [Add-GitFile](Add-GitFile.md) +{{ Fill in the Description }} + +### [Checkpoint-GitWorkingDirectory](Checkpoint-GitWorkingDirectory.md) +{{ Fill in the Description }} + +### [Clear-MergedGitBranch](Clear-MergedGitBranch.md) +{{ Fill in the Description }} + +### [Confirm-Path](Confirm-Path.md) +{{ Fill in the Description }} + +### [Convert-ConfigurationFile](Convert-ConfigurationFile.md) +{{ Fill in the Description }} + +### [Convert-LineEnding](Convert-LineEnding.md) +{{ Fill in the Description }} + +### [ConvertFrom-Changelog](ConvertFrom-Changelog.md) +{{ Fill in the Description }} + +### [ConvertFrom-CommentedProperty](ConvertFrom-CommentedProperty.md) +{{ Fill in the Description }} + +### [ConvertFrom-ConventionalCommit](ConvertFrom-ConventionalCommit.md) +{{ Fill in the Description }} + +### [ConvertTo-Changelog](ConvertTo-Changelog.md) +{{ Fill in the Description }} + +### [Export-ReleaseNotes](Export-ReleaseNotes.md) +{{ Fill in the Description }} + +### [Find-BuildConfigurationDirectory](Find-BuildConfigurationDirectory.md) +{{ Fill in the Description }} + +### [Find-BuildConfigurationRootDirectory](Find-BuildConfigurationRootDirectory.md) +{{ Fill in the Description }} + +### [Find-BuildProfileRootDirectory](Find-BuildProfileRootDirectory.md) +{{ Fill in the Description }} + +### [Find-BuildRunBook](Find-BuildRunBook.md) +{{ Fill in the Description }} + +### [Find-InvokeBuildScript](Find-InvokeBuildScript.md) +{{ Fill in the Description }} + +### [Find-InvokeBuildTaskFile](Find-InvokeBuildTaskFile.md) +{{ Fill in the Description }} + +### [Find-LocalUserStitchDirectory](Find-LocalUserStitchDirectory.md) +{{ Fill in the Description }} + +### [Find-ParseToken](Find-ParseToken.md) +{{ Fill in the Description }} + +### [Find-StitchConfigurationFile](Find-StitchConfigurationFile.md) +{{ Fill in the Description }} + +### [Find-TodoItem](Find-TodoItem.md) +{{ Fill in the Description }} + +### [Format-File](Format-File.md) +{{ Fill in the Description }} + +### [Get-BuildConfiguration](Get-BuildConfiguration.md) +{{ Fill in the Description }} + +### [Get-BuildTask](Get-BuildTask.md) +{{ Fill in the Description }} + +### [Get-ChangelogConfig](Get-ChangelogConfig.md) +{{ Fill in the Description }} + +### [Get-CurrentEditorFile](Get-CurrentEditorFile.md) +{{ Fill in the Description }} + +### [Get-FeatureFlag](Get-FeatureFlag.md) +{{ Fill in the Description }} + +### [Get-GitFile](Get-GitFile.md) +{{ Fill in the Description }} + +### [Get-GitHistory](Get-GitHistory.md) +{{ Fill in the Description }} + +### [Get-GitHubDefaultBranch](Get-GitHubDefaultBranch.md) +{{ Fill in the Description }} + +### [Get-GitMergedBranch](Get-GitMergedBranch.md) +{{ Fill in the Description }} + +### [Get-GitModifiedFile](Get-GitModifiedFile.md) +{{ Fill in the Description }} + +### [Get-GitRemoteTrackingBranch](Get-GitRemoteTrackingBranch.md) +{{ Fill in the Description }} + +### [Get-GitStagedFile](Get-GitStagedFile.md) +{{ Fill in the Description }} + +### [Get-GitUntrackedFile](Get-GitUntrackedFile.md) +{{ Fill in the Description }} + +### [Get-ModuleExtension](Get-ModuleExtension.md) +{{ Fill in the Description }} + +### [Get-ModuleItem](Get-ModuleItem.md) +{{ Fill in the Description }} + +### [Get-ModulePath](Get-ModulePath.md) +{{ Fill in the Description }} + +### [Get-ParseToken](Get-ParseToken.md) +{{ Fill in the Description }} + +### [Get-ProjectPath](Get-ProjectPath.md) +{{ Fill in the Description }} + +### [Get-ProjectVersionInfo](Get-ProjectVersionInfo.md) +{{ Fill in the Description }} + +### [Get-SourceItem](Get-SourceItem.md) +{{ Fill in the Description }} + +### [Get-SourceTypeMap](Get-SourceTypeMap.md) +{{ Fill in the Description }} + +### [Get-StitchTemplate](Get-StitchTemplate.md) +{{ Fill in the Description }} + +### [Get-TaskConfiguration](Get-TaskConfiguration.md) +{{ Fill in the Description }} + +### [Get-TaskHelp](Get-TaskHelp.md) +{{ Fill in the Description }} + +### [Get-TestItem](Get-TestItem.md) +{{ Fill in the Description }} + +### [Get-VSCodeSetting](Get-VSCodeSetting.md) +{{ Fill in the Description }} + +### [Initialize-StitchProject](Initialize-StitchProject.md) +{{ Fill in the Description }} + +### [Invoke-BuildNotification](Invoke-BuildNotification.md) +{{ Fill in the Description }} + +### [Invoke-ReplaceToken](Invoke-ReplaceToken.md) +{{ Fill in the Description }} + +### [Join-PullRequest](Join-PullRequest.md) +{{ Fill in the Description }} + +### [Measure-File](Measure-File.md) +{{ Fill in the Description }} + +### [Merge-BuildConfiguration](Merge-BuildConfiguration.md) +{{ Fill in the Description }} + +### [Merge-FileCollection](Merge-FileCollection.md) +{{ Fill in the Description }} + +### [Merge-SourceItem](Merge-SourceItem.md) +{{ Fill in the Description }} + +### [New-FunctionItem](New-FunctionItem.md) +{{ Fill in the Description }} + +### [New-SourceComponent](New-SourceComponent.md) +{{ Fill in the Description }} + +### [New-SourceItem](New-SourceItem.md) +{{ Fill in the Description }} + +### [New-StitchBuildProfile](New-StitchBuildProfile.md) +{{ Fill in the Description }} + +### [New-StitchBuildRunner](New-StitchBuildRunner.md) +{{ Fill in the Description }} + +### [New-StitchConfigurationFile](New-StitchConfigurationFile.md) +{{ Fill in the Description }} + +### [New-StitchConfigurationPath](New-StitchConfigurationPath.md) +{{ Fill in the Description }} + +### [New-StitchPathConfigurationFile](New-StitchPathConfigurationFile.md) +{{ Fill in the Description }} + +### [New-StitchRunBook](New-StitchRunBook.md) +{{ Fill in the Description }} + +### [New-TestItem](New-TestItem.md) +{{ Fill in the Description }} + +### [Rename-SourceItem](Rename-SourceItem.md) +{{ Fill in the Description }} + +### [Resolve-ProjectName](Resolve-ProjectName.md) +{{ Fill in the Description }} + +### [Resolve-ProjectRoot](Resolve-ProjectRoot.md) +{{ Fill in the Description }} + +### [Select-BuildRunBook](Select-BuildRunBook.md) +{{ Fill in the Description }} + +### [Set-ChangelogRelease](Set-ChangelogRelease.md) +{{ Fill in the Description }} + +### [Start-GitBranch](Start-GitBranch.md) +{{ Fill in the Description }} + +### [Sync-GitRepository](Sync-GitRepository.md) +{{ Fill in the Description }} + +### [Test-CommentedProperty](Test-CommentedProperty.md) +{{ Fill in the Description }} + +### [Test-FeatureFlag](Test-FeatureFlag.md) +{{ Fill in the Description }} + +### [Test-InInvokeBuild](Test-InInvokeBuild.md) +{{ Fill in the Description }} + +### [Test-PathIsIn](Test-PathIsIn.md) +{{ Fill in the Description }} + +### [Test-ProjectPath](Test-ProjectPath.md) +{{ Fill in the Description }} + +### [Test-ProjectRoot](Test-ProjectRoot.md) +{{ Fill in the Description }} + +### [Test-WindowsLineEnding](Test-WindowsLineEnding.md) +{{ Fill in the Description }} + +### [Undo-GitCommit](Undo-GitCommit.md) +{{ Fill in the Description }} + +### [Update-GitRepository](Update-GitRepository.md) +{{ Fill in the Description }} + +### [Update-ManifestField](Update-ManifestField.md) +{{ Fill in the Description }} + +### [Write-StitchLogo](Write-StitchLogo.md) +{{ Fill in the Description }} + From 9da095203498cd4d3c23856d315978d679a15e76 Mon Sep 17 00:00:00 2001 From: Timothy Aldrich Date: Fri, 13 Oct 2023 18:34:37 -0400 Subject: [PATCH 2/3] WIP on "cleaning" help after platyps --- .../Help/Convert-HelpToExternalFile.ps1 | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 source/stitch/public/Help/Convert-HelpToExternalFile.ps1 diff --git a/source/stitch/public/Help/Convert-HelpToExternalFile.ps1 b/source/stitch/public/Help/Convert-HelpToExternalFile.ps1 new file mode 100644 index 0000000..3c09618 --- /dev/null +++ b/source/stitch/public/Help/Convert-HelpToExternalFile.ps1 @@ -0,0 +1,43 @@ + +function Convert-HelpToExternalFile { + <# + .SYNOPSIS + Remove the Comment-based help section from the file and replace with a .EXTERNALHELPFILE line + #> + [CmdletBinding()] + param( + # Specifies a path to one or more files with a function defined. + [Parameter( + Position = 0, + ValueFromPipeline, + ValueFromPipelineByPropertyName + )] + [Alias('PSPath')] + [string[]]$Path, + + # The name of the external file + [Parameter( + )] + [string]$HelpFile + + ) + begin { + Write-Debug "`n$('-' * 80)`n-- Begin $($MyInvocation.MyCommand.Name)`n$('-' * 80)" + $keywords = @('.SYNOPSIS', '.DESCRIPTION', '.EXAMPLE', '.NOTES') + } + process { + foreach ($file in $Path) { + if ($file | Test-Path) { + try { + #TODO: Get the tokens of the file, replace the help comment token + } + catch { + $PSCmdlet.ThrowTerminatingError($_) + } + } + } + } + end { + Write-Debug "`n$('-' * 80)`n-- End $($MyInvocation.MyCommand.Name)`n$('-' * 80)" + } +} From 8fba229a86d7dad7c51fb56c815d20bb6957f936 Mon Sep 17 00:00:00 2001 From: Timothy Aldrich Date: Wed, 8 Nov 2023 15:58:29 -0500 Subject: [PATCH 3/3] feat: Added tasks for formatting platyps docs --- .build/profiles/docs/runbook.ps1 | 7 +- .../tasks/add.component.heading.build.ps1 | 59 ++++ .../docs/tasks/add.task.config.build.ps1 | 88 ++++++ .../tasks/convert.codeblocks.pwsh.build.ps1 | 18 ++ .../docs/tasks/format.common.params.build.ps1 | 11 + .../docs/tasks/invoke.markdownlint.build.ps1 | 35 +++ .../docs/tasks/set.external.help.build.ps1 | 47 +++ .markdownlint.json | 291 ++++++++++++++++++ 8 files changed, 554 insertions(+), 2 deletions(-) create mode 100644 .build/profiles/docs/tasks/add.component.heading.build.ps1 create mode 100644 .build/profiles/docs/tasks/add.task.config.build.ps1 create mode 100644 .build/profiles/docs/tasks/convert.codeblocks.pwsh.build.ps1 create mode 100644 .build/profiles/docs/tasks/format.common.params.build.ps1 create mode 100644 .build/profiles/docs/tasks/invoke.markdownlint.build.ps1 create mode 100644 .build/profiles/docs/tasks/set.external.help.build.ps1 create mode 100644 .markdownlint.json diff --git a/.build/profiles/docs/runbook.ps1 b/.build/profiles/docs/runbook.ps1 index c84a004..1eb2136 100644 --- a/.build/profiles/docs/runbook.ps1 +++ b/.build/profiles/docs/runbook.ps1 @@ -2,6 +2,9 @@ Use this file to manage the phases and tasks. #> -Build | jobs @( - +'Build' | jobs @( + 'convert.codeblocks.pwsh', + 'format.common.params', + 'add.component.heading', + 'invoke.markdownlint' ) diff --git a/.build/profiles/docs/tasks/add.component.heading.build.ps1 b/.build/profiles/docs/tasks/add.component.heading.build.ps1 new file mode 100644 index 0000000..77c1ba3 --- /dev/null +++ b/.build/profiles/docs/tasks/add.component.heading.build.ps1 @@ -0,0 +1,59 @@ + +param( + +) + +#Synopsis: Add a COMPONENT header to the markdown file +task add.component.heading { + Import-Module 'C:\Users\TAldrich\projects\github\PSMarkdig\source\PSMarkdig' -Force + $componentMap = @{} + $BuildInfo | Foreach-Module { + $config = $_ + $config.SourceInfo + | Where-Object Type -Like 'function' + | ForEach-Object { + if (-not ([string]::IsNullorEmpty($_.Component))) { + $componentMap.Add($_.Name, $_.Component) + } + } + } + + foreach ($mdDoc in (Get-ChildItem -Path .\docs -Filter '*.md' -Recurse)) { + # Check to see if Component heading already exists first + $componentHeading = "`r`n## COMPONENT`r`n" | PSMarkdig\New-MarkdownElement + + logDebug "Markdown file $($mdDoc.BaseName)" + + if ($componentMap.ContainsKey( $mdDoc.BaseName )) { + $componentName = $componentMap[$mdDoc.BaseName] + $componentText = "`r`n$componentName`r`n" | PSMarkdig\New-MarkdownElement + + $doc = PSMarkdig\Import-Markdown $mdDoc + + logDebug "- Adding Component $componentName" + + if ($null -ne $doc) { + logDebug "- Imported markdown. $($doc.Count) elements" + + $headings = PSMarkdig\Get-MarkdownHeading $doc + if ($null -ne $headings) { + logDebug " - There are $($headings.Count) headings" + $lastHeading = $headings | Select-Object -Last 1 + } + + try { + logDebug "- Adding $($componentHeading.GetType().FullName) to doc" + + PSMarkdig\Add-MarkdownElement -Element $componentHeading -Document $doc -Before $lastHeading + logDebug "- Adding $($componentText.GetType().FullName) to doc" + PSMarkdig\Add-MarkdownElement -Element $componentText -Document $doc -Before $lastHeading + + PSMarkdig\Write-MarkdownElement $doc | Set-Content $mdDoc -NoNewline + } catch { + $PSCmdlet.ThrowTerminatingError($_) + } + Remove-Variable componentHeading, componentText, doc + } + } + } +} diff --git a/.build/profiles/docs/tasks/add.task.config.build.ps1 b/.build/profiles/docs/tasks/add.task.config.build.ps1 new file mode 100644 index 0000000..93700dd --- /dev/null +++ b/.build/profiles/docs/tasks/add.task.config.build.ps1 @@ -0,0 +1,88 @@ + +#Synopsis: Create task config files from the source +task add.task.config { + logDebug "CopyAdditional: ($($CopyAdditionalItems | ConvertTo-Psd))" + Import-Module '.\tools\BuildProperties.psm1' + + $taskConfigDir = '.\.build\profiles\default\config\tasks' + $scriptPropertyMap = Get-BuildScriptProperty + + $propertyData = Get-ParameterData + #TODO: To make this task idempotent, the additon should skip if the field and value already exist + + foreach ($map in $scriptPropertyMap.GetEnumerator()) { + $name = $map.Name + logDebug "Property: $name" + try { + $currentValue = Get-BuildProperty $name + } catch { + $currentValue = (Get-Variable $name -ValueOnly) + } + logDebug "Value: $($currentValue | ConvertTo-Psd)" + $commentText = ( + ($propertyData + | Where-Object Name -Like $name + | Select-Object -Expand Help + ) -join "`n") + + $instances = $map.Value + :file foreach ($instance in $instances) { + $taskConfigFile = $instance.File -replace 'build\.ps1', 'config.psd1' + logDebug "- Task configuration file: $taskConfigFile" + $taskConfigPath = (Join-Path $taskConfigDir $taskConfigFile) + + if (Test-Path $taskConfigPath) { + logDebug " - already exists" + $currentContent = Import-Psd $taskConfigPath + if ($currentContent.ContainsKey($name)) { + logDebug " - already has a $name key" + if ($currentContent['$name'] -eq $currentValue) { + logDebug " - and content matches" + continue file + } else { + logDebug " - but content doesn't match" + $xml = Import-PsdXml -Path $taskConfigPath + Set-Psd -Xml $xml -Value $currentValue -XPath (-join ('//Data/Table/Item[@Key="', $name, '"]')) + Export-PsdXml -Path $taskConfigPath -Xml $xml + continue file + } + } else { + logDebug " - does not have a $name key" + $xml = Import-PsdXml -Path $taskConfigPath + $table = $xml.Data.Table + $newLine = $xml.CreateElement('NewLine') + $comment = $xml.CreateElement('Comment') + [void]$table.AppendChild($newLine) + [void]$table.AppendChild($comment) + [void]$table.AppendChild($newLine) + $currentValueData = $currentValue | ConvertTo-Psd | Convert-PsdToXml + $newItem = $xml.CreateElement('Item') + [void]$newItem.SetAttribute('Key', $name) + $newItem.InnerXml = $currentValueData + + Export-PsdXml -Path $taskConfigPath -Xml $xml + } + } else { + logDebug " - does not exist" + $data = @{ + $name = $currentValue + } + + $data | ConvertTo-Psd | Set-Content $taskConfigPath + $xml = Import-PsdXml -Path $taskConfigPath + $newLine = $xml.CreateElement('NewLine') + $comment = $xml.CreateElement('Comment') + $comment.InnerText = (-join ( + '<# ', + $commentText, + ' #>')) + $table = $xml.Data.Table + [void]$table.PrependChild($newLine) + [void]$table.PrependChild($comment) + [void]$table.PrependChild($newLine) + Export-PsdXml -Path $taskConfigPath -Xml $xml + } + $taskConfigPath | Convert-LineEnding -LF + } + } +} diff --git a/.build/profiles/docs/tasks/convert.codeblocks.pwsh.build.ps1 b/.build/profiles/docs/tasks/convert.codeblocks.pwsh.build.ps1 new file mode 100644 index 0000000..3d2a121 --- /dev/null +++ b/.build/profiles/docs/tasks/convert.codeblocks.pwsh.build.ps1 @@ -0,0 +1,18 @@ + +#SYNOPSIS: PlatyPS does not add 'powershell' to the fenced code blocks. This task does. +task convert.codeblocks.pwsh { + foreach ($mdDoc in (Get-ChildItem -Path .\docs -Filter "*.md" -Recurse)) { + $doc = Import-Markdown $mdDoc.FullName + $blocks = $doc | Where-Object { + $_.GetType().FullName -like 'Markdig.Syntax.FencedCodeBlock' + } + foreach ($block in $blocks) { + if ([string]::IsNullOrEmpty($block.UnescapedInfo)) { + $block.Info = 'powershell' + $block.UnescapedInfo = 'powershell' + } + } + logInfo "Setting codeblocks to powershell in $($mdDoc.Name)" + $doc | Write-MarkdownElement | Set-Content $mdDoc.FullName -NoNewline + } +} diff --git a/.build/profiles/docs/tasks/format.common.params.build.ps1 b/.build/profiles/docs/tasks/format.common.params.build.ps1 new file mode 100644 index 0000000..c7a4156 --- /dev/null +++ b/.build/profiles/docs/tasks/format.common.params.build.ps1 @@ -0,0 +1,11 @@ + +# Synopsis: Remove the list of common parameters from the documentation +task format.common.params { + $replacementText = "This cmdlet supports the common parameters.`nFor more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216)." + foreach ($mdDoc in (Get-ChildItem -Path .\docs -Filter '*.md' -Recurse)) { + logInfo "Replacing Common Parameters extra info in $($mdDoc.Name)" + (get-content $mdDoc -Raw ) -replace [regex]::Escape( + 'This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).' + ) , $replacementText | Set-Content $mdDoc -NoNewline + } +} diff --git a/.build/profiles/docs/tasks/invoke.markdownlint.build.ps1 b/.build/profiles/docs/tasks/invoke.markdownlint.build.ps1 new file mode 100644 index 0000000..14fb93d --- /dev/null +++ b/.build/profiles/docs/tasks/invoke.markdownlint.build.ps1 @@ -0,0 +1,35 @@ + +# Synopsis: Format documentation with markdownlint +task invoke.markdownlint { + $tempFile = [System.IO.Path]::GetTempFileName() + $basedir = "$env:APPDATA\npm" + $node = 'node.exe' + $mdLintPath = "$basedir/node_modules/markdownlint-cli/markdownlint.js" + + if (Test-Path $mdLintPath) { + + [string[]]$argList = @() + + $argList += $mdLintPath + $argList += '.\docs\stitch' + $argList += '--fix' + $argList += '--output' + $argList += $tempFile + $argList += '--json' + $argList += '--quiet' + logInfo "Calling markdownlint" + & $node $argList + + $lintErrors = Get-Content $tempFile | ConvertFrom-Json + if ($lintErrors.Count -gt 0) { + foreach ($lintError in $lintErrors) { + '{0}:{1} - {2}' -f $lintError.fileName , $lintError.lineNumber, $lineError.ruleDescription + } + } + Remove-Item $tempFile + + logInfo "Markdown Errors: $($lintErrors.Count)" + } else { + throw "Markdownlint is not installed. Run npm install -g markdownlint-cli" + } +} diff --git a/.build/profiles/docs/tasks/set.external.help.build.ps1 b/.build/profiles/docs/tasks/set.external.help.build.ps1 new file mode 100644 index 0000000..e03994d --- /dev/null +++ b/.build/profiles/docs/tasks/set.external.help.build.ps1 @@ -0,0 +1,47 @@ + +#SYNOPSIS: Remove the Comment-based help in the given file and replace it with `.EXTERNALHELPFILE +task set.external.help { + $BuildInfo | Foreach-Module { + $config = $_ + $externalHelpText = @" + <# + .EXTERNALHELPFILE $($config.Name)-help.xml + #> +"@ + $functions = $config.SourceInfo | Where-Object Type -Like 'function' + foreach ($source in $functions) { + if ($null -ne $env:TestExternalHelp) { + if ($source.Name -notlike $env:TestExternalHelp) { + continue + } else { + logInfo "TestExternalHelp is set to $env:TestExternalHelp" + logInfo "processing File" + } + } + if ($source.Tokens.Count -gt 0) { + $commentBasedHelp = $source.Tokens | Where-Object { + ($_.Kind -like 'Comment' ) -and + ($_.Extent.Text -match '\.SYNOPSIS' ) + } + } + if ($null -ne $commentBasedHelp) { + logInfo "$($source.Name) has comment-based help" + #! in Get-SourceItemInfo ToString is overloaded to output the content of the file + $content = $source.ToString() + $start = ($commentBasedHelp.Extent.StartOffSet - 1) + $end = ($commentBasedHelp.Extent.EndOffset + 1) + + logInfo "help starts at $start and ends at $end" + logInfo "Help Content:`n$(-join ($content[$start..$end]))" + + # Now we "splice" the content + logInfo "Splicing content" + $preComment = (-join ($content[0..$start])) + $postComment = (-join ($content[$end..-1])) + + $preComment, $externalHelpText, $postComment | Set-Content $source.Path + + } + } + } +} diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..05aa9a1 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,291 @@ +// code: language=jsonc + +{ + // Default state for all rules + "default": true, + + // Path to configuration file to extend + "extends": null, + + // MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time + "MD001": true, + + // MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading + "MD002": { + // Heading level + "level": 1 + }, + + // MD003/heading-style/header-style - Heading style + "MD003": { + // Heading style + "style": "consistent" + }, + + // MD004/ul-style - Unordered list style + "MD004": { + // List style + "style": "consistent" + }, + + // MD005/list-indent - Inconsistent indentation for list items at the same level + "MD005": true, + + // MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line + "MD006": true, + + // MD007/ul-indent - Unordered list indentation + "MD007": { + // Spaces for indent + "indent": 2, + // Whether to indent the first level of the list + "start_indented": false, + // Spaces for first level indent (when start_indented is set) + "start_indent": 2 + }, + + // MD009/no-trailing-spaces - Trailing spaces + "MD009": { + // Spaces for line break + "br_spaces": 2, + // Allow spaces for empty lines in list items + "list_item_empty_lines": false, + // Include unnecessary breaks + "strict": false + }, + + // MD010/no-hard-tabs - Hard tabs + "MD010": { + // Include code blocks + "code_blocks": true, + // Fenced code languages to ignore + "ignore_code_languages": [], + // Number of spaces for each hard tab + "spaces_per_tab": 4 + }, + + // MD011/no-reversed-links - Reversed link syntax + "MD011": true, + + // MD012/no-multiple-blanks - Multiple consecutive blank lines + "MD012": { + // Consecutive blank lines + "maximum": 1 + }, + + // MD013/line-length - Line length + "MD013": { + // Number of characters + "line_length": 200, + // Number of characters for headings + "heading_line_length": 200, + // Number of characters for code blocks + "code_block_line_length": 200, + // Include code blocks + "code_blocks": true, + // Include tables + "tables": true, + // Include headings + "headings": true, + // Include headings + "headers": true, + // Strict length checking + "strict": false, + // Stern length checking + "stern": false + }, + + // MD014/commands-show-output - Dollar signs used before commands without showing output + "MD014": true, + + // MD018/no-missing-space-atx - No space after hash on atx style heading + "MD018": true, + + // MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading + "MD019": true, + + // MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading + "MD020": true, + + // MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading + "MD021": true, + + // MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines + "MD022": { + // Blank lines above heading + "lines_above": 1, + // Blank lines below heading + "lines_below": 1 + }, + + // MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line + "MD023": true, + + // MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content + "MD024": { + // Only check sibling headings + "allow_different_nesting": true, + // Only check sibling headings + "siblings_only": true + }, + + // MD025/single-title/single-h1 - Multiple top-level headings in the same document + "MD025": { + // Heading level + "level": 1, + // RegExp for matching title in front matter + "front_matter_title": "^\\s*title\\s*[:=]" + }, + + // MD026/no-trailing-punctuation - Trailing punctuation in heading + "MD026": { + // Punctuation characters not allowed at end of headings + "punctuation": ".,;:!。，；：！" + }, + + // MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol + "MD027": true, + + // MD028/no-blanks-blockquote - Blank line inside blockquote + "MD028": true, + + // MD029/ol-prefix - Ordered list item prefix + "MD029": { + // List style + "style": "one_or_ordered" + }, + + // MD030/list-marker-space - Spaces after list markers + "MD030": { + // Spaces for single-line unordered list items + "ul_single": 1, + // Spaces for single-line ordered list items + "ol_single": 1, + // Spaces for multi-line unordered list items + "ul_multi": 1, + // Spaces for multi-line ordered list items + "ol_multi": 1 + }, + + // MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines + "MD031": { + // Include list items + "list_items": false + }, + + // MD032/blanks-around-lists - Lists should be surrounded by blank lines + "MD032": false, + + // MD033/no-inline-html - Inline HTML + "MD033": { + // Allowed elements + "allowed_elements": [] + }, + + // MD034/no-bare-urls - Bare URL used + "MD034": true, + + // MD035/hr-style - Horizontal rule style + "MD035": { + // Horizontal rule style + "style": "consistent" + }, + + // MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading + "MD036": { + // Punctuation characters + "punctuation": ".,;:!?。，；：！？" + }, + + // MD037/no-space-in-emphasis - Spaces inside emphasis markers + "MD037": true, + + // MD038/no-space-in-code - Spaces inside code span elements + "MD038": true, + + // MD039/no-space-in-links - Spaces inside link text + "MD039": true, + + // MD040/fenced-code-language - Fenced code blocks should have a language specified + "MD040": { + // List of languages + "allowed_languages": [], + // Require language only + "language_only": false + }, + + // MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading + "MD041": { + // Heading level + "level": 1, + // RegExp for matching title in front matter + "front_matter_title": "^\\s*title\\s*[:=]" + }, + + // MD042/no-empty-links - No empty links + "MD042": true, + + // MD043/required-headings/required-headers - Required heading structure + "MD043": { + // List of headings + "headings": [ + "*" + ], + // List of headings + // "headers": [], + // Match case of headings + "match_case": false + }, + + // MD044/proper-names - Proper names should have the correct capitalization + "MD044": { + // List of proper names + "names": [], + // Include code blocks + "code_blocks": true, + // Include HTML elements + "html_elements": true + }, + + // MD045/no-alt-text - Images should have alternate text (alt text) + "MD045": true, + + // MD046/code-block-style - Code block style + "MD046": { + // Block style + "style": "consistent" + }, + + // MD047/single-trailing-newline - Files should end with a single newline character + "MD047": true, + + // MD048/code-fence-style - Code fence style + "MD048": { + // Code fence style + "style": "consistent" + }, + + // MD049/emphasis-style - Emphasis style should be consistent + "MD049": { + // Emphasis style should be consistent + "style": "consistent" + }, + + // MD050/strong-style - Strong style should be consistent + "MD050": { + // Strong style should be consistent + "style": "consistent" + }, + + // MD051/link-fragments - Link fragments should be valid + "MD051": true, + + // MD052/reference-links-images - Reference links and images should use a label that is defined + "MD052": true, + + // MD053/link-image-reference-definitions - Link and image reference definitions should be needed + "MD053": { + // Ignored definitions + "ignored_definitions": ["//"] + } +}