openstack/bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
197 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
cbd46caeb8
Go to file
Ghanshyam Mann cbd46caeb8 Test python3.9 as voting job 
In Yoga testing, we are making py3.9 job to run as voting, so
adding py3.9 job as voting.

Also, as bashate is branchless and needs to support older
supported stable branches, let's test it with all the
python version supported in those supported stable branches.
For that, we need to explicitly dd the py jobs instead of using
the template. This way, we will explicitly know that we are testing
all supported python versions when the new release template bumps the
min python version in the template.

Change-Id: Ifda17adba4c5fab369204a34b3ae49eab309a7dd
2021-11-03 21:07:39 +00:00
.zuul.d Test python3.9 as voting job 2021-11-03 21:07:39 +00:00
bashate drop mock from lower-constraints and requirements 2020-06-09 07:54:41 +00:00
doc Update IRC network to OFTC 2021-06-01 16:26:19 +00:00
playbooks/bashate-devstack-master Add ensure-tox role to test job 2021-04-26 11:15:15 +02:00
releasenotes remove unicode from code 2021-01-03 15:14:05 +08: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
bindep.txt Fix doc job 2021-06-01 21:40:59 +05:30
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
requirements.txt Cleanup py27 support 2020-04-10 15:50:07 +02:00
setup.cfg Test python3.9 as voting job 2021-11-03 21:07:39 +00:00
setup.py Cleanup py27 support 2020-04-10 15:50:07 +02:00
test-requirements.txt drop mock from lower-constraints and requirements 2020-06-09 07:54:41 +00:00
tox.ini Test python3.9 as voting job 2021-11-03 21:07:39 +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