jpchateau/prototype-php-library

Quickly initiate the development of a new PHP library

1.6.1 2020-12-03 01:04 UTC

Requires

• php: ^7.3
• ext-dom: *
• ext-mbstring: *

Requires (Dev)

• phpstan/phpstan: ^0.12
• phpunit/phpunit: ^9.4
• squizlabs/php_codesniffer: ^3.5

MIT

• php
• library

README

PHP Library Prototype is a tool to quickly initiate the development of a new PHP library.

Features

The aim of this prototype is to save time when starting to develop a PHP library. It will:

• Download and install basic files - a class and its test class with proper namespaces
• Install popular QA tools: phpunit, phpstan and phpcs
• Generate basic .gitignore and README files

Please note that .gitignore file is based upon gitignore.io API.

Requirements

• PHP >= 7.3
• php-xml extension
• php-mbstring extension
• Composer

Check the PHP roadmap to see the PHP versions supported by this library.

Usage

Creating a library is a simple two-step process.

1. First, create a project from this prototype. Replace MyDirectory with your own value to create the project and move into the created directory:

$ composer create-project jpchateau/prototype-php-library MyDirectory && cd $_

1. Then, run the install command to complete the process. Replace MyCompany and MyProject with your own values:

$ make company=MyCompany project=MyProject install

You are ready to develop!
Don't forget to pick up a license ;)

Tests

$ make tests

QA Tools

$ bin/phpcs src/ --standard=PSR2
$ bin/phpstan analyse -l 7 src/