A wrapper around symplify/config-transformer used to update recipes and using easy coding standard for generating readable config files.

Alexander Schranz

Last update: Nov 24, 2022

Related tags

Miscellaneous symfony-recipes-yaml-to-php-converter

Overview

Symfony Recipes Yaml to PHP Converter

This is a wrapper around the symplify/config-transformer used to convert Symfony core recipes which uses .yaml config files to .php config files.

It is used in:

To convert the official symfony recipes.

vendor/bin/yaml-to-php [email protected]:symfony/recipes.git
vendor/bin/yaml-to-php [email protected]:symfony/recipes-contrib.git

If you are not converting a recipes repository you should use the symplify/config-transformer directly instead of using this package.

Skeletons

There are currently also 2 skeletons shipped which can be used to create new symfony projects:

symfony/skeleton clone:

schranz/symfony-php-skeleton:

composer create-project schranz/symfony-php-skeleton

symfony/website-skeleton clone:

schranz/symfony-php-website-skeleton:

composer create-project schranz/symfony-php-website-skeleton

Using in exist projects

First convert your project with symplify/config-transformer from .yaml to .php configs after add the following to the composer extra.symfony.endpoint configuration:

    "extra": {
        "symfony": {
            "allow-contrib": false,
            "require": "6.1.*",
            "endpoint": [
                "https://raw.githubusercontent.com/alexander-schranz/symfony-recipes-php/flex/main/index.json",
                "https://raw.githubusercontent.com/alexander-schranz/symfony-recipes-php-contrib/flex/main/index.json",
                "flex://defaults"
            ]
        }
    }

Comments

Create a automatic update process
The repositories need some script which update the current php recipes and regenerate all package from stretch:

Something like

vendor/bin/yaml-to-php [email protected]:symfony/recipes.git # later in the github CI it should push it git add . git commit git push

TODO

[x] Move clone and update of yaml to php file into a converter (is now this repository)

[x] Create Github action to call the script

[x] Push changes to main branch of repositories

help wanted recipes-repositories
opened by alexander-schranz 2
Fix existing CIs for pull request
Currently the CI for pull requests does not work:

https://github.com/alexander-schranz/symfony-recipes-php/pull/2

https://github.com/alexander-schranz/symfony-recipes-php-contrib/pull/2/commits

It seems some secrets are missing, but not sure what need to be configured here.
help wanted
opened by alexander-schranz 1
Convert PHP Array Config to PHP ConfigBuilder

Since Symfony 5.3 there exist a new way of configuring packages. The config builders:

https://symfony.com/blog/new-in-symfony-5-3-config-builder-classes

It would be great as we are currently having done the step from yaml to php configs. To do the next step from PHP array configs to PHP config builder configs.

Not sure how easy possible without knowing the Builder class and only the array this is even possible.
feature

opened by alexander-schranz 5
Convert Comment examples
Currently when converting yaml to php there are 2 types of comments:

# text comments

#example: # comments: []

It would be great depending on # some vs #some convert also commented out yaml configuration into commented out php configuration.

This is blocked by #1 before it can even be targetted we need first support comments in general.
blocked
opened by alexander-schranz 0

Keep / Convert Yaml comments to PHP

Currently the config-transformer is using the symfony/yaml package. Instead we should use a package which is supporting to read comments from yaml files as they provide many usefull things like links to documentation.

Yaml:

# Read the documentation at https://github.com/thephpleague/flysystem-bundle/blob/master/docs/1-getting-started.md
flysystem:
    storages:
        default.storage:
            adapter: 'local'
            options:
                directory: '%kernel.project_dir%/%VAR_DIR%/storage/default'

Expected PHP Result:

<?php

declare(strict_types=1);

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
    // Read the documentation at https://github.com/thephpleague/flysystem-bundle/blob/master/docs/1-getting-started.md
    $containerConfigurator->extension('flysystem', [
        'storages' => [
            'default.storage' => [
                'adapter' => 'local',
                'options' => [
                    'directory' => '%kernel.project_dir%/%VAR_DIR%/storage/default',
                ],
            ],
        ],
    ]);  
};

Currently the comment is missing which adds a lot of value.

Related issues:

https://github.com/symplify/symplify/issues/4274
https://github.com/symfony/symfony/issues/22516

bug help wanted

opened by alexander-schranz 1

Owner

Alexander Schranz

