Marco Blessing
6a314eeb48
All checks were successful
continuous-integration/drone/push Build is passing
#### 📖 Summary - Adds `platyPS` generated docs - Converted CRLF output into LF - linked global readme file in module page #### 📑 Test Plan > 💡 Select your test plan for the code changes. - [x] Tested via Drone.io pipeline - [ ] Custom test - [ ] No test plan ##### Details / Justification <!-- Add your test details or justification for missing tests here. --> #### 📚 Additional Notes <!-- A place for additional detail notes. --> Co-authored-by: OCram85 <marco.blessing@googlemail.com> Reviewed-on: #5
59 lines
1.1 KiB
Markdown
59 lines
1.1 KiB
Markdown
---
|
|
external help file: ModuleRoot-help.xml
|
|
Module Name: DroneHelper
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Invoke-FileLinter
|
|
|
|
## SYNOPSIS
|
|
Runs the file linter for all src files found in current repository.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Invoke-FileLinter [-PassThru] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Invoke-FileLinter runs the basic file tests and generates a report file for furher usage in the
|
|
drone pipeline.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
Invoke-FileLinter
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -PassThru
|
|
{{ Fill PassThru 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
|
|
|
|
### [None]
|
|
## OUTPUTS
|
|
|
|
### [DroneHelper.FileLinter.Report]
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|