Skip to content

Commit

Permalink
Merge pull request #520 from wayofdev/feat/tpl-updates
Browse files Browse the repository at this point in the history
docs: link fixes in readme
  • Loading branch information
lotyp authored Apr 22, 2024
2 parents feedf3f + f325435 commit a39e323
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ help: ## Show this menu
@echo ' 📦 Package laravel-package-tpl (github.com/wayofdev/laravel-package-tpl)'
@echo ' 🤠 Author Andrij Orlenko (github.com/lotyp)'
@echo ' 🏢 ${YELLOW}Org wayofdev (github.com/wayofdev)${RST}'
@echo
.PHONY: help

.EXPORT_ALL_VARIABLES:
Expand Down Expand Up @@ -181,11 +182,11 @@ lint: lint-yaml lint-actions lint-php lint-stan lint-composer lint-audit ## Runs
.PHONY: lint

lint-yaml: ## Lints yaml files inside project
@$(YAML_LINT_RUNNER)
@$(YAML_LINT_RUNNER) | tee -a $(MAKE_LOGFILE)
.PHONY: lint-yaml

lint-actions: ## Lint all github actions
@$(ACTION_LINT_RUNNER)
@$(ACTION_LINT_RUNNER) | tee -a $(MAKE_LOGFILE)
.PHONY: lint-actions

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

#
# Documentation
# Only in case, when `./docs` folder exists and has package.json
# ------------------------------------------------------------------------------------
docs-deps-update: ## Check for outdated dependencies and automatically update them using pnpm
cd docs && $(NPM_RUNNER) run deps:update
Expand All @@ -278,3 +280,7 @@ docs-deps-install: ## Install dependencies for documentation using pnpm
docs-up: ## Start documentation server
cd docs && $(NPM_RUNNER) dev
.PHONY: docs-up

docs-build: ## Build documentation
cd docs && $(NPM_RUNNER) build
.PHONY: docs-up
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ This template repository includes several features to streamline the development
- [Larastan](https://github.com/larastan/larastan) for Laravel-specific static analysis.
- [PHPStan strict rules](https://github.com/phpstan/phpstan-strict-rules) for enforcing strict type checks and standards.
- [Psalm](https://psalm.dev) for finding errors in PHP applications through static analysis.
- [PHP Rector](https://github.com/rectorphp/rector) for automated code upgrades and refactoring, maintaining modern code standards.

### → Coding Standards:

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

- 🤔 [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+)
- 🐛 [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+)
- 🐛 [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+)
- 📖 [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+)
- 👨‍💻 Contribute to the code

Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "wayofdev/laravel-package-tpl",
"description": "PHP package template with GitHub Actions",
"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.",
"license": "MIT",
"type": "library",
"authors": [
Expand Down Expand Up @@ -88,14 +88,14 @@
"cs:fix": "php vendor/bin/php-cs-fixer fix -v",
"infect": "XDEBUG_MODE=coverage php vendor/bin/roave-infection-static-analysis-plugin --configuration=infection.json.dist",
"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",
"psalm": "php vendor/bin/psalm --show-info=true",
"psalm:baseline": "php vendor/bin/psalm --set-baseline=psalm-baseline.xml",
"psalm:ci": "php vendor/bin/psalm --output-format=github --shepherd --show-info=false --stats --threads=4",
"refactor": "php vendor/bin/rector process --config=rector.php",
"refactor:ci": "php vendor/bin/rector process --config=rector.php --dry-run --ansi",
"stan": "php vendor/bin/phpstan analyse --memory-limit=2G",
"stan:baseline": "php vendor/bin/phpstan analyse --generate-baseline --memory-limit=2G --allow-empty-baseline",
"stan:ci": "php vendor/bin/phpstan analyse --memory-limit=2G --error-format=github",
"psalm": "php vendor/bin/psalm --show-info=true",
"psalm:baseline": "php vendor/bin/psalm --set-baseline=psalm-baseline.xml",
"psalm:ci": "php vendor/bin/psalm --output-format=github --shepherd --show-info=false --stats --threads=4",
"test": "XDEBUG_MODE=coverage php vendor/bin/pest",
"test:cc": "XDEBUG_MODE=coverage php vendor/bin/pest --coverage --coverage-clover=.build/phpunit/logs/clover.xml"
}
Expand Down

0 comments on commit a39e323

Please sign in to comment.