Skip to content

Commit a39e323

Browse files
authored
Merge pull request #520 from wayofdev/feat/tpl-updates
docs: link fixes in readme
2 parents feedf3f + f325435 commit a39e323

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ help: ## Show this menu
8888
@echo ' 📦 Package laravel-package-tpl (github.com/wayofdev/laravel-package-tpl)'
8989
@echo ' 🤠 Author Andrij Orlenko (github.com/lotyp)'
9090
@echo ' 🏢 ${YELLOW}Org wayofdev (github.com/wayofdev)${RST}'
91+
@echo
9192
.PHONY: help
9293

9394
.EXPORT_ALL_VARIABLES:
@@ -181,11 +182,11 @@ lint: lint-yaml lint-actions lint-php lint-stan lint-composer lint-audit ## Runs
181182
.PHONY: lint
182183

183184
lint-yaml: ## Lints yaml files inside project
184-
@$(YAML_LINT_RUNNER)
185+
@$(YAML_LINT_RUNNER) | tee -a $(MAKE_LOGFILE)
185186
.PHONY: lint-yaml
186187

187188
lint-actions: ## Lint all github actions
188-
@$(ACTION_LINT_RUNNER)
189+
@$(ACTION_LINT_RUNNER) | tee -a $(MAKE_LOGFILE)
189190
.PHONY: lint-actions
190191

191192
lint-php: prepare ## Fixes code to follow coding standards using php-cs-fixer
@@ -266,6 +267,7 @@ commit:
266267

267268
#
268269
# Documentation
270+
# Only in case, when `./docs` folder exists and has package.json
269271
# ------------------------------------------------------------------------------------
270272
docs-deps-update: ## Check for outdated dependencies and automatically update them using pnpm
271273
cd docs && $(NPM_RUNNER) run deps:update
@@ -278,3 +280,7 @@ docs-deps-install: ## Install dependencies for documentation using pnpm
278280
docs-up: ## Start documentation server
279281
cd docs && $(NPM_RUNNER) dev
280282
.PHONY: docs-up
283+
284+
docs-build: ## Build documentation
285+
cd docs && $(NPM_RUNNER) build
286+
.PHONY: docs-up

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ This template repository includes several features to streamline the development
5757
- [Larastan](https://github.com/larastan/larastan) for Laravel-specific static analysis.
5858
- [PHPStan strict rules](https://github.com/phpstan/phpstan-strict-rules) for enforcing strict type checks and standards.
5959
- [Psalm](https://psalm.dev) for finding errors in PHP applications through static analysis.
60+
- [PHP Rector](https://github.com/rectorphp/rector) for automated code upgrades and refactoring, maintaining modern code standards.
6061

6162
### → Coding Standards:
6263

@@ -160,7 +161,7 @@ This project has a [security policy](.github/SECURITY.md).
160161
Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:
161162

162163
- 🤔 [Suggest a feature](https://github.com/wayofdev/laravel-package-tpl/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+)
163-
- 🐛 [Report an issue](https://github.com/wayofdev/laravel-package-tpl/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+)
164+
- 🐛 [Report an issue](https://github.com/wayofdev/laravel-package-tpl/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+)
164165
- 📖 [Improve documentation](https://github.com/wayofdev/laravel-package-tpl/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+)
165166
- 👨‍💻 Contribute to the code
166167

composer.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "wayofdev/laravel-package-tpl",
3-
"description": "PHP package template with GitHub Actions",
3+
"description": "🚀 Jump-start your Laravel package development with our pre-configured Composer template, designed for seamless integration. This template includes essential tools such as PHPUnit, PHPStan, GitHub Actions, and Docker to streamline your workflow and enhance productivity.",
44
"license": "MIT",
55
"type": "library",
66
"authors": [
@@ -88,14 +88,14 @@
8888
"cs:fix": "php vendor/bin/php-cs-fixer fix -v",
8989
"infect": "XDEBUG_MODE=coverage php vendor/bin/roave-infection-static-analysis-plugin --configuration=infection.json.dist",
9090
"infect:ci": "XDEBUG_MODE=coverage php vendor/bin/roave-infection-static-analysis-plugin --ansi --configuration=infection.json.dist --logger-github --ignore-msi-with-no-mutations --only-covered",
91+
"psalm": "php vendor/bin/psalm --show-info=true",
92+
"psalm:baseline": "php vendor/bin/psalm --set-baseline=psalm-baseline.xml",
93+
"psalm:ci": "php vendor/bin/psalm --output-format=github --shepherd --show-info=false --stats --threads=4",
9194
"refactor": "php vendor/bin/rector process --config=rector.php",
9295
"refactor:ci": "php vendor/bin/rector process --config=rector.php --dry-run --ansi",
9396
"stan": "php vendor/bin/phpstan analyse --memory-limit=2G",
9497
"stan:baseline": "php vendor/bin/phpstan analyse --generate-baseline --memory-limit=2G --allow-empty-baseline",
9598
"stan:ci": "php vendor/bin/phpstan analyse --memory-limit=2G --error-format=github",
96-
"psalm": "php vendor/bin/psalm --show-info=true",
97-
"psalm:baseline": "php vendor/bin/psalm --set-baseline=psalm-baseline.xml",
98-
"psalm:ci": "php vendor/bin/psalm --output-format=github --shepherd --show-info=false --stats --threads=4",
9999
"test": "XDEBUG_MODE=coverage php vendor/bin/pest",
100100
"test:cc": "XDEBUG_MODE=coverage php vendor/bin/pest --coverage --coverage-clover=.build/phpunit/logs/clover.xml"
101101
}

0 commit comments

Comments
 (0)