1

SC1128

koalaman edited this page 2018-01-21 14:24:34 -08:00

Table of Contents

• The shebang must be on the first line. Delete blanks and move comments.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

The shebang must be on the first line. Delete blanks and move comments.

Problematic code:

# Copyright 2018 Foobar, All rights reserved
#!/bin/bash

Correct code:

#!/bin/bash
# Copyright 2018 Foobar, All rights reserved

Rationale:

A shebang only has an effect when it appears as the first line in a script. Specifically, the first two bytes of the file must be #!.

Adding comments, copyright notices or simply an accidental blank line before it will turn a shebang into an ineffectual comment. This means that the script is no longer in charge of its own interpreter, and may fail to run or produce different results depending on the context it's run (e.g. it may work from bash but not from zsh or via sudo).

Delete any leading blank lines, and move all comments after the shebang.

Exceptions:

None

Related resources:

• Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc!

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.

<--- This is a global footer, please don't edit it. --->