Code style enforcement for bash programs.
6a3769e077
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_auto_name to use 'project' as name. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Create separate doc/requirements.txt file and use it, this allows to continue testing with py35 and build docs that require py36. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ic97beaec35ff633380688beb93318273ab6ca15c |
||
|---|---|---|
| .zuul.d | ||
| bashate | ||
| doc | ||
| playbooks/bashate-devstack-master | ||
| releasenotes | ||
| .coveragerc | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .pre-commit-hooks.yaml | ||
| .stestr.conf | ||
| babel.cfg | ||
| bindep.txt | ||
| CONTRIBUTING.rst | ||
| HACKING.rst | ||
| LICENSE | ||
| openstack-common.conf | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
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.
- Free software: Apache license
- Documentation: https://docs.openstack.org/bashate
- Source: https://opendev.org/openstack/bashate/
- Bugs: https://bugs.launchpad.net/bash8
- Release notes: https://docs.openstack.org/releasenotes/bashate/index.html
- Contributing: https://docs.openstack.org/bashate/latest/contributor/index.html
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