3 SC1039

John Gardner edited this page 2021-12-22 19:35:09 +11:00

Table of Contents

• Remove indentation before end token (or use <<- and indent with tabs).
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:

Remove indentation before end token (or use <<- and indent with tabs).

Problematic code:

for f in *.png
do
  cat << HTML
     <img src="$f" /><br/>
  HTML
done > index.html

Correct code:

for f in *.png
do
  cat << HTML
     <img src="$f" /><br/>
HTML
done > index.html

Rationale:

The here document delimiter will not be recognized if it is indented.

You can fix it in one of two ways:

1. Simply remove the indentation, even though this may break formatting.
2. Use <<- instead of <<, and indent the script with tabs only (spaces will not be recognized).

Removing the indentation is preferred, since the script won't suddenly break if it's reformatted, copy-pasted, or saved with a different editor.

Exceptions:

If the line was supposed to be a literal part of the here document, consider choosing a less ambiguous token.

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.