https://github.com/mteu/docblock-rules
Simple PHPStan rules extension to verify whether the PHP files contain certain pre-defined strings.
https://github.com/mteu/docblock-rules
phpstan phpstan-extension
Last synced: 10 months ago
JSON representation
Simple PHPStan rules extension to verify whether the PHP files contain certain pre-defined strings.
- Host: GitHub
- URL: https://github.com/mteu/docblock-rules
- Owner: mteu
- License: gpl-3.0
- Created: 2023-04-12T12:08:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T01:51:58.000Z (10 months ago)
- Last Synced: 2025-04-13T03:57:41.142Z (10 months ago)
- Topics: phpstan, phpstan-extension
- Language: PHP
- Homepage:
- Size: 373 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/mteu/docblock-rules/actions/workflows/cgl.yaml)
[](https://github.com/mteu/docblock-rules/actions/workflows/tests.yaml)
# DocBlock Rules
**DocBlock Rules** is simple [PHPStan](https://github.com/phpstan/phpstan) rules extension to verify whether the PHP files
contain certain pre-defined strings.
## ⚡ Usage
Require this package and make sure to configure PHPStan according to your needs by putting a configuration file in your project
(e.g. as `phpstan.neon` file in your package root.)
```bash
composer require --dev mteu/docblock-rules
```
If you're using the [`phpstan/extension-installer`](https://github.com/phpstan/extension-installer) you're good to go.
## Configuration
This package ships custom rules that need additional configuration:
* [`RequireCopyrightInformationInFirstCommentRule`](#RequireCopyrightInformationInFirstCommentRule)
* [`RequireLicenseInformationInFirstCommentRule`](#RequireLicenseInformationInFirstCommentRule)
### [`RequireCopyrightInformationInFirstCommentRule`](src/Rules/RequireCopyrightInformationInFirstCommentRule.php)
This rule checks whether there is a PHPDoc comment block present that contains copyright information
identified by a needle string in the PHPStan configuration.
#### Sample configuration:
```neon
# phpstan.neon
parameters:
docblock:
copyrightIdentifier: 'Copyright (C) 2023'
```
### [`RequireLicenseInformationInFirstCommentRule`](src/Rules/RequireLicenseInformationInFirstCommentRule.php)
This rule checks whether there is a PHPDoc comment block present that contains license information. You
can use pre-defined license checks values or define a custom string that is being looked for.
#### Sample configuration:
```neon
# phpstan.neon
parameters:
docblock:
# Pre-configured checks when applying 'GPL-2.0' or 'GPL-3.0' as value.
# Alternatively, use a custom string to look for in the file.
requiredLicenseIdentifier: 'GPL-3.0'
```
## 💛 Acknowledgement
I'm very grateful for the good people that created, maintain and sponsor [PHPStan](https://github.com/phpstan/phpstan). Děkuji, [Ondřej](https://github.com/ondrejmirtes)
and everyone who has contributed!
## ⭐ License
This project is licensed under [GNU General Public License 3.0 (or later)](LICENSE).