Note: These are a work in progress.

• python 2.7

• pre-commit

$ git clone https://github.com/clukawski/cl-githooks
$ cd cl-githooks
$ cp /path/to/{hookname} /path/to/project/.git/hooks/{hookname}
$ chmod +x /path/to/project/.git/hooks/{hookname}

This hook will make various checks to your file changes before you commit. You'll want to edit the hookconfig dictionary in main() to the tools/language you are using.

Currently the linter/unit test checks only support one language/tool each, will add support for multiple passes per check later.

• warnfiles:

  • list of files you want warnings when committing changes to

• linters: Linter settings

  • list of dictionaries: one for each linter/syntax/checker tool
    • extension: file extension for the linter to use
    • executable: linter executable
    • arguments: arguments to pass to the linter
    • errout: show tool stderr output (some tools will print to stderr instead of stdout)
      • set to True or False: default False
    • showout: dump raw output
      • set to True or False: default False

• testing: Unit testing settings

  • executable: unit test tool executable
  • arguments: arguments to pass to the tool
  • testoutput: show unit test tool output
    • set to True or False

• checks: List of enabled checks

  • lint_files: use the linter check
  • warn_files: use the file warning check
  • test_files: use unit test check

    hookconfig = {
        'warnfiles': [
            'src/test.php',
        ],
        'linters': [
            {
                'executable': 'php',
                'extension': '.php',
                'arguments': [
                    '-l'
                ],
                'errout': False,
                'showout': False
            },
            {
                'executable': 'clang',
                'extension': '.c',
                'arguments': [
                    '-fsyntax-only',
                    '-Wall',
                    '-Werror'
                ],
                'errout': True,
                'showout': False
            }
        ],
        'testing': {
            'executable': 'phpunit',
            'arguments': [
                '-v'
            ],
            'testoutput': True
        },
        'checks': [
            'lint_files',
            'warn_files',
            'test_files'
        ]
    }