TUTORIAL.md

Tutorial

Getting started

pcg installs itself virally; once run in a git repository, it sets itself up to be run automatically via git hooks on commit and on push. You only need to do something if you want to tweak its default behavior.

That's it! Start coding!

Removing

export FOO="$(git rev-parse --git-dir)"
rm "${FOO}/hooks/pre-commit" "${FOO}/hooks/pre-push"
export -n FOO

Configuration

See the full configuration page for the full details.

Getting started with configuration

First generate the default version with:

pcg writeconfig

then edit this file as needed by adding, removing checks and ignoring more files. See the configuration file location to know where to put this file, if you do not want to commit it in your repository.

Forcing update for clients

pcg refuses to load a file if its version is less than what is specified by min_version. So to force all the contributors to upgrade to the current version, use the following command to forcibly reset min_version to the current version:

pcg writeconfig

Test with -race

To run tests with -race but only short test to reduce the amount of time taken to push but runs more on CI, use:

modes:
  pre-push:
    check:
    - test:
      - extra_args:
        - -race
        - -short
  continuous-integration:
    check:
    - test:
      - extra_args:
        - -race

This permits to get an assurance that tests expose any race condition as found by the race detector. In mode continous-integration, the same check can be used but without the -short flag.

Tests that shouldn't be run ever in -race mode because they are unacceptably slow can be migrated in a file with the following statement:

// +build !race

When a test is looping over itself, it is also possible to migrate the constant to a single source file so the constant can be fine tuned when using or not the race detector.