cytopia/awesome-ci

Lot's of tools for git, file and static source code analysis.

awesome-ci

, _(*1)

:warning: DEPRECATION WARNING

This repository is deprecated. Please use the following docker images below instead:, _(*2)

All #awesome-ci Docker images

ansible-lint • ansible • awesome-ci • bandit • black • checkmake • eslint • file-lint • gofmt • goimports • golint • jsonlint • kubeval • linkcheck • mypy • php-cs-fixer • phpcbf • phpcs • phplint • pycodestyle • pydocstyle • pylint • terraform-docs • terragrunt-fmt • terragrunt • yamlfmt • yamllint, _(*3)

Docker images

Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite linter below for reproducible local or remote CI tests:, _(*4)

GitHub	DockerHub	Type	Description
awesome-ci	![aci-hub-img]	Basic	Tools for git, file and static source code analysis
file-lint	![flint-hub-img]	Basic	Baisc source code analysis
linkcheck	![linkcheck-hub-img]	Basic	Search for URLs in files and validate their HTTP status code
ansible	![ansible-hub-img]	Ansible	Multiple versions and flavours of Ansible
ansible-lint	![alint-hub-img]	Ansible	Lint Ansible
gofmt	![gfmt-hub-img]	Go	Format Go source code [1]
goimports	![gimp-hub-img]	Go	Format Go source code [1]
golint	![glint-hub-img]	Go	Lint Go code
eslint	![elint-hub-img]	Javascript	Lint Javascript code
jsonlint	![jlint-hub-img]	JSON	Lint JSON files [1]
kubeval	![kubeval-hub-img]	K8s	Lint Kubernetes files
checkmake	![cm-hub-img]	Make	Lint Makefiles
phpcbf	![pcbf-hub-img]	PHP	PHP Code Beautifier and Fixer
phpcs	![pcs-hub-img]	PHP	PHP Code Sniffer
phplint	![plint-hub-img]	PHP	PHP Code Linter [1]
php-cs-fixer	![pcsf-hub-img]	PHP	PHP Coding Standards Fixer
bandit	![bandit-hub-img]	Python	A security linter from PyCQA
black	![black-hub-img]	Python	The uncompromising Python code formatter
mypy	![mypy-hub-img]	Python	Static source code analysis
pycodestyle	![pycs-hub-img]	Python	Python style guide checker
pydocstyle	![pyds-hub-img]	Python	Python docstyle checker
pylint	![pylint-hub-img]	Python	Python source code, bug and quality checker
terraform-docs	![tfdocs-hub-img]	Terraform	Terraform doc generator (TF 0.12 ready) [1]
terragrunt	![tg-hub-img]	Terraform	Terragrunt and Terraform
terragrunt-fmt	![tgfmt-hub-img]	Terraform	terraform fmt for Terragrunt files [1]
yamlfmt	![yfmt-hub-img]	Yaml	Format Yaml files [1]
yamllint	![ylint-hub-img]	Yaml	Lint Yaml files

^[1] Uses a shell wrapper to add enhanced functionality not available by original project., _(*5)

, _(*6)

Runs on, _(*7)

, _(*8)

Continuous Integration command line tools for git repositories, file characteristics, syntax errors and static source code analysis., _(*9)

Awesome-CI is capable of finding various problems in your code repository as well as fixing them automatically., _(*10)

Table of Contents, _(*11)

1. Tools
2. Learn / Validate
3. Fix
4. Custom regex contributions
5. General usage
6. Installation
   1. Requirements
   2. Install OSX
   3. Install Linux/BSD
7. Awesome CI Docker image
8. Documentation
9. License

Tools

All checks have the option to only check by one or more file extensions, by shebang as well as to exclude one or more folders from the whole search., _(*12)

Note: Fixable options are currently in testing phase. Please report any bugs., _(*13)

Learn / validate

All of the above scripts offer the --dry option which will only show you the built command without actually executing it:, _(*14)

$ regex-grep --path=. --ignore=".git,.svn" --shebang=sh --size --text \
--custom="if[[:space:]]*\[\[" --dry

