ExternalVendorCode/bash3boilerplate
1
0
Fork 0
mirror of https://github.com/kvz/bash3boilerplate.git synced 2024-12-24 08:36:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Elaborate on new best practice a little

Browse Source
This commit is contained in:
Kevin van Zonneveld 2016-06-21 10:32:29 +02:00
parent ff881d529f
commit fe733c1356
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
FAQ.md
View File

@ -58,7 +58,7 @@ contains the line
then you can evaluate the corresponding argument and assign it to a variable as follows: then you can evaluate the corresponding argument and assign it to a variable as follows:
```bash ```bash
temp_file_name="${arg_t}" __temp_file_name="${arg_t}"
``` ```
## What is a magic variable? ## What is a magic variable?

10
README.md
View File

@ -23,7 +23,7 @@ When hacking up Bash scripts, there are often higher level things like logging,
configuration, command-line argument parsing that: configuration, command-line argument parsing that:
- You need every time - You need every time
- Come with a number of pitfalls to get right - Come with a number of pitfalls to avoid
- Keep you from your actual work - Keep you from your actual work
Here's an attempt to bundle those things in a generalized way so that Here's an attempt to bundle those things in a generalized way so that
@ -31,10 +31,10 @@ they are reusable as-is in most scripts.
## Goals ## Goals
Delete-key-friendly. I propose using [`main.sh`](./main.sh) as a base and removing the **Delete-key-friendly**. We propose using [`main.sh`](./main.sh) as a base and removing the
parts you don't need, rather than introducing a ton of packages, includes, compilers, etc. parts you don't need, rather than introducing packages, includes, compilers, etc.
Aiming for portability, I'm targeting Bash 3 (OSX still ships **Portability**. We're targeting Bash 3 (OSX still ships
with 3 for instance). If you're going to ask people to install with 3 for instance). If you're going to ask people to install
Bash 4 first, you might as well pick a more advanced language as a Bash 4 first, you might as well pick a more advanced language as a
dependency. dependency.
@ -102,7 +102,7 @@ $ my_script some more args --blah
- In functions, use `local` before every variable declaration - In functions, use `local` before every variable declaration
- This project settles on two spaces for tabs - This project settles on two spaces for tabs
- Use `UPPERCASE_VARS` to indicate environment variables that can be controlled outside your script - Use `UPPERCASE_VARS` to indicate environment variables that can be controlled outside your script
- Use `__double_underscore_prefixed_vars` to indicate global variables that are solely controlled inside your script - Use `__double_underscore_prefixed_vars` to indicate global variables that are solely controlled inside your script, with the exception of arguments wich are already prefixed with `arg_`, and functions, over which b3bp poses no restrictions.
## Frequently Asked Questions ## Frequently Asked Questions