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.
OpenDev Sysadmins 0bb06cc9bb OpenDev Migration Patch 1 month ago
.zuul.d OpenDev Migration Patch 1 month ago
bashate Switch to pep8 output format 10 months ago
doc/source Address new pypi requirements on README.rst 10 months ago
playbooks/legacy/bashate-devstack OpenDev Migration Patch 1 month ago
releasenotes Switch to pep8 output format 10 months ago
.coveragerc Update .coveragerc after the removal of openstack directory 2 years ago
.gitignore Import fresh cookiecut bash8 project 5 years ago
.gitreview OpenDev Migration Patch 1 month ago
.mailmap Import fresh cookiecut bash8 project 5 years ago
.pre-commit-hooks.yaml Enable bashate use with pre-commit 10 months ago
.testr.conf Import fresh cookiecut bash8 project 5 years ago
CONTRIBUTING.rst Fix formatting of contributor page 1 year ago
HACKING.rst the great rename of bash8 -> bashate 5 years ago
LICENSE Import fresh cookiecut bash8 project 5 years ago
README.rst Address new pypi requirements on README.rst 10 months ago
babel.cfg Import fresh cookiecut bash8 project 5 years ago
bindep.txt Add bindep.txt file 1 year ago
openstack-common.conf the great rename of bash8 -> bashate 5 years ago
pylintrc Add Pylint testenv environment 4 years ago
requirements.txt Update to openstackdocstheme 1 year ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago
setup.py Update requirements 3 years ago
test-requirements.txt Update to openstackdocstheme 1 year ago
tox.ini Update min tox version to 2.0 6 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