mirror of
https://github.com/servo/servo.git
synced 2025-07-31 03:00:29 +01:00
0327d4638b
* fixed a typo in the Android setup command * Fix typo in documentation for command-line arguments * Fix style and formatting issues in the Shell Scripts section of the documentation * Update style.md * Fixed various inconsistencies * Fixed various inconsistencies * Update webxr.md * Update style.md * Update COMMAND_LINE_ARGS.md * Update README.md Co-authored-by: Martin Robinson <mrobinson@igalia.com> * Update docs/COMMAND_LINE_ARGS.md --------- Co-authored-by: Martin Robinson <mrobinson@igalia.com>
29 lines
860 B
Markdown
29 lines
860 B
Markdown
# Style Guide
|
|
|
|
The majority of our style recommendations are automatically enforced via our
|
|
automated linters. This document has guidelines that are less easy to lint for.
|
|
|
|
## Shell scripts
|
|
|
|
Shell scripts are suitable for small tasks or wrappers, but it's preferable to use Python for
|
|
anything with a hint of complexity or in general.
|
|
|
|
Shell scripts should be written using bash, starting with this shebang:
|
|
```
|
|
#!/usr/bin/env bash
|
|
```
|
|
|
|
Note that the version of bash available on macOS by default is quite old, so be
|
|
careful when using new features.
|
|
|
|
Scripts should enable a few options at the top for robustness:
|
|
```
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
```
|
|
|
|
Rememeber to quote all variables, using the full form: `"${SOME_VARIABLE}"`.
|
|
|
|
Use `"$(some-command)"` instead of backticks for command substitution. Note
|
|
that these should be quoted as well.
|