Core Developer @sulu likes @php, @symfony, @elasticsearch, @redis, react js

GitHub

WPForms coding standards are based on the WordPress Coding Standards and the PHPCompatibility Coding Standards and help create strict and high-quality code.

7 Nov 29, 2022

Set of rules for PHP_CodeSniffer and PHP-CS-Fixer used by Symplify projects.

20+ Coding Standard checkers for PHP projects with focus on Clean Architecture

281 Dec 30, 2022

Easy Coding Standard configurations for Craft CMS projects.

Easy Coding Standard config for Craft CMs This package provides Easy Coding Standard configurations for Craft CMS plugins and projects. In general, we

10 Dec 18, 2022

This package provides a set of factories to be used with containers using the PSR-11 standard for an easy Doctrine integration in a project

psr-container-doctrine: Doctrine Factories for PSR-11 Containers Doctrine factories for PSR-11 containers. This package provides a set of factories to

84 Dec 14, 2022

Documentation on clean coding and demonstration of studied clean coding principals with PHP.

practice-php-clean-code Documentation on clean coding and demonstration of studied clean coding principals with PHP. The document contained in this re

1 Feb 21, 2022

SlimJim was born out of a need for a simple auto update script which would update multiple development/test environments every time someone

SlimJim WHY? SlimJim was born out of a need for a simple auto update script which would update multiple development/test environments every time someo

100 Apr 22, 2022

Magento 1.x Coding Standard

Magento Extension Quality Program Coding Standard ⚠️ Versions 3.0.0 and above of the MEQP Coding Standard are for Magento 1.x code only. To check Mage

224 Nov 29, 2022

Magento Coding Standard

Magento Coding Standard A set of Magento rules for PHP_CodeSniffer tool. Installation within a Magento 2 site To use within your Magento 2 project you

290 Dec 31, 2022

Provide CSV, JSON, XML and YAML files as an Import Source for the Icinga Director and optionally ship hand-crafted additional Icinga2 config files

Icinga Web 2 Fileshipper module The main purpose of this module is to extend Icinga Director using some of it's exported hooks. Based on them it offer

25 Sep 18, 2022

WordPlate is a wrapper around WordPress. It makes developers life easier. It is just like building any other WordPress website with themes and plugins. Just with sprinkles on top.

WordPlate is simply a wrapper around WordPress. It makes developers life easier. It is just like building any other WordPress website with themes and plugins. Just with sprinkles on top.

1.7k Dec 24, 2022

A wrapper around symplify/config-transformer used to update recipes and using easy coding standard for generating readable config files.

Related tags

Overview

Symfony Recipes Yaml to PHP Converter

Skeletons

Using in exist projects

Comments

Create a automatic update process

TODO

Fix existing CIs for pull request

Convert PHP Array Config to PHP ConfigBuilder

Convert Comment examples

Keep / Convert Yaml comments to PHP

Owner

Alexander Schranz

WPForms coding standards are based on the WordPress Coding Standards and the PHPCompatibility Coding Standards and help create strict and high-quality code.

Set of rules for PHP_CodeSniffer and PHP-CS-Fixer used by Symplify projects.

Easy Coding Standard configurations for Craft CMS projects.

This package provides a set of factories to be used with containers using the PSR-11 standard for an easy Doctrine integration in a project

Documentation on clean coding and demonstration of studied clean coding principals with PHP.

SlimJim was born out of a need for a simple auto update script which would update multiple development/test environments every time someone

Magento 1.x Coding Standard

Magento Coding Standard

Provide CSV, JSON, XML and YAML files as an Import Source for the Icinga Director and optionally ship hand-crafted additional Icinga2 config files

WordPlate is a wrapper around WordPress. It makes developers life easier. It is just like building any other WordPress website with themes and plugins. Just with sprinkles on top.

Optimizes class loading performance by generating a single PHP file containing all of the autoloaded files.

Cookbook-magento - Collection of recipes to build app stack for the Magento deployments with Chef

Helper plugin to install SilverStripe recipes

Repository containing all the PHPStan rules from the book "Recipes for Decoupling"

This is a simple Wrapper around the ZipArchive methods with some handy functions

This is a simple Wrapper around the ZipArchive methods with some handy functions

A wrapper around faker for factory muffin

An object oriented wrapper around PHP's built-in server.

A PHP wrapper around Libreoffice for converting documents from one format to another.