diff --git a/.editorconfig b/.editorconfig index 575834a..e147490 100644 --- a/.editorconfig +++ b/.editorconfig @@ -11,6 +11,6 @@ indent_style = tab indent_size = tab tab_width = 4 -[{*.json,*.yml,*.md}] +[{*.json,*.yaml,*.yml,*.md}] indent_style = space indent_size = 2 diff --git a/Makefile b/Makefile index 5c23fc5..60ce194 100644 --- a/Makefile +++ b/Makefile @@ -1,27 +1,28 @@ -.PHONY: qa lint cs csf phpstan tests coverage +.PHONY: install qa cs csf phpstan tests coverage-clover coverage-html -all: - @$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' | xargs +install: + composer update -vendor: composer.json composer.lock - composer install +qa: phpstan cs -qa: lint phpstan cs - -lint: vendor - vendor/bin/linter src tests - -cs: vendor +cs: +ifdef GITHUB_ACTION + vendor/bin/codesniffer -q --report=checkstyle src tests | cs2pr +else vendor/bin/codesniffer src tests +endif -csf: vendor +csf: vendor/bin/codefixer src tests -phpstan: vendor +phpstan: vendor/bin/phpstan analyse -l max -c phpstan.neon src -tests: vendor - vendor/bin/phpunit tests --colors=always +tests: + vendor/bin/tester -s -p php --colors 1 -C tests/cases + +coverage-clover: + vendor/bin/tester -s -p phpdbg --colors 1 -C --coverage ./coverage.xml --coverage-src ./src tests/cases -coverage: vendor - phpdbg -qrr vendor/bin/phpunit tests --colors=always -c tests/coverage.xml +coverage-html: + vendor/bin/tester -s -p phpdbg --colors 1 -C --coverage ./coverage.html --coverage-src ./src tests/cases diff --git a/README.md b/README.md index 9ac2da3..422f60e 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,56 @@ -# Contributte PSR6 Caching - -[PSR-6 (Caching Interface)](https://www.php-fig.org/psr/psr-6/) adapter for [Nette Caching](https://github.com/nette/caching) - -[![Build Status](https://img.shields.io/travis/contributte/psr6-caching.svg?style=flat-square)](https://travis-ci.org/contributte/psr6-caching) -[![Code coverage](https://img.shields.io/coveralls/contributte/psr6-caching.svg?style=flat-square)](https://coveralls.io/r/contributte/psr6-caching) -[![Licence](https://img.shields.io/packagist/l/contributte/psr6-caching.svg?style=flat-square)](https://packagist.org/packages/contributte/psr6-caching) -[![Downloads this Month](https://img.shields.io/packagist/dm/contributte/psr6-caching.svg?style=flat-square)](https://packagist.org/packages/contributte/psr6-caching) -[![Downloads total](https://img.shields.io/packagist/dt/contributte/psr6-caching.svg?style=flat-square)](https://packagist.org/packages/contributte/psr6-caching) -[![Latest stable](https://img.shields.io/packagist/v/contributte/psr6-caching.svg?style=flat-square)](https://packagist.org/packages/contributte/psr6-caching) -[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan) - +![](https://heatbadger.now.sh/github/readme/contributte/psr6-caching/) + +
+ + ++ Website 🚀 contributte.org | Contact 👨🏻💻 f3l1x.io | Twitter 🐦 @contributte +
+ +## Usage + +To install the latest version of `contributte/psr6-caching` use [Composer](https://getcomposer.com). + +``` +composer require contributte/psr6-caching +``` ## Documentation -- [Setup](.docs/README.md#setup) -- [Usage](.docs/README.md#usage) +For details on how to use this package, check out our [documentation](.docs). ## Versions | State | Version | Branch | Nette | PHP | |-------------|---------|----------|-------|---------| -| dev | `^0.2` | `master` | 3.0+ | `^7.2` | -| stable | `^0.1` | `master` | 3.0+ | `^7.2` | - -## Maintainers - -
-
- |
-
-
- |
-