9 SC1001

wileyhy edited this page 2024-10-05 22:08:34 -07:00

Table of Contents

• This \o will be a regular 'o' in this context.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions
• Related resources:

This \o will be a regular 'o' in this context.

Problematic code:

# Want literal backslash
echo Yay \o/

# Want other characters
bell=\a

Correct code:

echo 'Yay \o/'

bell="$(printf '\a')"

Rationale:

You have escaped something that has no special meaning when escaped. The backslash will be simply be ignored.

If the backslash was supposed to be literal, single quote or escape it.

If you wanted it to expand to something, rewrite the expression to use printf (or in bash, $'\t'). If the sequence in question is \n, \t or \r, you instead get a SC1012 that describes this.

Exceptions

None. ShellCheck (as of 2017-07-03, commit 31bb02d6) will not warn when the first letter of a command is unnecessarily escaped, as this is frequently used to suppress aliases interactively.

Related resources:

https://www.gnu.org/software/bash/manual/html_node/Aliases.html https://www.gnu.org/software/bash/manual/html_node/Quoting.html https://tiswww.case.edu/php/chet/bash/bash.html

ShellCheck

• Installation

  • CentOS6
  • More Installation Guides

• Usage

  • Directive
  • Ignore

• Integrating and extending

  • Misc. contributions
  • Azure Pipelines
  • Buildkite
  • CircleCI
  • DevGuide
  • Integration
  • JUnit
  • Phabricator
  • TravisCI
  • GitLab CI
  • Drone
  • GitHub Actions

• Severity

• Template

Each individual ShellCheck warning has its own wiki page like SC1000. Use GitHub Wiki's "Pages" feature above to find a specific one, or see Checks.