jul6art/skeleton-bundle

Symfony skeleton bundle

Requirements

• php ^7.4 || ^8.0
• symfony ^4.4 || ^5.0 || ^6.0

Usage

• Download the archive
• Change the bundle name according to your needs with the following updates

Updates

update the composer.json file to define your bundle name, namespace, description, license, author, requirements and autoload

{
    "name": "jul6art/skeleton-bundle",
    "type": "symfony-bundle",
    "description": "Symfony skeleton bundle",
    "homepage": "https://github.com/jul6art/skeleton-bundle",
    "license": "MIT",
    "authors": [
        {
            "name": "Jul6Art",
            "email": "admin@devinthehood.com",
            "homepage": "https://devinthehood.com/"
        }
    ],
    "require": {
        "php": "^7.4",
        "symfony/config": "^4.4 || ^5.0",
        "symfony/dependency-injection": "^4.4 || ^5.0",
        "symfony/http-kernel": "^4.4 || ^5.0"
    },
    "require-dev": {
        "dama/doctrine-test-bundle": "^6.0",
        "phpunit/phpunit": "^7.0",
        "symfony/phpunit-bridge": "^4.4 || ^5.0",
        "symfony/var-dumper": "^4.4 || ^5.0"
    },
    "autoload": {
        "psr-4": {
            "Jul6Art\\SkeletonBundle\\": ""
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Tests\\": "Tests/"
        }
    }
}

rename the SkeletonBundle.php file to YourBundleName and update the namespace according to your composer.json file

// @TODO update the namespace
namespace Jul6Art\SkeletonBundle;

// ...

/**
 * Class SkeletonBundle.
 * 
 * @TODO rename the class with YourBundleName
 */
class SkeletonBundle extends Bundle
{
}

in DependencyInjection/Configuration.php file, update the namespace and the bundle configuration root name

// @TODO update the namespace
namespace Jul6Art\SkeletonBundle\DependencyInjection;

// ...

/**
 * Class Configuration.
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        // @TODO update the bundle configuration root name
        $builder = new TreeBuilder('skeleton');

        // ...

    }
}

rename the DependencyInjection/SkeletonExtension.php file to YourBundleExtension and edit the namespace

// @TODO update the namespace
namespace Jul6Art\SkeletonBundle\DependencyInjection;

// ...

/**
 * Class SkeletonExtension.
 *
 * @TODO rename the class with YourBundleExtension
 */
class SkeletonExtension extends Extension implements PrependExtensionInterface
{
    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        // ...

        // @TODO update the namespace to compile
        $this->addAnnotatedClassesToCompile([
            'Jul6Art\\SkeletonBundle\\',
        ]);
    }

    // ...

}

in phpunit.xml.dist file, update the bundle name

<!-- @TODO update the bundle name in "SkeletonBundle test suite" -->
<testsuite name="SkeletonBundle test suite">
    <directory suffix="Test.php">./Tests</directory>
</testsuite>

Update the README.md file if needed

Deploy (optional)

Deploy your bundle to the final github account and link this repo to packagist so your can now require your bundle globally

# @TODO update the namespace 
composer require jul6art/skeleton-bundle

License

The Skeleton Bundle is open-sourced software licensed under the MIT license.

© 2023 dev in the hood