To use the rubocop config in a project create a .rubocop.yml file in the base directory with:
inherit_from: https://raw.githubusercontent.com/BCCRiskAdvisory/edgecop/main/edgecop.yml
This file contains configuration for two optional gems - rubocop-performance
and rubocop-rails
.
If these don't apply to your project you can inherit only the parts you want. The below would be suitable for a plain ruby project:
inherit_from:
- https://raw.githubusercontent.com/BCCRiskAdvisory/edgecop/main/edgecop-core.yml
- https://raw.githubusercontent.com/BCCRiskAdvisory/edgecop/main/edgecop-performance.yml
To ensure the cached rubocop file will be ignored to the .gitignore file add
/.rubocop-https*
This repo provides a setup script for gitcop. Copy the following command into your terminal:
curl https://raw.githubusercontent.com/BCCRiskAdvisory/edgecop/main/gitcop_setup.sh | bash -s
This setup script will populate new repos with you initialize/clone with the git hooks found in your git-template directory. If you want git hooks to run on existing repos, you'll need to cd to the repo directory and run git-init
.