openstack/bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
202 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
f5426a8c83
Go to file
Martin Kopec f5426a8c83 Switch testing to Antelope testing runtime 
Updating the testing template to Antelope testing runtime:
https://governance.openstack.org/tc/reference/runtimes/2023.1.html

Change-Id: I3f05590f48c026eabc02b84b2c7e213bd1dfe220
2023-01-19 11:14:29 +01:00
.zuul.d Switch testing to Antelope testing runtime 2023-01-19 11:14:29 +01:00
bashate Check indents on comment lines 2021-11-10 19:07:30 +09: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 Do not run pre-commit verbose by default 2022-04-01 12:22:59 +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 Switch testing to Antelope testing runtime 2023-01-19 11:14:29 +01: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