1 SC1126

koalaman edited this page 2017-11-04 15:57:37 -07:00

Table of Contents

• Place shellcheck directives before commands, not after.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:

Place shellcheck directives before commands, not after.

Problematic code:

var=1 # shellcheck disable=SC2034

Correct code:

# shellcheck disable=SC2034
var=1 

Rationale:

ShellCheck expects directives to come before the relevant command. They are not allowed after.

Exceptions:

If this is not a directive and just a comment mentioning ShellCheck, please rewrite or capitalize:

var=1 # ShellCheck encourages lowercase variable names

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.