Shell

The Shell Analyzer analyzes your shell scripts and raises issues if something is wrong with them. It points out bugs and syntax issues with a detailed explanation of how to fix them.

This section covers configuration specific to the Shell analyzer. Please make sure to read the general configuration guide first.

Configuration - .deepsource.toml

name

  • Type: String
  • Presence: mandatory
  • Description: Shortcode of the analyzer.
  • Example:
name = "shell"

enabled

  • Type: Boolean
  • Presence: optional
  • Description: Toggle whether this analyzer should be run.
  • Example:
enabled = true

meta

  • Type: Table
  • Presence: optional
  • Description: Analyzer specific metadata to tweak its behavior. These values are used to customize the checkers.
  • Example:
[analyzers.meta]
  dialect = "bash"

Available meta field

dialect

  • Type: String
  • Presence: optional
  • Description: UNIX shell on which the script is supposed to be run.
  • Available Value: sh, bash, dash and ksh.
  • Default Value: The analyzer detects the shell from the file's shell directive or the shebang line by default.
  • Example:
[analyzers.meta]
  dialect = "sh"

Sample config

version = 1

[[analyzers]]
name = "shell"
enabled = true

  [analyzers.meta]
    dialect = "zsh"