format the shell script

Question

I have some 1000 lines shell script with all the kepywords

if/else, while, HERE document

Can anyone tell the best way to format the script, so the script looks good.

I was trying VG= in vim but that displaces HERE document content as well.

Add an example, further explain what you are trying to do. With this limited amount of information, we can't help you. — MrKickkiller, Jul 31 '17 at 09:46
@syadav I'll write it as answer, could you accept it in order to close the question? Thanks — DanieleO, Jul 31 '17 at 11:01
As metioned gg=G is not a good way to format the shell script as it indent entire file includeing HERE document which should not be. I am looking more for an external tool/plugin/script which can do this — Ajay Singh, Aug 11 '17 at 05:52

score 12 · Answer 1 · answered Oct 31 '17 at 03:05

12

check this https://github.com/mvdan/sh, here is the sample command for indent with two spaces

shfmt -i 2 -w yourscript

answered Oct 31 '17 at 03:05

Daniel YC Lin

score 1 · Answer 2 · edited Jul 31 '17 at 14:24

1

By default the gg=G gives you 8 tab spaces. To reduce the 8 tab spaces to 3 spaces edit your .vimrc file:

set tabstop=3
set shiftwidth=3
set expandtab

This SO question qives you a good, in context discussion of everything gg=G related.

edited Jul 31 '17 at 14:24

gboffi

answered Jul 31 '17 at 14:07

Arun Kurian

The problem with gg=G is it indent the HERE document code as well – Ajay Singh Aug 11 '17 at 05:50
Ex - cat << EOF – Ajay Singh Aug 11 '17 at 05:50

score 0 · Answer 3 · answered Jul 31 '17 at 11:02

0

Using VIM add the parameter below in order to indent the entire file

gg=G

answered Jul 31 '17 at 11:02

DanieleO

you must add the steps also , how to add this parameter. – sumitya Jul 31 '17 at 11:19

phk · Answer 4 · 2017-09-26T15:00:11.687

0

PyCharm's BashSupport plugin now has an experimental bash code formatter.

edited Sep 26 '17 at 15:00

answered Aug 09 '17 at 15:24

phk

score 0 · Answer 5 · answered Jul 07 '21 at 07:19

I found a VSCode plugin based on https://github.com/mvdan/sh , support the .sh .bash Dockerfile .gitignore .properties /etc/hosts ...

Homepage:

macOS usage:

shift+option+f

or

shift+command+p then type Format Document

5 Answers5