This is useful to ensure that all authors (from git history) mentioned in all PHP files, the composer.json,
bower.json and packages.json.
Add to your composer.json in the require-dev section:
"phpcq/author-validation": "~1.0"
Call the binary:
./vendor/bin/check-author.php
Optionally pass a path to check:
./vendor/bin/check-author.php /path/to/some/repository/also/with/subdir
Optionally you can pass the path to a config file (defaults to .check-author.yml) which shall be used.
# Example .check-author.yml
# Map multiple authors to a single one (aliasing of contributors).
mapping:
# original: alias
"John Doe <[email protected]>": "John Doe <[email protected]>"
# or original: [multiple aliases]
"John Doe <[email protected]>": ["John Doe <[email protected]>", "Acme Inc <[email protected]>"]
# or
"John Doe <[email protected]>":
- "John Doe <[email protected]>"
- "Acme Inc <[email protected]>"
# Ignore commits from these authors (equivalent to cmd line parameter --ignore=...)
ignore:
- Build Bot <[email protected]>
# If present, scan only these and not the whole base dir (equivalent to cmd line arguments).
# Values must either be absolute paths or relative to the current directory.
include:
- src
# Paths to exclude from scanning (equivalent to cmd line parameter --exclude=...)
exclude:
- Foo.php
- /tests/*
- */languages
# Enforce copy-left author for certain files.
copy-left:
"John Doe <[email protected]>": "/library"
# or
"John Doe <[email protected]>": ["/library", "File.php"]
# or
"John Doe <[email protected]>":
- "File.php"
# Add additional author metadata. It is used by some comparator handlers when outputting diff format.
# Author metadata of the config file is prioritized over extracted metadata from the files.
metadata:
"John Doe <[email protected]>":
role: "Translator"
homepage: "http:/www.example.org"