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.
 
 
 
Martin Kopec aea8e78217 Switch testing to Yoga testing runtime 2 weeks ago
.zuul.d Switch testing to Yoga testing runtime 2 weeks ago
bashate drop mock from lower-constraints and requirements 1 year ago
doc Update IRC network to OFTC 5 months ago
playbooks/bashate-devstack-master Add ensure-tox role to test job 6 months ago
releasenotes remove unicode from code 10 months ago
.coveragerc Update .coveragerc after the removal of openstack directory 5 years ago
.gitignore Use stestr as a test runner 2 years ago
.gitreview OpenDev Migration Patch 3 years ago
.mailmap Import fresh cookiecut bash8 project 8 years ago
.pre-commit-hooks.yaml Enable bashate use with pre-commit 3 years ago
.stestr.conf Use stestr as a test runner 2 years ago
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2 years ago
HACKING.rst the great rename of bash8 -> bashate 7 years ago
LICENSE Import fresh cookiecut bash8 project 8 years ago
README.rst Add release notes and contributing in readme 2 years ago
bindep.txt Fix doc job 5 months ago
requirements.txt Cleanup py27 support 2 years ago
setup.cfg setup.cfg: Replace dashes with underscores 6 months ago
setup.py Cleanup py27 support 2 years ago
test-requirements.txt drop mock from lower-constraints and requirements 1 year ago
tox.ini Changed minversion in tox to 3.18.0 8 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