openstack
/
bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
175 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
Go to file
Ghanshyam Mann 060abe4f82 [ussuri][goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: Ief0ff4a7f69a4ba44abd846d720630c2232d4fe0
 		2020-04-22 14:03:09 +00:00
.zuul.d Support python 3.5 2020-02-13 09:23:06 -06:00
bashate Add an ability to specify max line length 2020-02-04 13:35:52 +11:00
doc/source [ussuri][goal] Update contributor documentation 2020-04-22 14:03:09 +00:00
playbooks/bashate-devstack-master Convert devstack-bashate to native job 2020-02-04 10:30:28 +11:00
releasenotes Merge "Add an ability to specify max line length" 2020-02-04 02:55:12 +00:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-10-21 23:49:28 +05:30
.gitignore Use stestr as a test runner 2019-06-24 16:30:27 +09: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
.stestr.conf Use stestr as a test runner 2019-06-24 16:30:27 +09:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2020-04-22 14:03:09 +00: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 Add release notes and contributing in readme 2019-10-06 10:08:34 +08: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
requirements.txt Update to openstackdocstheme 2017-07-21 08:43:47 +02:00
setup.cfg Support python 3.5 2020-02-13 09:23:06 -06:00
setup.py Update requirements 2016-01-05 08:38:31 +01:00
test-requirements.txt [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 10:33:06 +11:00
tox.ini [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 10:33:06 +11: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