sylius/plugin-skeleton

Acme example plugin for Sylius.

, _(*1)

Plugin Skeleton

Skeleton for starting Sylius plugins., _(*2)

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., _(*3)

Quickstart Installation

Traditional

1. Run composer create-project sylius/plugin-skeleton ProjectName., _(*4)

2. From the plugin skeleton root directory, run the following commands:, _(*5)

   $ (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 set up a plugin's database, remember to configure you database credentials in tests/Application/.env and tests/Application/.env.test., _(*6)

Docker

1. Execute docker compose up -d, _(*7)

2. Initialize plugin docker compose exec app make init, _(*8)

3. See your browser open localhost, _(*9)

Usage

Running plugin tests

• PHPUnit, _(*10)

  vendor/bin/phpunit
  

• PHPSpec, _(*11)

  vendor/bin/phpspec run
  

• Behat (non-JS scenarios), _(*12)

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

• Behat (JS scenarios), _(*13)

  1. Install Symfony CLI command., _(*14)

  2. Start Headless Chrome:, _(*15)

     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
     

  3. Install SSL certificates (only once needed) and run test application's webserver on 127.0.0.1:8080:, _(*16)

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

  4. Run Behat:, _(*17)

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

• Static Analysis, _(*18)

  • Psalm, _(*19)

    vendor/bin/psalm
    

  • PHPStan, _(*20)

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

• Coding Standard, _(*21)

  vendor/bin/ecs check
  

Opening Sylius with your plugin

• Using test environment:, _(*22)

  (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:, _(*23)

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