О чем поговорим
- Анализ open source пакетов
- Обзор инструментов
- Рекомендации
Критерии
- Структура директорий
- composer.json
- README
- Документация
- Инструменты
Подопытные
Cache
- symfony/cache
- laminas/laminas-cache
- yiisoft/cache
Структура директорий
symfony/cache
laminas/laminas-cache
yiisoft/cache
composer.json
symfony/cache
{
"name": "symfony/cache",
"type": "library",
"description": "Provides an extended PSR-6, PSR-16",
"keywords": ["caching", "psr6"],
"homepage": "https://symfony.com",
"license": "MIT",
"provide": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"conflict": {/* ... */},
"autoload": {/* ... */},
"minimum-stability": "dev"
}
{
"name": "symfony/cache",
"type": "library",
"description": "Provides an extended PSR-6, PSR-16",
"keywords": ["caching", "psr6"],
"homepage": "https://symfony.com",
"license": "MIT",
"provide": {
"psr/cache-implementation": "1.0|2.0",
"psr/simple-cache-implementation": "1.0",
"symfony/cache-implementation": "1.0|2.0"
},
"require": {/* ... */},
"require-dev": {/* ... */},
"conflict": {/* ... */},
"autoload": {/* ... */},
"minimum-stability": "dev"
}
{
"name": "symfony/cache",
"type": "library",
"description": "Provides an extended PSR-6, PSR-16",
"keywords": ["caching", "psr6"],
"homepage": "https://symfony.com",
"license": "MIT",
"provide": {/* ... */},
"require": {
"php": ">=7.2.5",
"psr/cache": "^1.0|^2.0",
"psr/log": "^1.1|^2|^3",
"symfony/cache-contracts": "^1.1.7|^2",
"symfony/deprecation-contracts": "^2.1",
"symfony/polyfill-php80": "^1.16",
"symfony/service-contracts": "^1.1|^2",
"symfony/var-exporter": "^4.4|^5.0"
},
"require-dev": {/* ... */},
"conflict": {/* ... */},
"autoload": {/* ... */},
"minimum-stability": "dev"
}
{
"name": "symfony/cache",
"type": "library",
"description": "Provides an extended PSR-6, PSR-16",
"keywords": ["caching", "psr6"],
"homepage": "https://symfony.com",
"license": "MIT",
"provide": {/* ... */},
"require": {/* ... */},
"require-dev": {
"cache/integration-tests": "dev-master",
"doctrine/cache": "^1.6|^2.0",
"doctrine/dbal": "^2.10|^3.0",
"predis/predis": "^1.1",
"psr/simple-cache": "^1.0",
"symfony/config": "^4.4|^5.0",
"symfony/dependency-injection": "^4.4|^5.0",
"symfony/filesystem": "^4.4|^5.0",
"symfony/http-kernel": "^4.4|^5.0",
"symfony/messenger": "^4.4|^5.0",
"symfony/var-dumper": "^4.4|^5.0"
},
"conflict": {/* ... */},
"autoload": {/* ... */},
"minimum-stability": "dev"
}
{
"name": "symfony/cache",
"type": "library",
"description": "Provides an extended PSR-6, PSR-16",
"keywords": ["caching", "psr6"],
"homepage": "https://symfony.com",
"license": "MIT",
"provide": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"conflict": {
"doctrine/dbal": "<2.10",
"symfony/dependency-injection": "<4.4",
"symfony/http-kernel": "<4.4",
"symfony/var-dumper": "<4.4"
},
"autoload": {/* ... */},
"minimum-stability": "dev"
}
laminas/laminas-cache
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {/* ... */},
"config": {
"process-timeout": 600,
"sort-packages": true
},
"extra": {
"laminas": {
"component": "Laminas\\Cache",
"config-provider": "Laminas\\Cache\\ConfigProvider"
}
},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {
"docs": "https://docs.laminas.dev/laminas-cache/",
"issues": "https://github.com/laminas/laminas-cache/issues",
"source": "https://github.com/laminas/laminas-cache",
"rss": "https://github.com/laminas/laminas-cache/releases.atom",
"chat": "https://laminas.dev/chat",
"forum": "https://discourse.laminas.dev"
},
"config": {
"process-timeout": 600,
"sort-packages": true
},
"extra": {
"laminas": {
"component": "Laminas\\Cache",
"config-provider": "Laminas\\Cache\\ConfigProvider"
}
},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {/* ... */},
"config": {
"process-timeout": 600,
"sort-packages": true
},
"extra": {
"laminas": {
"component": "Laminas\\Cache",
"config-provider": "Laminas\\Cache\\ConfigProvider"
}
},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {/* ... */},
"config": {
"process-timeout": 600,
"sort-packages": true
},
"extra": {
"laminas": {
"component": "Laminas\\Cache",
"config-provider": "Laminas\\Cache\\ConfigProvider"
}
},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {/* ... */},
"config": {/* ... */},
"extra": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {/* ... */},
"config": {/* ... */},
"extra": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {
"laminas/laminas-serializer": "Laminas\\Serializer component"
},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"keywords": [/* ... */],
"homepage": "https://laminas.dev",
"support": {/* ... */},
"config": {/* ... */},
"extra": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "laminas/laminas-cache",
"description": "Caching implementation .... ",
"license": "BSD-3-Clause",
"homepage": "https://laminas.dev",
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"scripts": {
"benchmark": "phpbench run --revs=2 --iterations=2 --report=aggregate",
"check": [
"@cs-check",
"@test"
],
"cs-check": "phpcs",
"cs-fix": "phpcbf",
"test": "phpunit --colors=always",
"test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
"static-analysis": "psalm --shepherd --stats"
}
}
yiisoft/cache
{
"name": "yiisoft/cache",
"type": "library",
"description": "Yii Caching Library",
"keywords": [/* ... */],
"homepage": "http://www.yiiframework.com/",
"license": "BSD-3-Clause",
"support": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"extra": {/* ... */},
"config": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "yiisoft/cache",
"type": "library",
"description": "Yii Caching Library",
"homepage": "http://www.yiiframework.com/",
"license": "BSD-3-Clause",
"support": {/* ... */},
"require": {
"php": "^7.4|^8.0",
"ext-ctype": "*",
"ext-json": "*",
"ext-mbstring": "*",
"psr/simple-cache": "^1.0.1"
},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"extra": {/* ... */},
"config": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "yiisoft/cache",
"type": "library",
"description": "Yii Caching Library",
"homepage": "http://www.yiiframework.com/",
"license": "BSD-3-Clause",
"support": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {
"yiisoft/cache-apcu": "Allows to store cache using APCu PECL extension",
"yiisoft/cache-db": "Allows storing cache to the database",
"yiisoft/cache-file": "Allows storing cache to the files",
"yiisoft/cache-memcached": "Allows to store cache using Memcached PECL extension",
"yiisoft/cache-wincache": "Allows to store cache using WinCache PECL extension"
},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"extra": {/* ... */},
"config": {/* ... */},
"scripts": {/* ... */}
}
{
"name": "yiisoft/cache",
"type": "library",
"description": "Yii Caching Library",
"homepage": "http://www.yiiframework.com/",
"license": "BSD-3-Clause",
"support": {/* ... */},
"require": {/* ... */},
"require-dev": {/* ... */},
"provide": {/* ... */},
"suggest": {/* ... */},
"autoload": {/* ... */},
"autoload-dev": {/* ... */},
"extra": {/* ... */},
"config": {/* ... */},
"scripts": {
"test": "phpunit --testdox --no-interaction",
"test-watch": "phpunit-watcher watch"
}
}
README
symfony/cache
laminas/laminas-cache
yiisoft/cache
Документация
symfony/cache
laminas/laminas-cache
yiisoft/cache
Инструменты
Категории
- CI
- Код-стайл
- Тестирование
- Статические анализаторы
- Документирование
- Прочее
CI
- Travis CI
- Github Actions
- Gitlab CI/CD
- Scrutinizer CI
- и другие
Код-стайл
- StyleCI
- PHP CS Fixer
- PHP CodeSniffer
Тестирование
- PHPUnit
- Infection
Статические анализаторы
- Psalm
- PHPStan
- Phan
Документирование
- phpDocumentor
- phpDox
- MkDocs
- Jekyll
Прочее
Используемые в cache
| symfony/cache | laminas/laminas-cache | yiisoft/cache |
|
|
|
Итог
Рекомендации
- Понятная структура директорий (src, docs, tests)
- Хранить документацию рядом с пакетом
- Тесты
- Содержательный README (Install, Usage)
- Следить за оформлением composer.json (provide, suggest, conflict)
- Использовать инструменты