Code style enforcement for bash programs.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
tushargite96 389f8917cd Add Python3 wallaby unit tests 1 month ago
.zuul.d Add Python3 wallaby unit tests 1 month ago
bashate drop mock from lower-constraints and requirements 5 months ago
doc Create tox environment to build pdf documentation 2 months ago
playbooks/bashate-devstack-master Convert devstack-bashate to native job 9 months ago
releasenotes Switch to newer openstackdocstheme and reno versions 6 months ago
.coveragerc Update .coveragerc after the removal of openstack directory 4 years ago
.gitignore Use stestr as a test runner 1 year ago
.gitreview OpenDev Migration Patch 1 year ago
.mailmap Import fresh cookiecut bash8 project 6 years ago
.pre-commit-hooks.yaml Enable bashate use with pre-commit 2 years ago
.stestr.conf Use stestr as a test runner 1 year ago
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 7 months ago
HACKING.rst the great rename of bash8 -> bashate 6 years ago
LICENSE Import fresh cookiecut bash8 project 6 years ago
README.rst Add release notes and contributing in readme 1 year ago
bindep.txt Add bindep.txt file 2 years ago
requirements.txt Cleanup py27 support 7 months ago
setup.cfg Switch testing to Victoria testing runtime 6 months ago
setup.py Cleanup py27 support 7 months ago
test-requirements.txt drop mock from lower-constraints and requirements 5 months ago
tox.ini Create tox environment to build pdf documentation 2 months ago

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