6 SC2025

Joachim Ansorg edited this page 2021-11-12 19:19:04 +01:00

Table of Contents

• Make sure all escape sequences are enclosed in [..] to prevent line wrapping issues.
• Problematic code:
• Correct code:
• Rationale:
• Exceptions
• Related resources:

Make sure all escape sequences are enclosed in \[..\] to prevent line wrapping issues.

Problematic code:

PS1='\e[36m\$ \e(B\e[m'

Correct code:

PS1='\[\e[36m\]\$ \[\e(B\e[m\]'

Rationale:

Bash is unable to determine exactly which parts of your prompt are text and which are terminal codes. You have to help it by wrapping invisible control codes in \[..\] (and ensuring that visible characters are not wrapped in \[..\]).

Note: ShellCheck offers this as a helpful hint and not a robust check. Don't rely on ShellCheck to verify that your prompt is correct.

Exceptions

None.

Related resources:

• BashFaq: I have a fancy prompt with colors, and now bash doesn't seem to know how wide my terminal is. Lines wrap around incorrectly.

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.