Merge pull request #460 from wayofdev/feat/tpl-updates

Author: lotyp

.env.example

@@ -0,0 +1,28 @@
+# https://docs.docker.com/compose/reference/envvars/#compose_project_name
+# With custom namespace provided, it will be used to prefix all services
+# in Docker network for current project
+COMPOSE_PROJECT_NAME=laravel-package-tpl
+APP_ENV=production
+
+DB_CONNECTION=pgsql
+DB_HOST=pgsql
+DB_PORT=5432
+
+DB_DATABASE=default
+DB_USERNAME=root
+DB_PASSWORD=password
+
+DB_MYSQL_FORWARD_PORT=13307
+DB_PGSQL_FORWARD_PORT=15433
+
+XDEBUG_MODE=coverage
+
+CYCLE_ADAPTER_QUEUE_INTEGRATION=false
+CYCLE_ADAPTER_SESSION_INTEGRATION=false
+CYCLE_ADAPTER_CACHE_INTEGRATION=false
+
+CYCLE_ATTRIBUTES_CACHE=true
+CYCLE_ATTRIBUTES_CACHE_DRIVER=array
+
+CYCLE_SCHEMA_CACHE=true
+CYCLE_SCHEMA_CACHE_DRIVER=array

.gitattributes

@@ -0,0 +1,19 @@
+/.build export-ignore
+/.github export-ignore
+/docs export-ignore
+/tests export-ignore
+.editorconfig export-ignore
+.env export-ignore
+.env.example export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.php-cs-fixer.dist.php export-ignore
+.pre-commit-config.yaml export-ignore
+.yamllint.yaml export-ignore
+docker-compose.yaml export-ignore
+Makefile export-ignore
+package.json export-ignore
+phpstan.neon.dist export-ignore
+phpstan-baseline.neon export-ignore
+phpunit.xml.dist export-ignore
+renovate.json export-ignore

.github/labeler.yml

@@ -3,13 +3,12 @@
 # this file is for the labeler workflow job
 # Documentation https://github.com/marketplace/actions/labeler
 
