1 SC2316

Vidar Holen edited this page 2022-05-06 10:16:01 -07:00

Table of Contents

• This applies local to the variable named readonly, which is probably not what you want. Use a separate command or the appropriate declare options instead.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

This applies local to the variable named readonly, which is probably not what you want. Use a separate command or the appropriate declare options instead.

Problematic code:

local readonly foo=3
readonly export bar=4

Correct code:

local foo=3
readonly foo

readonly bar=4
export bar

or

declare -r foo=3
declare -rx bar=4

Rationale:

In most languages, declaration modifiers like public/static/const are keywords and you can apply multiple to any declaration.

In shell scripting they are instead command names, and anything after them is an argument. This means that readonly local foo will create two readonly variables: local, and foo. Neither will be local.

Instead, either use multiple commands, or use a single declare command with appropriate flags (declare will automatically make a variable local when invoked in a function, unless -g is passed to explicitly make it global).

Exceptions:

If you want to name your variable local, you can quote it as in readonly "local" to make your intention clear to ShellCheck and other humans.

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.