Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/einenlum/php-stack-detector
A package to detect the PHP stack used by a project
https://github.com/einenlum/php-stack-detector
composer php
Last synced: 8 days ago
JSON representation
A package to detect the PHP stack used by a project
- Host: GitHub
- URL: https://github.com/einenlum/php-stack-detector
- Owner: Einenlum
- License: mit
- Created: 2023-10-13T11:02:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-06T15:24:58.000Z (about 1 year ago)
- Last Synced: 2024-12-24T00:15:34.257Z (16 days ago)
- Topics: composer, php
- Language: PHP
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Stack Detector
This library allows to easily detect the PHP stack (Wordpress, Laravel, Symfony…) and the version used, when parsing a directory or ar Github remote repository.
Supported Stacks for now:
- Wordpress
- Laravel
- Symfony
- Statamic
- Craft CMS
## Install
```
composer require einenlum/php-stack-detector
```
## Usage
```php
create();
$stack = $detector->getStack('/path/to/a/symfony/directory');
$stack->type === StackType::SYMFONY;
$stack->version; // 5.4
$stack = $detector->getStack('/path/to/an/unknown/symfony/version/directory');
$stack->type === StackType::SYMFONY;
$stack->version; // null
$stack = $detector->getStack('/path/to/an/unknown/stack/directory');
$stack; // null
// For Github usage
$factory = new GithubDetectorFactory();
$detector = $factory->create();
$stack = $detector->getStack('symfony/demo');
$stack->type === StackType::SYMFONY;
$stack->version; // 6.3.0
// You can also pass an already authenticated Github Client
$client = new \Github\Client();
$client->authenticate('some_access_token', null, \Github\AuthMethod::ACCESS_TOKEN);
$detector = $factory->create();
$stack = $detector->getStack('einenlum/private-repo');
$stack->type === StackType::SYMFONY;
$stack->version; // 6.3.0
```
You can also use the CLI to test it.
```
php bin/detect-local.php ~/Prog/php/my_project/
Detected stack: laravel
Version: 10.19.0
php bin/detect-github.php 'symfony/demo'
Detected stack: symfony
Version: 6.3.0
```
It is advised to use an access token for github parsing, to either access private repositories or avoid reaching Github API limit.
```
GITHUB_ACCESS_TOKEN=my_token php bin/detect-github.php 'einenlum/private-repo'
Detected stack: laravel
Version: 10.19.0
```
### Usage with Symfony
Declare the factory and the detector in your `services.yaml` file.
For Github:
```yaml
services:
Einenlum\PhpStackDetector\Factory\GithubDetectorFactory: ~
Einenlum\PhpStackDetector\Detector:
factory: ['@Einenlum\PhpStackDetector\Factory\GithubDetectorFactory', 'create']
arguments:
$client: '@Github\Client'
```
For local filesystem:
```yaml
services:
Einenlum\PhpStackDetector\Factory\FilesystemDetectorFactory: ~
Einenlum\PhpStackDetector\Detector:
factory: ['@Einenlum\PhpStackDetector\Factory\FilesystemDetectorFactory', 'create']
```
## Tests
```
composer run test
```
## Contribute
Each stack has its own Detector implementing a [StackDetectorInterface](src/StackDetectorInterface.php).
If the stack uses composer you can use the [PackageVersionProvider](src/Composer/PackageVersionProvider.php) class.
This will use a [ComposerConfigProvider](src/Composer/ComposerConfigProvider.php) to get the lock or the json config.
All of them use an Adapter, that is for now either [FilesystemAdapter](src/DirectoryCrawler/FilesystemAdapter.php) or [GithubAdapter](src/DirectoryCrawler/GithubAdapter.php)
You can add your own StackDetector and then add it to the `getStackDetectors` method of the [HasStackDetectors](src/Factory/HasStackDetectors.php) trait.
Any Pull Request welcome!