Live manual Debian Live

# Debian Live Manual

# Style de code

750

# 15. Style du code

751

Ce chapitre documente le style du code utilisé dans les systèmes live.

752

15.1 Compatibilité

753

- Avoid "bashisms", the codebase must be POSIX compliant and thus universally compatible.

754

- Furthermore it must comply with the version of the POSIX specification chosen by the current Debian Policy.

755

- Vous pouvez vérifier vos scripts avec 'sh -n' et 'checkbashisms'.

756

- Assurez-vous que tout le code fonctionne avec 'set-e '.

757

15.2 Indentation

758

- Utilisez toujours des tabulations au lieu des espaces.

759

- Keep case branch terminators (";;") aligned with the "content" of the branch, rather than the branch "entry".

760

Bien:

761

case "${1}" in
foo)
foobar
;;
bar)
foobar
;;
esac

762

15.3 Adaptateur

763

- Generally, lines should be 80 chars at maximum.

764

- Placement of keywords like `then` and `do` should be chosen with good judgement with respect to clutter and readability. For small bits of code in particular it should be preferred to have them on the same line as the prior keyword they relate to (`if`; `for`; etc). Only place on the next line where it makes good sense to do so; typically this might only be to comply with maximum line length restrictions. One situation where they should always be placed on the next line is where what they follow is broken up onto multiple lines, and thus it being on a new line creates clear separation between that and the body of code following it. I.e. :

765

Preferred:

766

if foo; then
bar
fi
for FOO in $ITEMS; do
bar
done
if [ "${MY_LOCATION_VARIABLE}" = "something" ] && [ -e "${MY_OUTPUT_FILE}" ]
then
MY_OTHER_VARIABLE="$(some_bin ${FOOBAR} | awk -F_ '{ print $1 }')"
fi
if [ "${MY_FOO}" = "something" ] && [ -e "path/${FILE_1}" ] ||
[ "${MY_BAR}" = "something_else" ] && [ ${ALLOW} = "true" ]
then
foobar
fi

767

Less ideal:

768

if [ "${MY_LOCATION_VARIABLE}" = "something" ] && [ -e "${MY_OUTPUT_FILE}" ]; then
MY_OTHER_VARIABLE="$(some_bin ${FOOBAR} | awk -F_ '{ print $1 }')"
fi

769

Horrible:

770

if [ "${MY_LOCATION_VARIABLE}" = "something" ] && [ -e "${MY_OUTPUT_FILE}" ] || [ "${MY_LOCATION_VARIABLE}" = "something-else" ] && [ -e "${MY_OUTPUT_FILE_2}" ]; then
MY_OTHER_VARIABLE="$(some_bin ${FOOBAR} | awk -F_ '{ print $1 }')"
fi

771

- Prefer placing the opening brace of a function on a new line (for consistency with established style), and keep the braces aligned with the function name:

772

Bien:

773

Foo ()
{
bar
}

774

Bad (inconsistent with existing style):

775

Foo () {
bar
}

776

Awful:

777

Foo ()
{
bar
}

778

15.4 Variables

779

- Les variables sont toujours en lettres majuscules.

780

- Config variables used in live-build should start with an `LB_` prefix.

781

- Local function variables should be restricted to local scope.

782

- Les variables en relation avec un paramètre de démarrage dans live-config commencent par `LIVE_`.

783

- Toutes les autres variables dans live-config commencent par le préfixe `_`.

784

- Utilisez des accolades autour des variables; écrivez par exemple `${FOO}` au lieu de `$FOO`.

785

- Always protect variables with quotes to respect potential whitespaces (except where necessary to achieve correct word splitting): write `"${FOO}"` not `${FOO}`.

786

- Pour des raisons de cohérence, utilisez toujours les guillemets lors de l'attribution des valeurs aux variables:

787

Mal:

788

FOO=bar

789

Bien:

790

FOO="bar"

791

- If multiple variables are used, prefer quoting the full expression:

792

Typically bad:

793

if [ -f "${FOO}"/foo/"${BAR}"/bar ]; then
foobar
fi

794

Bien:

795

if [ -f "${FOO}/foo/${BAR}/bar" ]; then
foobar
fi

796

15.5 Autres

797

- Prefer "`|`" (without the surround quotes) as a separator in calls to sed, e.g. "`sed -e 's|foo|bar|'`" (without "").

798

- Don't use the `test` command for comparisons or tests, use "`[`" and "`]`" (without ""); e.g. "`if [ -x /bin/foo ]; ...`" and not "`if test -x /bin/foo; ...`".

799

- Use `case` wherever it makes code more readable than conditional checks (`if foo; ...` and tests without the actual `if` keyword, e.g. `[ -e "${FILE}" ] || exit 0`).

800

- Use "Foo_bar" style names for functions, i.e. a capital first letter, then all lowercase, with sensible use of underscores for better readability.