Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.12 KB

SC2059.md

File metadata and controls

51 lines (33 loc) · 1.12 KB

Pattern: Use of variable in printf

Issue: -

Description

printf interprets escape sequences and format specifiers in the format string. If variables are included, any escape sequences or format specifiers in the data will be interpreted too, when you most likely wanted to treat it as data. Example:

coverage='96%'
printf "Unit test coverage: %s\n" "$coverage"
printf "Unit test coverage: $coverage\n"

The first printf writes Unit test coverage: 96%.

The second writes bash: printf: \': invalid format character

Example of incorrect code:

printf "Hello, $NAME\n"

Example of correct code:

printf "Hello, %s\n" "$NAME"

Exceptions

Sometimes you may actually want to interpret data as a format string, like in:

hexToAscii() { printf "\x$1"; }
hexToAscii 21

or when you have a pattern in a variable:

filepattern="file-%d.jpg"
printf -v filename "$filepattern" "$number"

These are valid use cases with no useful rewrites. Please ignore the warnings with a directive.

Further Reading