bitbag/coding-standard

BitBag coding standard

v3.0.0 2023-10-20 12:12 UTC

This package is auto-updated.

Last update: 2024-02-20 12:58:34 UTC


README

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/.

Like what we do? Want to join us? Check out our job listings on our career page. Not familiar with Symfony & Sylius yet, but still want to start with us? Join our academy!

Table of Content

Overview

BitBag coding standard helps you produce solid and maintainable code. At BitBag Coding Bible you can get familiar with standard we have implemented in our library. ECS and 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!

Installation

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

declare(strict_types=1);

use Symplify\EasyCodingStandard\Config\ECSConfig;

return static function (ECSConfig $config): void {

    // Change this if you want to automatically add BitBag OpenSource Header
    putenv('ALLOW_BITBAG_OS_HEADER=0');
    
    $config->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

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

Usage

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

./vendor/bin/ecs check src

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

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

To check /src dir by PHPStan:

./vendor/bin/phpstan analyse src

Customization

ECS

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

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

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

or you can customize configuration in phpstan.neon file

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 or send us an e-mail at hello@bitbag.io!

Community

For online communication, we invite you to chat with us & other users on Sylius Slack.

Demo Sylius Shop

We created a demo app with some useful use-cases of plugins! Visit sylius-demo.bitbag.io to take a look at it. The admin can be accessed under 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.

Additional resources for developers

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

License

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

Contact

If you want to contact us, the best way is to fill the form on our website or send us an e-mail to hello@bitbag.io with your question(s). We guarantee that we answer as soon as we can!