Skip to content

Commit 17add53

Browse files
COilCOil
authored
docs: added Make and Castor outputs examples (#246)
1 parent 4b299c2 commit 17add53

File tree

4 files changed

+114
-3
lines changed

4 files changed

+114
-3
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ Have a look at the specific [documentation](https://github.com/strangebuzz/Micro
150150
**MicroSymfony** ships these features, ready to use:
151151

152152
* Two task runners
153-
* [Make](https://www.gnu.org/software/make/) ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/Makefile)) ([demo](https://www.strangebuzz.com/en/blog/introducing-the-microsymfony-application-template#h3_4_1))
154-
* [Castor](https://github.com/jolicode/castor) ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/castor.php)) ([demo](https://www.strangebuzz.com/en/blog/introducing-the-microsymfony-application-template#h3_4_2))
153+
* [Make](https://www.gnu.org/software/make/) ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/Makefile)) ([demo](https://www.strangebuzz.com/en/blog/introducing-the-microsymfony-application-template#h3_4_1)) ([output](https://github.com/strangebuzz/MicroSymfony/blob/main/docs/make-output.txt))
154+
* [Castor](https://github.com/jolicode/castor) ([source](https://github.com/strangebuzz/MicroSymfony/blob/main/castor.php)) ([demo](https://www.strangebuzz.com/en/blog/introducing-the-microsymfony-application-template#h3_4_2)) ([output](https://github.com/strangebuzz/MicroSymfony/blob/main/docs/castor-output.txt))
155155
* Static analysis with [PHPStan 2](https://github.com/phpstan/phpstan)
156156
* [Configuration](https://github.com/strangebuzz/MicroSymfony/blob/main/phpstan.neon)
157157
* Coding standards with [php-cs-fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer)

‎castor.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ function getParameters(): array
127127
return [$filter, $options];
128128
}
129129

130-
#[AsTask(name: 'all', namespace: 'test', description: 'Run tests with optional filter and options, eg: "filter=slug options=--testdox castor test")', aliases: ['test'])]
130+
#[AsTask(name: 'all', namespace: 'test', description: 'Run tests with optional filter and options, eg: "filter=slug options=--testdox castor test"', aliases: ['test'])]
131131
function test_all(): int
132132
{
133133
title('test:all');

‎docs/castor-output.txt‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
2+
█████████ █████
3+
███░░░░░███ ░░███
4+
███ ░░░ ██████ █████ ███████ ██████ ████████
5+
░███ ░░░░░███ ███░░ ░░░███░ ███░░███░░███░░███
6+
░███ ███████ ░░█████ ░███ ░███ ░███ ░███ ░░░
7+
░░███ ███ ███░░███ ░░░░███ ░███ ███░███ ░███ ░███
8+
░░█████████ ░░████████ ██████ ░░█████ ░░██████ █████
9+
░░░░░░░░░ ░░░░░░░░ ░░░░░░ ░░░░░ ░░░░░░ ░░░░░
10+
11+
castor v1.1.0
12+
13+
Usage:
14+
command [options] [arguments]
15+
16+
Options:
17+
-h, --help Display help for the given command. When no command is given display help for the list command
18+
--silent Do not output any message
19+
-q, --quiet Only errors are displayed. All other output is suppressed
20+
-V, --version Display this application version
21+
--ansi|--no-ansi Force (or disable --no-ansi) ANSI output
22+
-n, --no-interaction Do not ask any interactive question
23+
--no-remote Skip the import of all remote remote packages
24+
--update-remotes Force the update of remote packages
25+
--castor-file[=CASTOR-FILE] Specify an alternative castor file to use instead of the default "castor.php"
26+
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
27+
28+
Available commands:
29+
completion Dump the shell completion script
30+
help Display help for a command
31+
list List commands
32+
app
33+
app:load-fixtures [load-fixtures] Load the database fixtures
34+
castor
35+
castor:composer [composer] Interact with built-in Composer for castor
36+
castor:execute [execute] Execute a remote task from a packagist directory
37+
ci
38+
ci:all [ci] Run CI locally
39+
ci:lint-js-css Lint JS/CSS files with Biome (CI)
40+
ci:lint-php Lint PHP files with php-cs-fixer (for CI)
41+
fix
42+
fix:all [fix] Run all fixers
43+
fix:js-css [fix-js-css] Format JS/CSS files with Biome
44+
fix:php [fix-php] Fix PHP files with php-cs-fixer (ignore PHP 8.4 warnings)
45+
helpers
46+
helpers:check-requirements [check-requirements] Checks requirements for running Symfony
47+
helpers:versions [versions] Output current stack versions
48+
lint
49+
lint:all [lint] Run all lints
50+
lint:container [lint-container] Lint the Symfony DI container
51+
lint:doctrine [lint-doctrine] Validate Doctrine schema
52+
lint:js-css [lint-js-css] Lint JS/CSS files with Biome
53+
lint:php [lint-php] Lint PHP files with php-cs-fixer (report only)
54+
lint:stan [stan] Run PHPStan
55+
lint:twig [lint-twig] Lint Twig files
56+
prod
57+
prod:deploy [deploy] Simple manual deploy on a VPS (this is to update the demo site https://microsymfony.ovh/)
58+
prod:le-renew [le-renew] Renew Let's Encrypt HTTPS certificates
59+
symfony
60+
symfony:go-dev [go-dev] Switch to the development environment
61+
symfony:go-prod [go-prod] Switch to the production environment
62+
symfony:purge [purge] Purge all Symfony cache and logs
63+
symfony:start [start] Serve the application with the Symfony binary
64+
symfony:stop [stop] Stop the web server
65+
test
66+
test:all [test] Run tests with optional filter and options, eg: "filter=slug options=--testdox castor test")
67+
test:api [test-api] Run API tests only
68+
test:cov-report [cov-report] Open the PHPUnit code coverage report (var/coverage/index.html)
69+
test:coverage [coverage] Generate the HTML PHPUnit code coverage report (stored in var/coverage)
70+
test:e2e [test-e2e] Run E2E tests only
71+
test:functional [test-functional] Run functional tests only
72+
test:integration [test-integration] Run integration tests only
73+
test:unit [test-unit] Run unit tests only

‎docs/make-output.txt‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
—— 🎶 The MicroSymfony Makefile 🎶 ——————————————————————————————————————————
2+
help Outputs this help screen
3+
—— Symfony binary 💻 ————————————————————————————————————————————————————————
4+
start Serve the application with the Symfony binary and load fixtures
5+
stop Stop the web server
6+
—— Symfony 🎶 ——————————————————————————————————————————————————————————————
7+
go-prod Switch to the production environment
8+
go-dev Switch to the development environment
9+
warmup Warmup the dev cache for the static analysis
10+
purge Purge all Symfony cache and logs
11+
load-fixtures Reset migrations and load the database fixtures
12+
—— Tests ✅ —————————————————————————————————————————————————————————————————
13+
test Run tests with optional suite, filter and options (to debug use "make test options=--debug")
14+
test-api Run API tests only
15+
test-e2e Run E2E tests only
16+
test-functional Run functional tests only
17+
test-integration Run integration tests only
18+
test-unit Run unit tests only
19+
coverage Generate the HTML PHPUnit code coverage report (stored in var/coverage)
20+
cov-report Open the PHPUnit code coverage report (var/coverage/index.html)
21+
—— Coding standards/lints ✨ ————————————————————————————————————————————————
22+
stan Run the PHPStan static analysis
23+
fix-php Fix PHP files with php-cs-fixer (ignore PHP version warning)
24+
fix-js-css Format JS/CSS files with Biome
25+
lint-php Lint PHP files with php-cs-fixer (report only)
26+
lint-js-css Lint JS/CSS files with Biome
27+
lint-container Lint the Symfony DI container
28+
lint-twig Lint Twig files
29+
lint-doctrine Validate Doctrine schema
30+
fix Run all fixers
31+
lint Run all linters
32+
ci Run CI locally
33+
—— Other tools and helpers 🔨 ———————————————————————————————————————————————
34+
versions Output current stack versions
35+
check-requirements Checks requirements for running Symfony
36+
—— Deploy & Prod 🚀 —————————————————————————————————————————————————————————
37+
deploy Simple manual deploy on a VPS (this is to update the demo site https://microsymfony.ovh/)
38+
le-renew Renew Let's Encrypt HTTPS certificates

0 commit comments

Comments
 (0)