openstack/bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
111 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
dc419beb2d
Go to file
Andreas Jaeger dc419beb2d Enable release notes translation 
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in conf.py to generate translated version of the
release notes.

Note that this repository might not get translated release notes - or
no translations at all - but we add the entry here nevertheless to
prepare for it.

Change-Id: I512878af85887d8cb7e8b241797ff611a35972c1
2016-10-06 20:21:20 +02:00
bashate Exclude hashbangs check for .bashrc, .bash_profile, etc 2016-04-30 07:31:59 +00:00
doc/source Add releasenotes venv 2016-04-26 15:47:29 +10:00
releasenotes Enable release notes translation 2016-10-06 20:21:20 +02: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
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 Update docs to include all errors 2016-07-11 20:14:31 +00:00
requirements.txt Remove argparse from requirements 2016-01-20 19:28:54 +01:00
setup.cfg Drop py26 support 2015-12-15 14:52:06 +05:30
setup.py Update requirements 2016-01-05 08:38:31 +01:00
test-requirements.txt Add reno & start at release notes 2016-03-07 13:08:39 +11:00
tox.ini Add releasenotes venv 2016-04-26 15:47:29 +10: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.

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

See also

See also /man/bashate.