This repository has been archived on 2023-10-10. You can view files and clone it, but cannot push or open issues or pull requests.
DroneHelper/docs/Test-FileTailingWhitespace.md
Marco Blessing 6a314eeb48
All checks were successful
continuous-integration/drone/push Build is passing
add platyPS generated docs (#5)
#### 📖 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
2022-07-14 11:22:06 +02:00

59 lines
1.1 KiB
Markdown

---
external help file: ModuleRoot-help.xml
Module Name: DroneHelper
online version:
schema: 2.0.0
---
# Test-FileTailingWhitespace
## SYNOPSIS
Returns false if there are any tailing whitespace in lines.
## SYNTAX
```
Test-FileTailingWhitespace [-Path] <String> [<CommonParameters>]
```
## DESCRIPTION
Tests the given file for tailing whitespace.
Returns true if not found.
## EXAMPLES
### EXAMPLE 1
```
Test-FileTailingWhitespace.ps1 -Path './testfile.txt'
```
## PARAMETERS
### -Path
Relative or full path to an existing file.
```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
### [none]
## OUTPUTS
### [bool]
## NOTES
## RELATED LINKS