[Maintenance] Configuration Files Reorganization and Changing Their E…

…xtensions (#460)

| Q               | A
| --------------- | -----
| Branch?         | 2.0
| Bug fix?        | no
| New feature?    | no

README.md

@@ -51,14 +51,6 @@ From Administrator's point of view, every Refund request results in creating two
     bin/console doctrine:migrations:migrate
     ```
 
-1. Install assets:
-
-   Add the following line to your `assets/admin/entrypoint.js` file:
-
-    ```js
-   import '../../vendor/sylius/refund-plugin/assets/entrypoint';
-    ```
-
 1. Run `yarn encore dev` or `yarn encore production`
 
 1. Default configuration assumes enabled PDF file generator. If you don't want to use that feature change your app configuration:

UPGRADE-2.0.md

@@ -24,23 +24,33 @@
        bin/console doctrine:migrations:migrate --no-interaction
    ```
 
-1. The directories structure has been updated to the current Symfony recommendations:
+1. As the assets have been reorganized, you need to update the way you import them in your application.
+   Add the following line to your `assets/admin/entrypoint.js` file:
+
+    ```js
+        import '../../vendor/sylius/refund-plugin/assets/entrypoint';
+    ```
+
+1. The structures of the directories have been updated to follow the current Symfony recommendations:
+   - `@SyliusRefundPlugin/Resources/assets` -> `@SyliusRefundPlugin/assets`
    - `@SyliusRefundPlugin/Resources/config` -> `@SyliusRefundPlugin/config`
    - `@SyliusRefundPlugin/Resources/translations` -> `@SyliusRefundPlugin/translations`
    - `@SyliusRefundPlugin/Resources/views` -> `@SyliusRefundPlugin/templates`
 
    You need to adjust the import of configuration file in your end application:
+
    ```diff
    imports:
    -   - { resource: "@SyliusRefundPlugin/Resources/config/config.yml" }
    +   - { resource: '@SyliusRefundPlugin/config/config.yaml' }
    ```
 
    And the routes configuration paths:
+
    ```diff
-   sylius_refund:
-   -   resource: "@SyliusRefundPlugin/Resources/config/routing.yml"
-   +   resource: "@SyliusRefundPlugin/config/routing.yml"
+       sylius_refund:
+   -       resource: "@SyliusRefundPlugin/Resources/config/routing.yml"
+   +       resource: "@SyliusRefundPlugin/config/routes.yaml"
    ```
 
    Adjust the paths to assets and templates if you are using them.

config/app/config.yml → config/config.yaml

@@ -1,6 +1,6 @@
 imports:
-    - { resource: "@SyliusRefundPlugin/config/app/twig_hooks/**/*.yaml" }
-    - { resource: "@SyliusRefundPlugin/config/app/integrations.php" }
+    - { resource: "@SyliusRefundPlugin/config/twig_hooks/**/*.yaml" }
+    - { resource: "@SyliusRefundPlugin/config/integrations.php" }
 
 parameters:
     sylius_refund.credit_memo_save_path: "%kernel.project_dir%/private/credit_memos/"

config/app/integrations.php → config/integrations.php

@@ -8,6 +8,6 @@
 
 return static function (ContainerConfigurator $configurator, ContainerBuilder $container): void {
     if (class_exists(winzouStateMachineBundle::class)) {
-        $configurator->import('../integrations/winzou_state_machine.yaml');
+        $configurator->import('integrations/winzou_state_machine.yaml');
     }
 };

config/routing.yml → config/routes.yaml

@@ -1,9 +1,9 @@
 sylius_refund_admin:
-    resource: "@SyliusRefundPlugin/config/admin_routing.yml"
+    resource: "@SyliusRefundPlugin/config/routes/admin.yaml"
     prefix: '/%sylius_admin.path_name%'
 
 sylius_refund_shop:
-    resource: "@SyliusRefundPlugin/config/shop_routing.yml"
+    resource: "@SyliusRefundPlugin/config/routes/shop.yaml"
     prefix: /{_locale}
     requirements:
         _locale: ^[a-z]{2}(?:_[A-Z]{2})?$

docs/legacy_installation.md

@@ -19,15 +19,15 @@
 
     ```yaml
     imports:
-        - { resource: "@SyliusRefundPlugin/config/app/config.yml" }
+        - { resource: "@SyliusRefundPlugin/config/config.yaml" }
     ```
-1. Import routing:
+1. Import routes:
 
     ````yaml
-    sylius_refund:
-        resource: "@SyliusRefundPlugin/config/routing.yml"
+   sylius_refund:
+       resource: "@SyliusRefundPlugin/config/routes.yaml"
     ````
-    
+
 1. Apply migrations to your database:
 
     ```bash

ecs.php

@@ -18,7 +18,6 @@
     $containerConfigurator->skip([
         VisibilityRequiredFixer::class => ['*Spec.php'],
         InlineDocCommentDeclarationSniff::class . '.MissingVariable',
-        'src/Resources/config/**',
         '**/var/*',
     ]);
 

phpstan.neon

@@ -12,7 +12,6 @@ parameters:
         - 'src/DependencyInjection/Configuration.php'
 
         # Test dependencies
-        - 'tests/Application/app/**.php'
         - 'tests/Application/src/**.php'
 
     ignoreErrors:

tests/Application/config/packages/sylius_refund.yaml

@@ -1,2 +1,2 @@
 imports:
-    - { resource: "@SyliusRefundPlugin/config/app/config.yml" }
+    - { resource: "@SyliusRefundPlugin/config/config.yaml" }

tests/Application/config/routes.yaml

@@ -1,2 +1,2 @@
 sylius_refund:
-    resource: "@SyliusRefundPlugin/config/routing.yml"
+    resource: "@SyliusRefundPlugin/config/routes.yaml"