Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bitbagcommerce/coding-standard


https://github.com/bitbagcommerce/coding-standard

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README 

          



# BitBag Coding Standard



----



At BitBag we do believe in open source. However, we are able to do it just because of our awesome clients, who are kind enough to share some parts of our work with the community. Therefore, if you feel like there is a possibility for us to work  together, feel free to reach out. You will find out more about our professional services, technologies, and contact details at [https://bitbag.io/](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding_standard).



Like what we do? Want to join us? Check out our job listings on our [career page](https://bitbag.io/career/?utm_source=github&utm_medium=referral&utm_campaign=career). Not familiar with Symfony & Sylius yet, but still want to start with us? Join our [academy](https://bitbag.io/pl/akademia?utm_source=github&utm_medium=url&utm_campaign=akademia)!



## Table of Content



***



* [Overview](#overview)

* [Support](#we-are-here-to-help)

* [Installation](#installation)

    * [Usage](#usage)

    * [Customization](#customization)

* [About us](#about-us)

    * [Community](#community)

* [Demo](#demo-sylius-shop)

* [License](#license)

* [Contact](#contact)



# Overview



----

[BitBag](https://bitbag.io/) coding standard helps you produce solid and maintainable code.

At [BitBag Coding Bible](https://github.com/BitBagCommerce/BitBagBible) you can get familiar with standard we have

implemented in our library. [ECS](https://github.com/symplify/easy-coding-standard)

and [PHPStan](https://github.com/phpstan/phpstan) are responsible for keeping your code in order.



## We are here to help

This **open-source library was developed to help the community**. If you have any additional questions, would like help with installing or configuring the plugin, or need any assistance with your project - let us know!



[![](https://bitbag.io/wp-content/uploads/2020/10/button-contact.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding_standard)



# Installation



```bash

composer require bitbag/coding-standard --dev

```



Create `ecs.php` file with following lines or add import line to your existing file if you have one

```php



import('vendor/bitbag/coding-standard/ecs.php');

    $config->paths(['src', 'tests']);

};



```

Then create `phpstan.neon` file with the following lines or add include line at the beginning of your existing file if you have one

```neon

includes:

    - vendor/bitbag/coding-standard/phpstan.neon

```



## Usage



Just like with standard ECS, for example to check /src dir:

```bash

./vendor/bin/ecs check src

```

If ECS found any standard violations, you can fix it by:

```bash

./vendor/bin/ecs check src --fix

```

To check /src dir by PHPStan:

```bash

./vendor/bin/phpstan analyse src

```



## Customization



#### ECS

It's possible to extends `root/ecs.php` by your own fixers

```php

use Symplify\EasyCodingStandard\Config\ECSConfig;

use Your\Place\For\Fixer\FooBarFixer;

...

return static function (ECSConfig $config): void {

$services = $config->services();

$services->set(FooBarFixer::class);

```



#### PHPStan

You can set PHPStan rule level with following commands

```bash

./vendor/bin/phpstan analyze src --level=8

./vendor/bin/phpstan analyze tests --level=5

```

or you can customize configuration in `phpstan.neon` file

```neon

includes:

    - vendor/bitbag/coding-standard/phpstan.neon



parameters:

    level: max

    paths:

        - src

        - tests

```



## Troubleshooting



### Sylius 1.12 support



If you have an issue with dependencies on Sylius v1.12, please upgrade your PHPUnit version to 9.5 or higher.



# About us



---



BitBag is a company of people who **love what they do** and do it right. We fulfill the eCommerce technology stack with **Sylius**, Shopware, Akeneo, and Pimcore for PIM, eZ Platform for CMS, and VueStorefront for PWA. Our goal is to provide real digital transformation with an agile solution that scales with the **clients’ needs**. Our main area of expertise includes eCommerce consulting and development for B2C, B2B, and Multi-vendor Marketplaces.

We are advisers in the first place. We start each project with a diagnosis of problems, and an analysis of the needs and **goals** that the client wants to achieve.

We build **unforgettable**, consistent digital customer journeys on top of the **best technologies**. Based on a detailed analysis of the goals and needs of a given organization, we create dedicated systems and applications that let businesses grow.


Our team is fluent in **Polish, English, German and, French**. That is why our cooperation with clients from all over the world is smooth.



**Some numbers from BitBag regarding Sylius:**

- 50+ **experts** including consultants, UI/UX designers, Sylius trained front-end and back-end developers,

- 120+ projects **delivered** on top of Sylius,

- 25+ **countries** of BitBag’s customers,

- 4+ **years** in the Sylius ecosystem.



**Our services:**

- Business audit/Consulting in the field of **strategy** development,

- Data/shop **migration**,

- Headless **eCommerce**,

- Personalized **software** development,

- **Project** maintenance and long term support,

- Technical **support**.



**Key clients:** Mollie, Guave, P24, Folkstar, i-LUNCH, Elvi Project, WestCoast Gifts.



---



If you need some help with Sylius development, don't be hesitated to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding_standard) or send us an e-mail at hello@bitbag.io!



---



[![](https://bitbag.io/wp-content/uploads/2021/08/sylius-badges-transparent-wide.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding_standard)



## Community



----



For online communication, we invite you to chat with us & other users on [Sylius Slack](https://sylius-devs.slack.com/).



# Demo Sylius Shop



---



We created a demo app with some useful use-cases of plugins!

Visit [sylius-demo.bitbag.io](https://sylius-demo.bitbag.io/) to take a look at it. The admin can be accessed under

[sylius-demo.bitbag.io/admin/login](https://sylius-demo.bitbag.io/admin/login) link and `bitbag: bitbag` credentials.

Plugins that we have used in the demo:



| BitBag's Plugin | GitHub | Sylius' Store|

| ------ | ------ | ------|

| ACL Plugin | *Private. Available after the purchasing.*| https://plugins.sylius.com/plugin/access-control-layer-plugin/|

| Braintree Plugin | https://github.com/BitBagCommerce/SyliusBraintreePlugin |https://plugins.sylius.com/plugin/braintree-plugin/|

| CMS Plugin | https://github.com/BitBagCommerce/SyliusCmsPlugin | https://plugins.sylius.com/plugin/cmsplugin/|

| Elasticsearch Plugin | https://github.com/BitBagCommerce/SyliusElasticsearchPlugin | https://plugins.sylius.com/plugin/2004/|

| Mailchimp Plugin | https://github.com/BitBagCommerce/SyliusMailChimpPlugin | https://plugins.sylius.com/plugin/mailchimp/ |

| Multisafepay Plugin | https://github.com/BitBagCommerce/SyliusMultiSafepayPlugin |

| Wishlist Plugin | https://github.com/BitBagCommerce/SyliusWishlistPlugin | https://plugins.sylius.com/plugin/wishlist-plugin/|

| **Sylius' Plugin** | **GitHub** | **Sylius' Store** |

| Admin Order Creation Plugin | https://github.com/Sylius/AdminOrderCreationPlugin | https://plugins.sylius.com/plugin/admin-order-creation-plugin/ |

| Invoicing Plugin | https://github.com/Sylius/InvoicingPlugin | https://plugins.sylius.com/plugin/invoicing-plugin/ |

| Refund Plugin | https://github.com/Sylius/RefundPlugin | https://plugins.sylius.com/plugin/refund-plugin/ |



**If you need an overview of Sylius' capabilities, schedule a consultation with our expert.**



[![](https://bitbag.io/wp-content/uploads/2020/10/button_free_consulatation-1.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding_standard)



## Additional resources for developers



---

To learn more about our contribution workflow and more, we encourage you to use the following resources:

* [Sylius Documentation](https://docs.sylius.com/en/latest/)

* [Sylius Contribution Guide](https://docs.sylius.com/en/latest/contributing/)

* [Sylius Online Course](https://sylius.com/online-course/)



## License



---



This plugin's source code is completely free and released under the terms of the MIT license.



[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)



## Contact



---

If you want to contact us, the best way is to fill the form on [our website](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding-standard) or send us an e-mail to hello@bitbag.io with your question(s). We guarantee that we answer as soon as we can!



[![](https://bitbag.io/wp-content/uploads/2021/08/badges-bitbag.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=coding-standard)