https://github.com/activecollab/baseline
Building blocks for automatic code quality checks during development
https://github.com/activecollab/baseline
Last synced: about 1 year ago
JSON representation
Building blocks for automatic code quality checks during development
- Host: GitHub
- URL: https://github.com/activecollab/baseline
- Owner: activecollab
- Created: 2019-06-05T04:30:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-21T11:54:21.000Z (over 2 years ago)
- Last Synced: 2025-04-01T23:17:13.324Z (about 1 year ago)
- Language: PHP
- Homepage: https://activecollab.com
- Size: 101 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ActiveCollab Baseline
## Checking Code Quality
### Checks
Checks are grouped into two groups:
1. Fixers - they check and modify the code. Modified files are automatically staged,
2. Analyzers - they check the code, perform analysis without changing the code.
Intnetion for this type of separation is to clearly communicate what user can expect from a particular check.
### Running Checks Before each Commit
In order to add quality code checker as mandatory step prior to code being committed, you can use `pre-commit` hook. Open:
```bash
vi .git/hooks/pre-commit
```
and put:
```php
#!/usr/bin/php
check();
} catch (\Throwable $e) {
$quality_checker->communicateFailure($e);
exit(1);
}
} else {
print "Quality checker not found at {$qc_file_path}\n";
}
exit(0);
```
Don't forget to set `pre-commit` hook as executable:
```bash
chmod +x .git/hooks/pre-commit
```