find . -type f -not \( -path "./.git*" -o -path "./.svn*" \) ! -size 0 -print0 | \
   xargs -0 -P 8 -n1 grep -Il '' | \
   tr '\n' '\0' | \
   xargs -0 -P 8 -n1 awk '/^#!.*(\/sh|[[:space:]]+sh)/{print FILENAME}' | \
   tr '\n' '\0' | \
   xargs -0 -P 8 -n1  sh -c 'if [ -f "${1}" ]; then grep --color=always -inHE "if[[:space:]]*\[\[" "$1" || true; fi' --

Fix

Some of the above scripts offer the --fix option (see table above), with which you are actually able to fix the problem. You can also combine it with --dry to see how the actual fix command looks like:, _(*15)

$ file-utf8 --path=dump.sql --fix --dry

find dump.sql -type f -print0 | \
   xargs -0 -P 8 -n1  sh -c 'if [ -f "${1}" ]; then isutf8 "$1" >/dev/null || (TERM=vt100 vi -u NONE -n -es -c "set fileencoding=utf8" -c "wq" "$1" > /dev/tty && echo "Fixing: $1" || echo "FAILED: $1"); fi' --

Custom regex contributions

regex-grep and regex-perl have a lot of potential for doing custom project validation., _(*16)

In order to give you an idea, have a look at the compiled Regex Contributions., _(*17)

Please use pull requests to add useful checks., _(*18)

General Usage

• All tools share the same pattern (except git-ignored) and can be used with the same command line arguments.
• Some tools have an additional option --custom="" to overwrite the command itself (this is explained and shown in detail in each command's --help option).

Options:, _(*19)

# Required:
  --path            # Specify the path where to scan

# Optional pattern (each option is logically and-ed):
  --fix             # Fix the problems for the specified files (not every check)

  --text            # Only scan non-binary files
  --size            # Only scan non-empty files (greater 0 bytes)
  --shebang         # Only scan files (shell scripts) that match a certain shebang
  --extension       # Only scan files with these file extensions
  --ignore          # Ignore files/folders

# Optional misc:
  --config          # Specify configuration file
  --confpre         # Alter configuration directive prefix for this check
  --verbose         # Show files and commands as being processed
  --debug           # Show additional debug messages
  --list            # Only show files that would be processed (no processing)
  --dry             # Show command that would be executed (no processing)

# System
  --help            # Show help
  --info            # Show version of required binaries
  --version         # Show tool version

Installation

Requirements

Awesome-ci requires the following tools to be installed:, _(*20)

• dos2unix
• eslint
• file
• git
• jsonlint
• mdl
• perl
• php
• python
• ruby
• scss_lint
• shellcheck

Install OSX

brew tap cytopia/tap
brew install awesome-ci

Install Linux/BSD

# Install to /usr/bin
./configure
make install

# Instal to /usr/local/bin
./configure --prefix=/usr/local
make install

# Install to /opt/bin
./configure --prefix=/opt
make install

Awesome CI Docker image

, _(*21)

Instead of installing awesome-ci and all its required dependencies locally on your computer, you can also use the bundled Docker image cytopia/awesome-ci which has everything pre-installed and is built nightly by travis-ci., _(*22)

docker run -v ${PWD}:/ac cytopia/awesome-ci file-crlf --path=/ac

The above example is using file-crlf to scan the current directory for files containing Windows newlines:, _(*23)

• ${PWD} (the current host directory) is mounted into the container's /ac directoy
• file-crlf path then points (inside the container) to /ac (which is the current host directory)
• /ac can actually be named by whatever name you want

If you use an awesome-ci configuration which is not inside the directory you want to check, you will also have to mount that into the container:, _(*24)

docker run \
    -v /host/path/to/awesome-ci.conf:/etc/awesome-ci.conf \
    -v ${PWD}:/ac cytopia/awesome-ci file-crlf --path=/ac --config=/etc/awesome-ci.conf

Documentation

To find out more about awesome-ci, have a look at the following links., _(*25)

• Dependencies
• Examples
• Regex Contributions

License

MIT License, _(*26)

Copyright (c) 2018 cytopia, _(*27)