openstack
/
bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
175 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
Go to file
Andreas Jaeger 48c348d524 Update hacking for Python3 
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.

Fix:
W605 invalid escape sequence
E117 over-indented
E305 expected 2 blank lines after class or function definition, found 1

Ignore:
W504 line break after binary operator

Change-Id: Iab3fded493e781156ab7ac85aac641bf536361d5
 		2020-03-31 06:49:47 +00:00
.zuul.d Support python 3.5 2020-02-13 09:23:06 -06:00
bashate Update hacking for Python3 2020-03-31 06:49:47 +00:00
doc/source Address new pypi requirements on README.rst 2018-07-19 13:04:51 +10:00
playbooks/bashate-devstack-master Convert devstack-bashate to native job 2020-02-04 10:30:28 +11:00
releasenotes Merge "Add an ability to specify max line length" 2020-02-04 02:55:12 +00:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-10-21 23:49:28 +05:30
.gitignore Use stestr as a test runner 2019-06-24 16:30:27 +09:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:29 +00:00
.mailmap Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
.pre-commit-hooks.yaml Enable bashate use with pre-commit 2018-07-04 20:57:57 +01:00
.stestr.conf Use stestr as a test runner 2019-06-24 16:30:27 +09:00
CONTRIBUTING.rst Fix formatting of contributor page 2017-07-21 08:57:28 +02: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
README.rst Add release notes and contributing in readme 2019-10-06 10:08:34 +08:00
babel.cfg Import fresh cookiecut bash8 project 2014-04-23 00:06:39 -05:00
bindep.txt Add bindep.txt file 2018-04-20 15:08:15 -04:00
openstack-common.conf the great rename of bash8 -> bashate 2014-06-20 16:41:12 -04:00
requirements.txt Update to openstackdocstheme 2017-07-21 08:43:47 +02:00
setup.cfg Support python 3.5 2020-02-13 09:23:06 -06:00
setup.py Update requirements 2016-01-05 08:38:31 +01:00
test-requirements.txt Update hacking for Python3 2020-03-31 06:49:47 +00:00
tox.ini Update hacking for Python3 2020-03-31 06:49:47 +00: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.

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