openstack/bashate
Code Issues Proposed changes
Code style enforcement for bash programs.
161 Commits 1 Branch 14 Tags 1.6 MiB
Python 90.5%
Shell 9.5%
e82b4e1337
Go to file
Masayuki Igawa e82b4e1337
Remove pylintrc file 
This commit removes the pylintrc file. The pylint requirement was
removed 4 years ago[0] and we don't use it now. So, we can remove this
rc file safely.

[0] https://review.opendev.org/#/c/150816/

Change-Id: If032e7a345d5a612fbaaa6850e880c2a8601e718
2019-06-26 10:40:08 +09:00
.zuul.d Dropping the py35 testing 2019-04-22 03:23:16 +00:00
bashate Switch to pep8 output format 2018-07-18 22:30:59 +00:00
doc/source Address new pypi requirements on README.rst 2018-07-19 13:04:51 +10:00
playbooks/legacy/bashate-devstack OpenDev Migration Patch 2019-04-19 19:26:29 +00:00
releasenotes Switch to pep8 output format 2018-07-18 22:30:59 +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
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
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
openstack-common.conf the great rename of bash8 -> bashate 2014-06-20 16:41:12 -04:00
README.rst Address new pypi requirements on README.rst 2018-07-19 13:04:51 +10:00
requirements.txt Update to openstackdocstheme 2017-07-21 08:43:47 +02:00
setup.cfg Dropping the py35 testing 2019-04-22 03:23:16 +00:00
setup.py Update requirements 2016-01-05 08:38:31 +01:00
test-requirements.txt Use stestr as a test runner 2019-06-24 16:30:27 +09:00
tox.ini Merge "Dropping the py35 testing" 2019-06-25 13:36:29 +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