< Back

nTestDescriptionAndAuthorField

Sat Jan 18, 2020 5:19 pm

NAME nTestDescriptionAndAuthorField



SYNOPSIS

Ensures module manifest has Description and Author field which are required for publishing





SYNTAX

nTestDescriptionAndAuthorField [-ScriptBlockAst] <ScriptBlockAst> [<CommonParameters>]





DESCRIPTION

PowerShell Modules are accompanied by module manifests. Some fields from these module

manifests are used for publishing them into the gallery. This rule checks if the

'Description' and 'Author' fields are specified





PARAMETERS

-ScriptBlockAst <ScriptBlockAst>



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

[System.Management.Automation.Language.ScriptBlockAst]





OUTPUTS

[Microsoft.Windows.Powershell.ScriptAnalyzer.Generic.DiagnosticRecord[]]





NOTES





None



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>nTestDescriptionAndAuthorField -ScriptBlockAst $ScriptBlockAst















RELATED LINKS