A huge part of programming in general is learning how to troubleshoot something, not just having someone else fix it for you. One of the basic ways to do that is by tracing. Not only can this help you figure out what your script is doing and how it’s doing it, but in the event that you need help from another person, posting the output can be beneficial to the person attempting to help.

(If your shell isn’t listed and you know how to enable tracing, comment below and I’ll add it to the table!)

Shell How to enable tracing
Bash set -x or set -o xtrace
Fish set fish_trace on
sh set -x
Zsh set -x or setopt xtrace

Also, writing scripts in an IDE that supports your language. syntax highlighting can immediately tell you that you’re doing something wrong.

If an IDE isn’t an option and you’re using Bash or Sh, you can paste your script into https://www.shellcheck.net/

(Inspired by this post on /r/bash)

  • Erlingur@programming.devEnglish
    2·
    1 year ago

    Can someone post an example of what this actually does? Haven’t seen this before and I can’t seem to easily see an example of what effect this has on your scripts. I’m guessing by reading some links that it outputs all commands that a script ran? Is that right?

    • Tonka Truck@programming.devEnglish
      3·
      1 year ago

      It’s basically doing step by step print lines for you. If you have easy access to a bash prompt here’s an example (for clarity, the lines leading with $ are what I typed into the shell. The lines without are what is output’d):

      $ set -x
$ echo `expr 10 + 20 `
++ expr 10 + 20
+ echo 30
30

      $ set +x
$ echo `expr 10 + 20 `
30

      You see how the first example broke down what happened bit by bit and the + noted the depth of interpretation for the line? This basically helps debug narly scripts … which if they’re narly enough … just rewrite them in a “proper” language.

      What’s that old google adage ( https://google.github.io/styleguide/shellguide.html )

      If you are writing a script that is more than 100 lines long, or that uses non-straightforward control flow logic, you should rewrite it in a more structured language now.