chore: make linters happy

Author: dunglas

.github/workflows/ci.yml renamed to .github/workflows/ci.yaml

@@ -1,3 +1,4 @@
+---
 name: CI
 
 on:

compose.override.yaml

@@ -1,3 +1,4 @@
+---
 # Development environment override
 services:
   php:

compose.prod.yaml

@@ -1,3 +1,4 @@
+---
 # Production environment override
 services:
   php:

compose.yaml

@@ -1,3 +1,4 @@
+---
 services:
   php:
     image: ${IMAGES_PREFIX:-}app-php

docs/build.md

@@ -9,6 +9,7 @@ For instance, use the following command to install Symfony 6.4:
 On Linux:
 
     SYMFONY_VERSION=6.4.* docker compose up -d --wait
+
 On Windows:
 
     set SYMFONY_VERSION=6.4.* && docker compose up -d --wait&set SYMFONY_VERSION=
@@ -25,7 +26,7 @@ On Linux:
     STABILITY=dev docker compose up -d --wait
 
 On Windows:
-    
+
     set STABILITY=dev && docker compose up -d --wait&set STABILITY=
 
 ## Customizing the Server Name

docs/makefile.md

@@ -32,7 +32,7 @@ And rebuild the PHP image.
 
 ## The template
 
-```Makefile
+```makefile
 # Executables (local)
 DOCKER_COMP = docker compose
 

docs/production.md

@@ -68,12 +68,12 @@ docker compose -f compose.yaml -f compose.prod.yaml up -d --wait
 
 Be sure to replace `your-domain-name.example.com` with your actual domain name and to set the values of `APP_SECRET`, `CADDY_MERCURE_JWT_SECRET` to cryptographically secure random values.
 
-Your server is up and running, and a HTTPS certificate has been automatically generated for you.
-Go to `https://your-domain-name.example.com` and enjoy!
-
 > [!NOTE]
 > The worker mode of FrankenPHP is enabled by default in prod. To disable it, add the env var FRANKENPHP_CONFIG as empty to the compose.prod.yaml file.
 
+Your server is up and running, and a HTTPS certificate has been automatically generated for you.
+Go to `https://your-domain-name.example.com` and enjoy!
+
 > [!CAUTION]
 > Docker can have a cache layer, make sure you have the right build for each deployment or rebuild your project with --no-cache option to avoid cache issue.
 

docs/tls.md

@@ -3,15 +3,24 @@
 ## Trusting the Authority
 
 With a standard installation, the authority used to sign certificates generated in the Caddy container is not trusted by your local machine.
-You must add the authority to the trust store of the host :
+You must add the authority to the trust store of the host.
 
+Mac:
+
+```console
+docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /tmp/root.crt && sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/root.crt
+```
+
+Linux:
+
+```console
+docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /usr/local/share/ca-certificates/root.crt && sudo update-ca-certificates
 ```
-# Mac
-$ docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /tmp/root.crt && sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/root.crt
-# Linux
-$ docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /usr/local/share/ca-certificates/root.crt && sudo update-ca-certificates
-# Windows
-$ docker compose cp php:/data/caddy/pki/authorities/local/root.crt %TEMP%/root.crt && certutil -addstore -f "ROOT" %TEMP%/root.crt
+
+Windows:
+
+```console
+docker compose cp php:/data/caddy/pki/authorities/local/root.crt %TEMP%/root.crt && certutil -addstore -f "ROOT" %TEMP%/root.crt
 ```
 
 ## Using Custom TLS Certificates
@@ -22,10 +31,10 @@ But sometimes you may prefer using custom certificates.
 For instance, to use self-signed certificates created with [mkcert](https://github.com/FiloSottile/mkcert) do as follows:
 
 1. Locally install `mkcert`
-2. Create the folder storing the certs: 
-   `mkdir frankenphp/certs -p`
+2. Create the folder storing the certs:
+    `mkdir frankenphp/certs -p`
 3. Generate the certificates for your local host (example: "server-name.localhost"):
-   `mkcert -cert-file frankenphp/certs/tls.pem -key-file frankenphp/certs/tls.key "server-name.localhost"`
+    `mkcert -cert-file frankenphp/certs/tls.pem -key-file frankenphp/certs/tls.key "server-name.localhost"`
 4. Add these lines to the `./compose.override.yaml` file about `CADDY_SERVER_EXTRA_DIRECTIVES` environment and volume for the `php` service :
     ```diff
     php:

docs/troubleshooting.md

@@ -4,9 +4,9 @@
 
 If you work on linux and cannot edit some of the project files right after the first installation, you can run `docker compose run --rm php chown -R $(id -u):$(id -g) .` to set yourself as owner of the project files that were created by the docker container.
 
-## HTTPs and Redirects
+## HTTPS and Redirects
 
-If Symfony is generating an internal redirect for an `https://` url, but the resulting url is `http://`, you have to uncomment the `TRUSTED_PROXIES` setting in your `.env` file.
+If Symfony is generating an internal redirect for an `https://` URL, but the resulting URL is `http://`, you have to uncomment the `TRUSTED_PROXIES` setting in your `.env` file.
 For more details see the [Symfony internal redirect documentation](https://symfony.com/doc/current/routing.html#redirecting-to-urls-and-routes-directly-from-a-route).
 
 ## TLS/HTTPS Issues

docs/xdebug.md

@@ -8,17 +8,17 @@ It can be enabled by setting the `XDEBUG_MODE` environment variable to `debug`.
 
 On Linux and Mac:
 
-```
+```console
 XDEBUG_MODE=debug docker compose up -d
 ```
 
 On Windows:
 
-```
+```console
 set XDEBUG_MODE=debug&& docker compose up -d&set XDEBUG_MODE=
 ```
 
-## Debugging with Xdebug and PHPStorm
+## Debugging with Xdebug and PhpStorm
 
 First, [create a PHP debug remote server configuration](https://www.jetbrains.com/help/phpstorm/creating-a-php-debug-server-configuration.html):
 
@@ -33,12 +33,12 @@ First, [create a PHP debug remote server configuration](https://www.jetbrains.co
 
 You can now use the debugger!
 
-1. In PHPStorm, open the `Run` menu and click on `Start Listening for PHP Debug Connections`
+1. In PhpStorm, open the `Run` menu and click on `Start Listening for PHP Debug Connections`
 2. Add the `XDEBUG_SESSION=PHPSTORM` query parameter to the URL of the page you want to debug, or use [other available triggers](https://xdebug.org/docs/step_debug#activate_debugger)
 
-    Alternatively, you can use [the **Xdebug extension**](https://xdebug.org/docs/step_debug#browser-extensions) for your preferred web browser. 
+    Alternatively, you can use [the **Xdebug extension**](https://xdebug.org/docs/step_debug#browser-extensions) for your preferred web browser.
 
-3. On command line, we might need to tell PHPStorm which [path mapping configuration](https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging-cli.html#configure-path-mappings) should be used, set the value of the PHP_IDE_CONFIG environment variable to `serverName=symfony`, where `symfony` is the name of the debug server configured higher.
+3. On command line, we might need to tell PhpStorm which [path mapping configuration](https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging-cli.html#configure-path-mappings) should be used, set the value of the PHP_IDE_CONFIG environment variable to `serverName=symfony`, where `symfony` is the name of the debug server configured higher.
 
     Example: