sylius/plugin-skeleton

Acme example plugin for Sylius.

v2.0.0 2024-12-10 06:00 UTC

Requires

• php: ^8.2
• sylius/sylius: ~2.0.0

Requires (Dev)

• behat/behat: ^3.16
• dmore/behat-chrome-extension: ^1.4
• dmore/chrome-mink-driver: ^2.9
• friends-of-behat/mink: ^1.11
• friends-of-behat/mink-browserkit-driver: ^1.6
• friends-of-behat/mink-debug-extension: ^2.1
• friends-of-behat/mink-extension: ^2.7
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.1
• friends-of-behat/symfony-extension: ^2.6
• friends-of-behat/variadic-extension: ^1.6
• nyholm/psr7: ^1.8
• phpspec/phpspec: ^7.5
• phpstan/phpstan: ^1.12
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-webmozart-assert: ^1.2
• phpunit/phpunit: ^10.5
• robertfausk/behat-panther-extension: ^1.1
• sylius-labs/coding-standard: ^4.4
• sylius-labs/suite-tags-extension: ~0.2
• sylius/sylius-rector: ^1.0
• symfony/browser-kit: ^6.4 || ^7.1
• symfony/debug-bundle: ^6.4 || ^7.1
• symfony/dotenv: ^6.4 || ^7.1
• symfony/flex: ^2.4
• symfony/http-client: ^6.4 || ^7.1
• symfony/intl: ^6.4 || ^7.1
• symfony/web-profiler-bundle: ^6.4 || ^7.1
• symfony/webpack-encore-bundle: ^2.2

MIT

• sylius
• sylius-plugin

README

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

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

Traditional

1. 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)
   # Optionally load data fixtures
   $ (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load --no-interaction)

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

2. Run your local server:

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

3. Open your browser and navigate to https://localhost:8000.

Docker

1. Execute docker compose up -d

2. Initialize plugin docker compose exec app make init

3. See your browser open localhost

Usage

Running plugin tests

• PHPUnit

  vendor/bin/phpunit

• PHPSpec

  vendor/bin/phpspec run

• Behat (non-JS scenarios)

  vendor/bin/behat --strict --tags="~@javascript&&~@mink:chromedriver"

• 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&&~@mink:chromedriver"

• Static Analysis

  • PHPStan

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

• Coding Standard

  vendor/bin/ecs check

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)