Skip to content

Refactor Task for PascalCase#314

Merged
devblackops merged 16 commits intopsake:masterfrom
Splaxi:refactor-task-pascal-convention
Apr 14, 2022
Merged

Refactor Task for PascalCase#314
devblackops merged 16 commits intopsake:masterfrom
Splaxi:refactor-task-pascal-convention

Conversation

@Splaxi
Copy link
Copy Markdown
Contributor

@Splaxi Splaxi commented Apr 4, 2022

Convert parameter names into pascal

Description

Convert parameter names into pascal

Related Issue

#308

Motivation and Context

How Has This Been Tested?

ps>Get-Help Task -Full

NAME
    Task

SYNOPSIS
    Defines a build task to be executed by psake


SYNTAX
    Task [-Name] <String> [[-Action] <ScriptBlock>] [[-PreAction] <ScriptBlock>] [[-PostAction] <ScriptBlock>]
    [[-PreCondition] <ScriptBlock>] [[-PostCondition] <ScriptBlock>] [[-ContinueOnError]] [[-Depends] <String[]>]
    [[-RequiredVariables] <String[]>] [[-Description] <String>] [[-Alias] <String>] [<CommonParameters>]

    Task [-Name] <String> [[-Action] <ScriptBlock>] [[-PreAction] <ScriptBlock>] [[-PostAction] <ScriptBlock>]
    [[-PreCondition] <ScriptBlock>] [[-PostCondition] <ScriptBlock>] [[-ContinueOnError]] [[-Depends] <String[]>]
    [[-RequiredVariables] <String[]>] [[-Description] <String>] [[-Alias] <String>] [-FromModule] <String>
    [[-RequiredVersion] <String>] [[-MinimumVersion] <String>] [[-MaximumVersion] <String>] [[-LessThanVersion]
    <String>] [<CommonParameters>]


DESCRIPTION
    This function creates a 'task' object that will be used by the psake engine to execute a build task.
    Note: There must be at least one task called 'default' in the build script


RELATED LINKS
    Assert
    Exec
    FormatTaskName
    Framework
    Get-PSakeScriptTasks
    Include
    Invoke-psake
    Properties
    TaskSetup
    TaskTearDown

REMARKS
    To see the examples, type: "get-help Task -examples".
    For more information, type: "get-help Task -detailed".
    For technical information, type: "get-help Task -full".
    For online help, type: "get-help Task -online"

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Splaxi added 15 commits April 4, 2022 10:34
Name converted to Pascal case
Action converted to Pascal case
PreAction converted to pascal case
PostAction converted to pascal case
PreCondition converted to pascal case
PostCondition converted to pascal case
ContinueOnError converted to pascal case
Depends converted to pascal case
RequiredVariables converted to pascal
Description converted to pascal case
Alias converted to pascal case
RequiredVersion converted to pascal case
MinimumVersion converted to pascal case
MaximumVersion converted to pascal
LessThanVersion converted to pascal
@Splaxi
Copy link
Copy Markdown
Contributor Author

Splaxi commented Apr 4, 2022

I was hoping that you had some kind of build task, that would auto populate the markdown files of the project 🤞

@Splaxi
Copy link
Copy Markdown
Contributor Author

Splaxi commented Apr 4, 2022

Found the CreateMarkdownHelp in the build.ps1 file

@devblackops
Copy link
Copy Markdown
Member

Thanks @Splaxi.

@devblackops devblackops merged commit aca6ea9 into psake:master Apr 14, 2022
@Splaxi
Copy link
Copy Markdown
Contributor Author

Splaxi commented Apr 14, 2022

@devblackops Do you want me to take a swing at the other cmdlets / functions while I'm at it?

@devblackops
Copy link
Copy Markdown
Member

@Splaxi That'd be great. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants