openstack/bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
87 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
ca1a8080e6
Go to file
sonu.kumar ca1a8080e6 Drop py26 support 
as of mitaka, the infra team won't have the resources available to
reasonably test py26, also the oslo team is dropping py26 support
from their libraries. sine we rely on oslo for a lot of our work,

Change-Id: I352fe202a1f954b52e8e9ef8bc0a20f729ac17be
2015-12-15 14:52:06 +05:30
bashate Add shallow syntax checking 2015-10-15 16:50:06 +01:00
doc/source Add man page 2014-10-29 12:33:28 +11:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 09:12:25 -05:00
.gitignore Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
.gitreview Fix .gitreview project path 2014-07-15 21:02:59 -05:00
.mailmap Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
.testr.conf Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
babel.cfg Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:41 +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
MANIFEST.in Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
openstack-common.conf the great rename of bash8 -> bashate 2014-06-20 16:41:12 -04:00
pylintrc Add Pylint testenv environment 2014-10-14 10:22:25 +11:00
README.rst Add shallow syntax checking 2015-10-15 16:50:06 +01:00
requirements.txt Warn against sorting requirements 2014-10-14 10:39:29 +11:00
setup.cfg Drop py26 support 2015-12-15 14:52:06 +05:30
setup.py Fix PEP8 violations 2014-05-02 00:45:49 -05:00
test-requirements.txt Move to hacking 0.10 2015-06-05 14:16:32 +09:00
tox.ini Drop py26 support 2015-12-15 14:52:06 +05:30

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.

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
  • 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

See also

See also /man/bashate.