openstack
/
bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
156 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
Go to file
OpenDev Sysadmins 0bb06cc9bb OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
 		2019-04-19 19:26:29 +00:00
.zuul.d OpenDev Migration Patch 2019-04-19 19:26:29 +00:00
bashate Switch to pep8 output format 2018-07-18 22:30:59 +00:00
doc/source Address new pypi requirements on README.rst 2018-07-19 13:04:51 +10:00
playbooks/legacy/bashate-devstack OpenDev Migration Patch 2019-04-19 19:26:29 +00:00
releasenotes Switch to pep8 output format 2018-07-18 22:30:59 +00: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 OpenDev Migration Patch 2019-04-19 19:26:29 +00:00
.mailmap Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
.pre-commit-hooks.yaml Enable bashate use with pre-commit 2018-07-04 20:57:57 +01:00
.testr.conf Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05: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
README.rst Address new pypi requirements on README.rst 2018-07-19 13:04:51 +10: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
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
requirements.txt Update to openstackdocstheme 2017-07-21 08:43:47 +02:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-04 13:01:23 +00: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 Update min tox version to 2.0 2018-11-02 07:43:24 +00: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.

The output format aims to follow pycodestyle (pep8) default output format.

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