openstack/bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
139 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
d4f6cfa3fb
Go to file
Paul Belanger d4f6cfa3fb
Add bindep.txt file 
Bindep is a tool for checking the presence of binary packages needed
to use an application / library. It started life as a way to make it
easier to set up a development environment for OpenStack projects.

Change-Id: Id58d5e1ff4a2a9a2ace474cf3f4ed949737ec823
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
2018-04-20 15:08:15 -04:00
.zuul.d Use openstack-tox-py36 2018-01-25 08:51:51 +01:00
bashate Merge "Add a [[ checker" 2018-03-29 05:58:56 +00:00
doc/source Reorder content to follow new structure 2017-07-21 08:54:40 +02:00
playbooks/legacy/bashate-devstack Stop using slave_scripts/install-distro-packages.sh 2018-04-20 14:55:08 -04:00
releasenotes Remove setting of version/release from releasenotes 2017-11-16 18:52:15 +01:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-10-21 23:49:28 +05:30
.gitignore Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
.gitreview Fix .gitreview project path 2014-07-15 21:02:59 -05:00
.mailmap Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
.testr.conf Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
babel.cfg Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
bindep.txt Add bindep.txt file 2018-04-20 15:08:15 -04:00
CONTRIBUTING.rst Fix formatting of contributor page 2017-07-21 08:57:28 +02:00
HACKING.rst the great rename of bash8 -> bashate 2014-06-20 16:41:12 -04:00
LICENSE Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
openstack-common.conf the great rename of bash8 -> bashate 2014-06-20 16:41:12 -04:00
pylintrc Add Pylint testenv environment 2014-10-14 10:22:25 +11:00
README.rst Merge "Add a [[ checker" 2018-03-29 05:58:56 +00:00
requirements.txt Update to openstackdocstheme 2017-07-21 08:43:47 +02:00
setup.cfg Treat sphinx warnings as errors 2017-07-21 08:54:46 +02:00
setup.py Update requirements 2016-01-05 08:38:31 +01:00
test-requirements.txt Update to openstackdocstheme 2017-07-21 08:43:47 +02:00
tox.ini Add bindep.txt file 2018-04-20 15:08:15 -04:00

README.rst

bashate

A pep8 equivalent for bash scripts

This program attempts to be an automated style checker for bash scripts to fill the same part of code review that pep8 does in most OpenStack projects. It started from humble beginnings in the DevStack project, and will continue to evolve over time.

Currently Supported Checks

Errors

Basic white space errors, for consistent indenting

  • E001: check that lines do not end with trailing whitespace
  • E002: ensure that indents are only spaces, and not hard tabs
  • E003: ensure all indents are a multiple of 4 spaces
  • E004: file did not end with a newline
  • E005: file does not begin with #! or have a .sh prefix
  • E006: check for lines longer than 79 columns

Structure Errors

A set of rules that help keep things consistent in control blocks. These are ignored on long lines that have a continuation, because unrolling that is kind of "interesting"

  • E010: do not on the same line as for
  • E011: then not on the same line as if or elif
  • E012: heredoc didn't end before EOF
  • E020: Function declaration not in format ^function name {$

Obsolete, deprecated or unsafe syntax

Rules to identify obsolete, deprecated or unsafe syntax that should not be used

  • E040: Syntax errors reported by bash -n
  • E041: Usage of $[ for arithmetic is deprecated for $((
  • E042: local declaration hides errors
  • E043: arithmetic compound has inconsistent return semantics
  • E044: Use [[ for =~,<,> comparisions

See also

See also /man/bashate.