https://github.com/invis1ble/serializer-extension-bundle

Provides integration of the invis1ble/serializer-extension library into the Symfony framework
https://github.com/invis1ble/serializer-extension-bundle

denormalizer deserializer extension normalizer psr serializer symfony-bundle uri uriinterface url

Last synced: 2 months ago
JSON representation

Provides integration of the invis1ble/serializer-extension library into the Symfony framework

• Host: GitHub
• URL: https://github.com/invis1ble/serializer-extension-bundle
• Owner: Invis1ble
• License: mit
• Created: 2024-06-03T13:10:31.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-06T14:07:29.000Z (7 months ago)
• Last Synced: 2024-09-30T16:04:37.571Z (3 months ago)
• Topics: denormalizer, deserializer, extension, normalizer, psr, serializer, symfony-bundle, uri, uriinterface, url
• Language: PHP
• Homepage:
• Size: 43.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
SerializerExtensionBundle

==========================

![CI Status](https://github.com/Invis1ble/serializer-extension-bundle/actions/workflows/ci.yml/badge.svg?event=push)

[![Code Coverage](https://codecov.io/gh/Invis1ble/serializer-extension-bundle/graph/badge.svg?token=K7S3BXER5K)](https://codecov.io/gh/Invis1ble/serializer-extension-bundle)

[![Packagist](https://img.shields.io/packagist/v/Invis1ble/serializer-extension-bundle.svg)](https://packagist.org/packages/Invis1ble/serializer-extension-bundle)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

The `SerializerExtensionBundle` provides integration of the [invis1ble/serializer-extension](https://github.com/Invis1ble/serializer-extension) library into the Symfony framework.

Installation

------------

Make sure Composer is installed globally, as explained in the

[installation chapter](https://getcomposer.org/doc/00-intro.md)

of the Composer documentation.

### Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

```console

$ composer require invis1ble/serializer-extension-bundle

```

### Applications that don't use Symfony Flex

#### Step 1: Download the Bundle

Open a command console, enter your project directory and execute the

following command to download the latest stable version of this bundle:

```console

$ composer require invis1ble/serializer-extension-bundle

```

#### Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles

in the `config/bundles.php` file of your project:

```php

// config/bundles.php

return [

    // ...

    Invis1ble\SerializerExtensionBundle\Invis1bleSerializerExtensionBundle::class => ['all' => true],

];

```

Development

-----------

### Getting started

1. If not already done, [install Docker Compose](https://docs.docker.com/compose/install/) (v2.10+)

2. Run `docker compose build --no-cache` to build fresh images

3. Run `docker compose up -d --wait` to start the Docker containers

4. Run `docker compose exec php composer install` to install dependencies

5. Run `docker compose down --remove-orphans` to stop the Docker containers.

### Check for Coding Standards violations

Run PHP_CodeSniffer checks:

```sh

docker compose exec -it php bin/php_codesniffer

```

Run PHP-CS-Fixer checks:

```sh

docker compose exec -it php bin/php-cs-fixer

```

Run Rector checks:

```sh

docker compose exec -it php bin/rector

```

Testing

-------

To run Unit tests during development

```sh

docker compose exec php vendor/bin/phpunit

```

To run with coverage

```sh

XDEBUG_MODE=coverage docker compose up -d --wait

docker compose exec php vendor/bin/phpunit --coverage-clover var/log/coverage-clover.xml

```

License

-------

[The MIT License](./LICENSE)