bastienguesdon/plugin-rm-route

Acme example plugin for Sylius.

dev-master / 1.8.x-dev 2020-11-16 14:49 UTC

Requires

• php: ^7.4
• sylius/sylius: ^1.0

Requires (Dev)

• behat/behat: ^3.6.1
• behat/mink-selenium2-driver: ^1.4
• dmore/behat-chrome-extension: ^1.3
• dmore/chrome-mink-driver: ^2.7
• friends-of-behat/mink: ^1.8
• friends-of-behat/mink-browserkit-driver: ^1.4
• friends-of-behat/mink-extension: ^2.4
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.1
• friends-of-behat/variadic-extension: ^1.3
• lakion/mink-debug-extension: ^1.2.3
• phpspec/phpspec: ^6.1
• phpstan/extension-installer: ^1.0
• phpstan/phpstan: 0.12.25
• phpstan/phpstan-doctrine: 0.12.13
• phpstan/phpstan-strict-rules: ^0.12.0
• phpstan/phpstan-webmozart-assert: 0.12.4
• phpunit/phpunit: ^8.5
• sensiolabs/security-checker: ^6.0
• sylius-labs/coding-standard: ^3.1
• symfony/browser-kit: ^4.4
• symfony/debug-bundle: ^4.4|^5.0
• symfony/dotenv: ^4.4|^5.0
• symfony/intl: ^4.4|^5.0
• symfony/web-profiler-bundle: ^4.4|^5.0
• symfony/web-server-bundle: ^4.4|^5.0
• vimeo/psalm: 3.11.4

MIT

• sylius
• sylius-plugin

README

</a>

Plugin Skeleton

Skeleton for starting Sylius plugins.

Documentation

For a comprehensive guide on Sylius Plugins development please go to Sylius documentation, there you will find the Plugin Development Guide, that is full of examples.

Quickstart Installation

1. Run composer create-project sylius/plugin-skeleton ProjectName.

2. From the plugin skeleton root directory, run the following commands:

    $ (cd tests/Application && yarn install)
    $ (cd tests/Application && yarn build)
    $ (cd tests/Application && APP_ENV=test bin/console assets:install public)
       
    $ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
    $ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)
   

To be able to setup a plugin's database, remember to configure you database credentials in tests/Application/.env and tests/Application/.env.test.

Usage

Running plugin tests

• PHPUnit

  vendor/bin/phpunit
  

• PHPSpec

  vendor/bin/phpspec run
  

• Behat (non-JS scenarios)

  vendor/bin/behat --strict --tags="~@javascript"
  

• Behat (JS scenarios)

  1. Install Symfony CLI command.

  2. Start Headless Chrome:

    google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1
  

  1. Install SSL certificates (only once needed) and run test application's webserver on 127.0.0.1:8080:

    symfony server:ca:install
    APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon
  

  1. Run Behat:

    vendor/bin/behat --strict --tags="@javascript"
  

• Static Analysis

  • Psalm

    vendor/bin/psalm
    

  • PHPStan

    vendor/bin/phpstan analyse -c phpstan.neon -l max src/  
    

• Coding Standard

  vendor/bin/ecs check src
  

Opening Sylius with your plugin

• Using test environment:

    (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
    (cd tests/Application && APP_ENV=test bin/console server:run -d public)
  

• Using dev environment:

    (cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
    (cd tests/Application && APP_ENV=dev bin/console server:run -d public)