-'type: documentation':
-  - assets/**/*
-  - .github/*
-  - ./*.md
-
-'type: maintenance':
-  - .github/**/*
-  - tests/**/*
+"type: documentation":
+  - changed-files:
+      - any-glob-to-any-file: [assets/**/*, .github/*, ./*.md]
+
+"type: maintenance":
+  - changed-files:
+      - any-glob-to-any-file: [tests/**/*, .github/workflows/*]
 
 ...

.gitignore

@@ -1,2 +1,4 @@
 /vendor/
 /.build/
+.env
+coverage.xml

.pre-commit-config.yaml

@@ -2,15 +2,16 @@
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-added-large-files
+        args: ['--maxkb=600']
       - id: fix-encoding-pragma
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v2.42.1
+    rev: v3.13.0
     hooks:
       - id: commitizen
         stages:

.yamllint.yaml

@@ -1,10 +1,11 @@
 ---
 
-extends: "default"
+extends: default
 
 ignore: |
   .build/
   vendor/
+  docs/
 
 # Overwrite above default rules
 rules:
@@ -51,8 +52,6 @@ rules:
     require-starting-space: true
     min-spaces-from-content: 1
 
-yaml-files:
-  - "*.yaml"
-  - "*.yml"
+  line-length: disable
 
 ...

Makefile

@@ -1,16 +1,39 @@
-# leave empty to disable
-# -v - verbose;
-# -vv - more details
-# -vvv - enable connection debugging
-DEBUG_VERBOSITY ?=
+-include .env
 
-DOCKER_CMD =
+# BuildKit enables higher performance docker builds and caching possibility
+# to decrease build times and increase productivity for free.
+# https://docs.docker.com/compose/environment-variables/envvars/
+export DOCKER_BUILDKIT ?= 1
 
-COMPOSER_RUN = $(DOCKER_CMD) composer
+# Binary to use, when executing docker-compose tasks
+DOCKER_COMPOSE ?= docker compose
+
+# Support image with all needed binaries, like envsubst, mkcert, wait4x
+SUPPORT_IMAGE ?= wayofdev/build-deps:alpine-latest
+
+APP_RUNNER ?= $(DOCKER_COMPOSE) run --rm --no-deps app
+APP_COMPOSER ?= $(APP_RUNNER) composer
+
+BUILDER_PARAMS ?= docker run --rm -i \
+	--env-file ./.env \
+	--env COMPOSE_PROJECT_NAME=$(COMPOSE_PROJECT_NAME) \
+	--env COMPOSER_AUTH="$(COMPOSER_AUTH)"
+
+BUILDER ?= $(BUILDER_PARAMS) $(SUPPORT_IMAGE)
+BUILDER_WIRED ?= $(BUILDER_PARAMS) --network project.$(COMPOSE_PROJECT_NAME) $(SUPPORT_IMAGE)
+
+# Shorthand envsubst command, executed through build-deps
+ENVSUBST ?= $(BUILDER) envsubst
+
+NPM_RUNNER ?= pnpm
 
 # https://phpstan.org/user-guide/output-format
 export PHPSTAN_OUTPUT_FORMAT ?= table
 
+EXPORT_VARS = '\
+	$${COMPOSE_PROJECT_NAME} \
+	$${COMPOSER_AUTH}'
+
 # Self documenting Makefile code
 # ------------------------------------------------------------------------------------
 ifneq ($(TERM),)
@@ -34,7 +57,7 @@ else
 	WHITE := ""
 	RST := ""
 endif
-MAKE_LOGFILE = /tmpwayofdev-laravel-package-tpl.log
+MAKE_LOGFILE = /tmp/wayofdev-laravel-package-tpl.log
 MAKE_CMD_COLOR := $(BLUE)
 
 default: all
@@ -64,19 +87,66 @@ all: install hooks
 
 # System Actions
 # ------------------------------------------------------------------------------------
+env: ## Generate .env file from example, use `make env force=true`, to force re-create file
+ifeq ($(FORCE),true)
+	@echo "${YELLOW}Force re-creating .env file from example...${RST}"
+	$(ENVSUBST) $(EXPORT_VARS) < ./.env.example > ./.env
+else ifneq ("$(wildcard ./.env)","")
+	@echo ""
+	@echo "${YELLOW}The .env file already exists! Use FORCE=true to re-create.${RST}"
+else
+	@echo "Creating .env file from example"
+	$(ENVSUBST) $(EXPORT_VARS) < ./.env.example > ./.env
+endif
+.PHONY: env
+
 prepare:
 	mkdir -p .build/php-cs-fixer
 .PHONY: prepare
 
 
+# Docker Actions
+# ------------------------------------------------------------------------------------
+up: # Creates and starts containers, defined in docker-compose and override file
+	$(DOCKER_COMPOSE) up --remove-orphans -d
+.PHONY: up
+
+down: # Stops and removes containers of this project
+	$(DOCKER_COMPOSE) down --remove-orphans --volumes
+.PHONY: down
+
+restart: down up ## Runs down and up commands
+.PHONY: restart
+
+clean: ## Stops containers if required and removes from system
+	$(DOCKER_COMPOSE) rm --force --stop
+.PHONY: clean
+
+ps: ## List running project containers
+	$(DOCKER_COMPOSE) ps
+.PHONY: ps
+
+logs: ## Show project docker logs with follow up mode enabled
+	$(DOCKER_COMPOSE) logs -f
+.PHONY: logs
+
+pull: ## Pull and update docker images in this project
+	$(DOCKER_COMPOSE) pull
+.PHONY: pull
+
+ssh: ## Login inside running docker container
+	$(APP_RUNNER) sh
+.PHONY: ssh
+
+
 # Composer
 # ------------------------------------------------------------------------------------
 install: ## Installs composer dependencies
-	$(COMPOSER_RUN) install
+	$(APP_COMPOSER) install
 .PHONY: install
 
 update: ## Updates composer dependencies by running composer update command
-	$(COMPOSER_RUN) update
+	$(APP_COMPOSER) update
 .PHONY: update
 
 
@@ -87,30 +157,47 @@ hooks: ## Install git hooks from pre-commit-config
 	pre-commit autoupdate
 .PHONY: hooks
 
+lint: lint-yaml lint-php lint-stan ## Runs all linting commands
+.PHONY: lint
+
 lint-yaml: ## Lints yaml files inside project
 	yamllint .
 .PHONY: lint-yaml
 
 lint-php: prepare ## Fixes code to follow coding standards using php-cs-fixer
-	$(COMPOSER_RUN) cs:fix
+	$(APP_COMPOSER) cs:fix
 .PHONY: lint-php
 
 lint-diff: prepare ## Runs php-cs-fixer in dry-run mode and shows diff which will by applied
-	$(COMPOSER_RUN) cs:diff
+	$(APP_COMPOSER) cs:diff
 .PHONY: lint-diff
 
 lint-stan: ## Runs phpstan – static analysis tool
-	$(COMPOSER_RUN) stan
+	$(APP_COMPOSER) stan
 .PHONY: lint-stan
 
 lint-stan-ci:
-	$(COMPOSER_RUN) stan:ci
+	$(APP_COMPOSER) stan:ci
 .PHONY: lint-stan-ci
 
 test: ## Run project php-unit and pest tests
-	$(COMPOSER_RUN) test
+	$(APP_COMPOSER) test
 .PHONY: test
 
 test-cc: ## Run project php-unit and pest tests in coverage mode and build report
-	$(COMPOSER_RUN) test:cc
+	$(APP_COMPOSER) test:cc
 .PHONY: test-cc
+
+# Documentation
+# ------------------------------------------------------------------------------------
+docs-deps-update: ## Check for outdated dependencies and automatically update them using pnpm
+	cd docs && $(NPM_RUNNER) run deps:update
+.PHONY: docs-deps-update
+
+docs-deps-install: ## Install dependencies for documentation using pnpm
+	cd docs && $(NPM_RUNNER) install
+.PHONY: docs-deps-install
+
+docs-up: ## Start documentation server
+	cd docs && $(NPM_RUNNER) dev
+.PHONY: docs-up

README.md

@@ -1,8 +1,8 @@
 <br>
 
 <div align="center">
-<img width="456" src="https://raw.githubusercontent.com/wayofdev/ansible-role-tpl/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only">
-<img width="456" src="https://raw.githubusercontent.com/wayofdev/ansible-role-tpl/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only">
+<img width="456" src="https://raw.githubusercontent.com/wayofdev/laravel-package-tpl/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only" alt="WayOfDev Logo for light theme">
+<img width="456" src="https://raw.githubusercontent.com/wayofdev/laravel-package-tpl/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only" alt="WayOfDev Logo for dark theme">
 </div>
 
 
@@ -55,15 +55,15 @@ $ make test
 Code quality using PHPStan:
 
 ```bash
-$ make stan
+$ make lint-stan
 ```
 
 ### → Coding Standards Fixing
 
 Fix code using The PHP Coding Standards Fixer (PHP CS Fixer) to follow our standards:
 
 ```bash
-$ make cs-fix
+$ make lint-php
 ```
 
 <br>

composer.json

@@ -16,20 +16,20 @@
     ],
     "require": {
         "php": "^8.2",
-        "illuminate/contracts": "^v10.13"
+        "illuminate/contracts": "^10.48 || ^11.0"
     },
     "require-dev": {
-        "ergebnis/composer-normalize": "^2.31",
-        "nunomaduro/larastan": "^2.6",
-        "orchestra/testbench": "^8.5",
-        "pestphp/pest": "^2.6",
-        "pestphp/pest-plugin-laravel": "^2.0.0",
+        "ergebnis/composer-normalize": "^2.42",
+        "larastan/larastan": "^2.9",
+        "orchestra/testbench": "^8.5 | ^9.0",
+        "pestphp/pest": "^2.34",
+        "pestphp/pest-plugin-laravel": "^2.3",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-deprecation-rules": "^1.1",
         "phpstan/phpstan-phpunit": "^1.3",
         "phpstan/phpstan-strict-rules": "^1.5",
-        "phpunit/phpunit": "^10.2",
+        "phpunit/phpunit": "^10.5",
         "roave/security-advisories": "dev-latest",
         "wayofdev/cs-fixer-config": "^1.2"
     },
@@ -40,8 +40,10 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "WayOfDev\\Package\\App\\": "tests/app/",
-            "WayOfDev\\Package\\Tests\\": "tests/src/"
+            "WayOfDev\\App\\": "tests/app/",
+            "WayOfDev\\Tests\\": "tests/src/",
+            "WayOfDev\\Database\\Factories\\": "tests/database/factories/",
+            "WayOfDev\\Database\\Seeders\\": "tests/database/seeders/"
         }
     },
     "scripts": {