Style Guide

These are the coding style conventions we adhere to.

Installation

docker compose build runner

Create a .rubocop.yml in every repository with this content:

echo "inherit_from: https://raw.githubusercontent.com/bukowskis/style-guide/master/rubocop.yml" > .rubocop.yml

Copy .scss-lint.yml to your code repository it in sync with this repository. And wait for prontolabs/pronto-scss#6 to be solved.

# Provided your current directory is this repository
cp scss-lint.yml PATH/TO/YOUR/CODE/REPO/.scss-lint.yml

Copy .slim-lint.yml to your $HOME directory and keep it in sync with this repository.

# Provided your current directory is this repository
cp slim-lint.yml ~/.slim-lint.yml

Usage

In your feature branch, simply run the following command to run the linters an all code changes compared to master.

~/Projects/style-guide/bin/pronto run

# You can also just run one type of linter
~/Projects/style-guide/bin/pronto run -r rubocop
~/Projects/style-guide/bin/pronto run -r scss

If you have not commited your changes yet, you can use the following command to lint all files that have changed compared to HEAD.

~/Projects/style-guide/bin/pronto run --index