Skip to content

Commit

Permalink
style(bash): added decision to start using bash style guide [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
Maurice Faber committed Nov 6, 2020
1 parent f75a878 commit e43b4e3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,6 @@
},
"yaml.schemas": {
"http://json-schema.org/draft/2019-09/schema#": "values-schema.yaml"
}
},
"shellformat.flag": "-i 2 -ci"
}
15 changes: 15 additions & 0 deletions adr/2020-11-06-bash-style-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Maurice:

Seeing we have too many discussions around bash best practices we will settle for a style guide.
I don't see a point in discussing which one to choose, only to choose one that is used by very big corporation/community.
That is why I chose to start using this one:

https://google.github.io/styleguide/shellguide.html

Exceptions:

- Keep file extensions for many reasons: easy for humans, ootb detection for most editors

NOTE:

Added flags to shell-format extension: "-i 2 -ci" to come close according to https://emacs.stackexchange.com/questions/32151/linter-for-google-shell-style-guide

0 comments on commit e43b4e3

Please sign in to comment.