feat: readme and composer minor improvements

vfunin · Aug 2, 2023 · 5c1f78a · 5c1f78a
1 parent 492e765
commit 5c1f78a
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 21 deletions.
diff --git a/Makefile b/Makefile
@@ -1,37 +1,30 @@
-.PHONY: ci infection test deptrac rector cs psalm gst gcmsg
+.PHONY: ci infection test deptrac test-coverage mutation rector cs psalm gst gcmsg
 ci:
-	docker compose run --rm application vendor/bin/grumphp run
+	docker compose run --rm application composer dck-ci
 
 infection:
-	docker compose run --rm application vendor/bin/infection --test-framework=pest
+	docker compose run --rm application composer dck-infection
 
 test:
-	docker compose run --rm application vendor/bin/pest --coverage
+	docker compose run --rm application composer dck-pest
 
-test-cov:
-	docker compose run --rm application vendor/bin/pest --coverage-xml=var/.report/coverage/xml --log-junit=var/.report/coverage/phpunit.junit.xml
+test-coverage:
+	docker compose run --rm application composer dck-pest-coverage
 
-mut:
-	docker compose run --rm application vendor/bin/infection --threads=max \
-              --skip-initial-tests \
-              --min-msi=90 \
-              --min-covered-msi=90 \
-              --coverage=var/.report/coverage \
-              --log-verbosity=none \
-              --no-interaction \
-              --no-progress
+mutation:
+	docker compose run --rm application composer dck-mutation-test
 
 deptrac:
-	docker compose run --rm application vendor/bin/deptrac analyse --cache-file='var/.cache/deptrac/.deptrac.cache'
+	docker compose run --rm application composer dck-deptrac
 
 rector:
-	docker compose run --rm application vendor/bin/rector process --dry-run
+	docker compose run --rm application composer dck-rector
 
 cs:
-	docker compose run --rm application vendor/bin/phpcs
+	docker compose run --rm application composer dck-phpcs
 
 psalm:
-	docker compose run --rm application vendor/bin/psalm
+	docker compose run --rm application composer dck-psalm
 
 gst:
 	docker compose run --rm application git status

diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ The package provides a pre-configured set of code quality checking tools based o
 ## Installation
 Install Dev CI Kit with dependencies:
 ```sh
-composer require --dev vfunin/dev-ci-kit
+composer require --dev vfunin/dev-ci-kit --update-with-all-dependencies
 ```
 After installation, configuration file templates will be copied to your project's root directory with a .dist extension. If your project does not already have the corresponding file, simply remove the extension, or use your own configuration.
 

diff --git a/composer.json b/composer.json
@@ -58,6 +58,15 @@
     "scripts": {
         "post-install-cmd": [
             "DevCIKit\\Composer\\DevCIKitPlugin::init"
-        ]
+        ],
+        "dck-ci": "vendor/bin/grumphp run",
+        "dck-deptrac": "vendor/bin/deptrac analyse --cache-file='var/.cache/deptrac/.deptrac.cache'",
+        "dck-infection": "vendor/bin/infection --test-framework=pest",
+        "dck-mutation-test": "vendor/bin/infection --threads=max --skip-initial-tests --min-msi=90 --min-covered-msi=90 --coverage=var/.report/coverage --log-verbosity=none --no-interaction --no-progress",
+        "dck-pest": "vendor/bin/pest --coverage",
+        "dck-pest-coverage": "vendor/bin/pest --coverage-xml=var/.report/coverage/xml --log-junit=var/.report/coverage/phpunit.junit.xml",
+        "dck-phpcs": "vendor/bin/phpcs",
+        "dck-psalm": "vendor/bin/psalm",
+        "dck-rector": "vendor/bin/rector process --dry-run"
     }
 }