eureka/component-template

PHP template library.

component-template

, _(*1)

Why?

Template for new components, _(*2)

Installation

If you wish to install it in your project, require it via composer:, _(*3)

composer require eureka/component-template

Usage

Usage:, _(*4)

<?php

// Sample code here

Contributing

See the CONTRIBUTING file., _(*5)

Install / update project

You can install project with the following command:, _(*6)

make install

And update with the following command:, _(*7)

make update

NB: For the components, the composer.lock file is not committed., _(*8)

Testing & CI (Continuous Integration)

Tests

You can run tests (with coverage) on your side with following command:, _(*9)

make tests

For prettier output (but without coverage), you can use the following command:, _(*10)

make testdox # run tests without coverage reports but with prettified output

Code Style

You also can run code style check with following commands:, _(*11)

make phpcs

You also can run code style fixes with following commands:, _(*12)

make phpcbf

Static Analysis

To perform a static analyze of your code (with phpstan, lvl 9 at default), you can use the following command:, _(*13)

make analyze

Minimal supported version:, _(*14)

make php74compatibility

Maximal supported version:, _(*15)

make php82compatibility

CI Simulation

And the last "helper" commands, you can run before commit and push, is:, _(*16)

make ci  

License

This project is licensed under the MIT License - see the LICENSE file for details, _(*17)