chiron/package-discovery

Composer Scripts for Chiron Framework Package Auto Discvery

2.3 2019-08-03 17:12 UTC

Requires

• php: ^7.1
• composer-plugin-api: ^1.0

Requires (Dev)

• composer/composer: ^1.7.2
• phpstan/phpstan: ^0.9.2
• phpunit/phpunit: ^7.0

MIT

• framework
• package
• auto
• discovery
• discover
• chiron
• autodiscovery

README

Chiron Package Discovery

Basic Composer script to allow package discovery for the Chiron micro framework.

Installation

1. Run

   $ composer require chiron/package-discovery
   

2. Add service provider to config/container.php.

   'providers' => [
       ...
       Chiron\PackageDiscovery\PackageDiscoveryServiceProvider::class,
   ],

3. Make sure your package's composer.json file as below

"extra": {
    "chiron": {
        "providers": [
            "Chiron\\Debugbar\\ServiceProvider"
        ]
    }
}

Helpers

The ComposerScripts class also implements a static method postCreateProject() that can be called after a Chiron project is created, through the post-create-project-cmd composer script. A similar method exists for running tasks after each composer install call, which is postInstall(). These methods allow to run other ComposerScripts class methods like setPermission() or generateApplicationKey(), depending on the corresponding parameters set in the extra section of the composer.json file. For example,

{
    "name": "chiron/skeleton",
    "type": "project",
    ...
    "extra": {
        "post-create-project-cmd": {
            "copyFiles": [
                {
                    "config/templates/console-local.php": "config/console-local.php",
                    "config/templates/web-local.php": "config/web-local.php",
                    "config/templates/db-local.php": "config/db-local.php",
                    "config/templates/cache.json": ["runtime/cache.json", true]
                }
            ],
            "generateApplicationKey": [
                "config/web-local.php"
            ]
        },
        "post-install-cmd": {
            "setPermission": [
                {
                    "runtime": "0777",
                    "web/assets": "0777",
                    "chiron": "0755"
                }
            ]
        }
    }
}