Getting Started

Minimal Setup

Installation:

composer require hiqdev/hidev-php

Add to your composer.json under extra:

"hidev": {
    "plugins": ["hiqdev/hidev-php"]
}

First Use Case: Run the default install goal to scaffold your project:
```
vendor/bin/hidev install
```
This generates:
- .gitignore
- LICENSE (via hidev-license)
- composer.json updates (via hidev-composer)
- Basic PHP-CS-Fixer and PHPUnit configs.
Key Files to Review:
- .hidev/config.php (main configuration)
- composer.json (updated with HiDev goals)
- php-cs-fixer.dist.php (if generated)

Implementation Patterns

Core Workflows

Project Scaffolding: Use hidev install to bootstrap a new project with:
```
vendor/bin/hidev install --goal=all
```
Goals include:
- gitignore: Generates .gitignore for PHP projects.
- license: Adds a LICENSE file (default: BSD-3-Clause).
- composer: Updates composer.json with HiDev-specific configs.
- php-cs-fixer: Configures PSR-2 coding standards.
- phpunit: Sets up PHPUnit for testing.
- travis: Adds Travis CI configuration.
- phpstan: Enables static analysis (added in v0.6.2).
Daily Development:
- Code Quality: Run PHP-CS-Fixer interactively:
```
vendor/bin/php-cs-fixer fix --dry-run --diff
```
  Integrate PHPStan into your workflow:
```
vendor/bin/hidev phpstan
```
- Testing: Execute PHPUnit tests with:
```
vendor/bin/hidev phpunit
```
CI/CD Integration:
- Travis CI is preconfigured to run:
  - PHPUnit tests.
  - PHP-CS-Fixer checks.
  - PHPStan analysis.
- Scrutinizer is set up for coverage reporting (via hidev-scrutinizer).

Customization: Extend the default configuration in .hidev/config.php:

return [
    'components' => [
        'php-cs-fixer' => [
            'class' => 'hidev\phpcs\PhpCsFixer',
            'config' => __DIR__ . '/php-cs-fixer.dist.php',
            'rules' => ['@PSR2', '--path-mode=intersection'],
        ],
        'phpstan' => [
            'class' => 'hidev\phpstan\PhpStan',
            'config' => __DIR__ . '/phpstan.neon',
            'level' => 5,
        ],
    ],
];

Generating Classes: Use the gen command to create boilerplate classes:
```
vendor/bin/hidev gen Class --name=MyClass --namespace=App\Models
```

Laravel-Specific Tips

Laravel Compatibility:

Override the default composer.json scripts to integrate with Laravel’s tooling:

"scripts": {
    "test": "phpunit",
    "cs-fix": "php-cs-fixer fix",
    "phpstan": "phpstan analyse src --level=5"
}

Exclude Laravel-specific directories (e.g., storage/, bootstrap/) from PHP-CS-Fixer:

'rules' => ['@PSR2', '--path-mode=intersection', '--exclude=storage/,bootstrap/'],

Artisan Integration: Create a custom Artisan command to trigger HiDev goals:
```
php artisan hidev:install
```
(Requires extending the hidev command class.)

Environment-Specific Configs: Use Laravel’s environment files to conditionally enable HiDev goals:

// .hidev/config.php
'goals' => [
    'install' => [
        'gitignore' => true,
        'license' => env('APP_ENV') !== 'local',
        'php-cs-fixer' => true,
    ],
],

Gotchas and Tips

Pitfalls

HiDev Dependency:
- Error: Class 'hidev\StartController' not found.
- Fix: Ensure HiDev is installed globally or as a project dependency:
```
composer global require hiqdev/hidev
```
- Workaround: Use the hidev CLI directly if the package isn’t properly integrated.
Outdated Configurations:
- Issue: Travis CI or Scrutinizer configs may reference deprecated PHP versions (e.g., PHP 5.6).
- Fix: Update .travis.yml or .scrutinizer.yml manually to support newer PHP versions (e.g., 8.0+).
- Example:
```
# .travis.yml
php:
  - 8.0
  - 8.1
```
PHP-CS-Fixer Conflicts:
- Problem: Disabled fixers (e.g., return, empty_return) may cause unexpected behavior if re-enabled.
- Tip: Review php-cs-fixer.dist.php and adjust rules incrementally:
```
return PhpCsFixerConfig::create()
    ->setRules([
        '@PSR2' => true,
        'return' => false, // Re-enable if needed
    ]);
```
PHPStan Level Mismatch:
- Warning: Default PHPStan level is 5 (strict). Lower it for legacy codebases:
```
'phpstan' => [
    'level' => 3, // Less strict
],
```
Goal Execution Order:
- Gotcha: Some goals (e.g., license) may overwrite existing files silently.
- Tip: Use --dry-run to preview changes:
```
vendor/bin/hidev install --dry-run
```
Vendor Directory Exclusion:
- Issue: PHP-CS-Fixer may fail if vendor/ is not excluded.
- Fix: Ensure the config includes:
```
'rules' => ['@PSR2', '--exclude=vendor/'],
```

Debugging Tips

Verbose Output: Enable debug mode for HiDev commands:
```
vendor/bin/hidev install --verbose
```

Log Configuration: Add logging to .hidev/config.php:

'components' => [
    'log' => [
        'class' => 'yii\log\FileTarget',
        'logFile' => __DIR__ . '/hidev.log',
    ],
],

Isolated Testing: Test HiDev goals in a temporary directory:

mkdir /tmp/hidev-test && cd /tmp/hidev-test
composer init
composer require hiqdev/hidev-php
vendor/bin/hidev install

Extension Points

Custom Goals: Extend HiDev by creating a custom plugin. Example:

// CustomPlugin.php
namespace App\Hidev;

use hidev\BasePlugin;

class CustomPlugin extends BasePlugin {
    public function init() {
        $this->goal('custom-goal')->action(function() {
            // Custom logic here
        });
    }
}

'plugins' => [
    'App\Hidev\CustomPlugin',
],

Dynamic Configs: Load configurations dynamically based on environment variables:

'php-cs-fixer' => [
    'config' => env('HIDEV_PHP_CS_FIXER_CONFIG') ?: __DIR__ . '/php-cs-fixer.dist.php',
],

Pre/Post Actions: Hook into HiDev’s lifecycle with onBeforeAction and onAfterAction:

'components' => [
    'eventDispatcher' => [
        'class' => 'yii\base\EventDispatcher',
        'onBeforeAction' => ['App\Hidev\EventHandler', 'beforeAction'],
    ],
],

Laravel-Specific Gotchas

Service Provider Conflicts:

Issue: HiDev’s composer.json scripts may conflict with Laravel’s.

Fix: Merge scripts in composer.json:

"scripts": {
    "post-install-cmd": [
        "@php artisan hidev:install",
        "Illuminate\\Foundation\\ComposerScripts::postInstall",
        "@php artisan package:discover --

Hidev Php Laravel Package