extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-04-14 05:58:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update FAQ.md

Browse Source
This commit is contained in:
Markus Fleschutz 2022-09-04 11:30:21 +02:00 committed by GitHub
parent 1ecfc50b7e
commit 1cb3ca6731
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions

19
Docs/FAQ.md
View File

@ -85,16 +85,15 @@ How to write good PowerShell scripts?
------------------------------------- -------------------------------------
Good PowerShell scripts are user-friendly and platform-independent. As a guideline follow these rules, please: Good PowerShell scripts are user-friendly and platform-independent. As a guideline follow these rules, please:
1. the filename is named using the `<verb>-<object>.ps1` scheme 1. Use the `<verb>-<object>.ps1` scheme to name the script.
2. the encoding is UTF-8-BOM to provide Unicode character support 2. Use UTF-8 BOM encoding to support Unicode characters in the script.
3. the scripts have execute file permissions: chmod a+rx <file> (for Linux support) 3. Set *execute* file permissions for Linux: chmod a+rx <file>
4. the scripts provide a comment-based help with synopsis, description, parameters, link, author, and license 4. Add a comment-based help at the beginning with synopsis, description, parameters, link, author, and license.
5. requirements are checked (e.g. #Requires -RunAsAdministrator, or #Requires -Version 3) 5. Check the requirements for the script, e.g. `#Requires -RunAsAdministrator`, or `#Requires -Version 3`
6. prefer command-line options, else ask the user for help 6. Prefer command-line options, else ask the user for help
7. recommended is `Set-StrictMode -Version Latest` to enable additional error checking 7. Recommended is `Set-StrictMode -Version Latest` to enable additional error checking.
8. for readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else 8. For readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else.
9. on error call write-error with keyword "ERROR:" (to support log parsers) and exit the error code (mostly 1) 9. On success exit with error code 0 (`exit 0`), otherwise print the error with keyword "ERROR:" (to support log parsers) and exit the error code (mostly 1)
10. on success exit with error code 0 (exit 0)
Want to contribute or found a bug or issue? Want to contribute or found a bug or issue?