feat: update alchemy docs

Author: mychidarko

src/docs/utils/testing.md

@@ -20,30 +20,17 @@ composer require leafs/alchemy
 
 :::
 
-Once installed, Alchemy will automatically set up an `alchemy.yml` file in your project's root along with some dummy tests in a `tests` directory using [Pest PHP Framework](https://pestphp.com/). Alchemy will also add a `test` and `lint` command to your project's `composer.json` file.
+Once installed, Alchemy will automatically set up an `alchemy.yml` file in your project's root which you can use to configure your tests, linting and github actions.
 
-You should be able to run the dummy tests by running the following command:
-
-::: code-group
-
-```bash:no-line-numbers [Leaf CLI]
-leaf run test
-```
-
-```bash:no-line-numbers [Composer]
-composer run test
-```
-
-:::
-
-If you don't want to use Pest, Alchemy also supports PHPUnit. You can change the testing framework by editing the `alchemy.yml` file in your project root, add your tests to the `tests` directory, and run the test command again. You don't need to worry about setting up PHPUnit or Pest as Alchemy will handle that for you.
+## Configuring Alchemy
 
-By default Pest expects a `phpunit.xml` file in your project root, but as it's quite annoying to read, Leaf provides a `alchemy.yml` file in your project root. This file is used to configure Pest and is much easier to read and understand. The `alchemy.yml` file is used to configure Pest and can be used to set up your test environment.
+The `alchemy.yml` file should look something like this:
 
 ```yaml
 app:
   - app
   - src
+
 tests:
   engine: pest
   parallel: true
@@ -53,17 +40,7 @@ tests:
     - '*.test.php'
   coverage:
     processUncoveredFiles: true
-```
 
-## Code Styling
-
-Alchemy allows you to define code styling rules in your `alchemy.yml` file. Alchemy linting uses PHP CS Fixer which is a powerful tool that fixes your code to follow standards; whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc. Of course, all of this is abstracted into the beautiful `alchemy.yml` file.
-
-```yaml
-app:
-  - app
-  - src
-...
 lint:
   preset: 'PSR12'
   ignore_dot_files: true
@@ -76,13 +53,49 @@ lint:
       imports_order: null
       case_sensitive: false
       sort_algorithm: 'alpha'
+
+actions:
+  run:
+    - 'lint'
+    - 'test'
+  php:
+    extensions: json, zip
+    versions:
+      - '8.3'
+  event:
+    - 'push'
+    - 'pull_request'
 ```
 
-As you see, you can set up your code styling rules in the `lint` section of the `alchemy.yml` file. All of [PHP-CS-Fixer Configurator](https://mlocati.github.io/php-cs-fixer-configurator/) rules are supported.
+You can make edits to this file to suit your needs. The `app` key is an array of directories to look for your app files in. The `tests` key is an array of configurations for your tests. The `lint` key is an array of configurations for your code styling checks. Once you're done setting up your `alchemy.yml` file, you can run the setup script.
 
-## Configuring Alchemy
+```bash
+leaf run alchemy # or composer run alchemy
+```
+
+This will install your test engine, PHP CS Fixer and any other dependencies you might need, and then generate dummy tests using the test engine you chose. It will then lint your code, run your tests and generate a coverage report (if you selected that option). It will also add a `test` and `lint` command to your `composer.json` file which you can use to run your tests and lint your code respectively. Finally, it will generate a `.github/workflows` directory with a `test.yml` file and a `lint.yml` file which you can use to run your tests and linting on github actions.
+
+## Configuring Tests
+
+If you don't want to use Pest, Alchemy also supports PHPUnit. You can change the testing framework by editing the `alchemy.yml` file in your project root, add your tests to the `tests` directory, and run the test command again. You don't need to worry about setting up PHPUnit or Pest as Alchemy will handle that for you.
 
-Breaking down the `alchemy.yml` file:
+By default Pest expects a `phpunit.xml` file in your project root, but as it's quite annoying to read, Leaf provides a `alchemy.yml` file in your project root. This file is used to configure Pest and is much easier to read and understand. The `alchemy.yml` file is used to configure Pest and can be used to set up your test environment.
+
+```yaml
+app:
+  - app
+  - src
+
+tests:
+  engine: pest
+  parallel: true
+  paths:
+    - tests
+  files:
+    - '*.test.php'
+  coverage:
+    processUncoveredFiles: true
+```
 
 - `app`: This is a list of directories that contain your application code. Alchemy will use these directories to lint your code and also in code coverage reports.
 
@@ -94,34 +107,22 @@ Breaking down the `alchemy.yml` file:
 
 - `tests.files`: The files to look for tests in.
 
-- `coverage`: Configuration for code coverage.
+- `tests.coverage`: Configuration for code coverage.
   - You can set `processUncoveredFiles` to `true` to process files that are not covered by tests.
   - You can also set `include` to include specific directories in your code coverage report. By default Alchemy will just use the directories defined in the `app` configuration.
 
-- `lint`: Configuration for code styling checks.
-
-- `lint.preset`: The preset to use for code styling checks. You can use any of the presets available to PHP CS Fixer. The default is `PSR12`.
-
-- `lint.ignore_dot_files`: Whether to ignore dot files when linting.
+If you don't want code coverage reports, you can just remove the entire `coverage` section.
 
-- `lint.rules`: An array of rules to use for code styling checks. These rules are the same as the rules available in PHP CS Fixer.
+## Code Styling
 
-Overall, your `alchemy.yml` file should look something like this:
+Alchemy allows you to define code styling rules in your `alchemy.yml` file. Alchemy linting uses PHP CS Fixer which is a powerful tool that fixes your code to follow standards; whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc. Of course, all of this is abstracted into the beautiful `alchemy.yml` file.
 
 ```yaml
 app:
   - app
   - src
 
-tests:
-  engine: pest
-  parallel: true
-  paths:
-    - tests
-  files:
-    - '*.test.php'
-  coverage:
-    processUncoveredFiles: true
+...
 
 lint:
   preset: 'PSR12'
@@ -137,6 +138,42 @@ lint:
       sort_algorithm: 'alpha'
 ```
 
+As you see, you can set up your code styling rules in the `lint` section of the `alchemy.yml` file. All of [PHP-CS-Fixer Configurator](https://mlocati.github.io/php-cs-fixer-configurator/) rules are supported.
+
+- `lint`: Configuration for code styling checks.
+
+- `lint.preset`: The preset to use for code styling checks. You can use any of the presets available to PHP CS Fixer. The default is `PSR12`.
+
+- `lint.ignore_dot_files`: Whether to ignore dot files when linting.
+
+- `lint.rules`: An array of rules to use for code styling checks. These rules are the same as the rules available in PHP CS Fixer.
+
+## Configuring GitHub Actions
+
+Alchemy can also set up GitHub Actions for you. You can configure what it should generate in the `alchemy.yml` file. Once you have set up your `alchemy.yml` file, you can run the `alchemy` command to generate the GitHub Actions files.
+
+```yaml
+actions:
+  run:
+    - 'lint'
+    - 'test'
+  php:
+    extensions: json, zip
+    versions:
+      - '8.3'
+  event:
+    - 'push'
+    - 'pull_request'
+```
+
+- `actions`: Configuration for GitHub Actions. You can remove this entire section if you don't want to generate GitHub Actions.
+
+- `actions.run`: An array of commands to generate GitHub Actions for. The default is `lint` and `test`, but you can remove any command you don't want to generate.
+
+- `actions.php`: Configuration for PHP in GitHub Actions. You can set the PHP extensions to install and the PHP versions to test against.
+
+- `actions.event`: An array of events to generate GitHub Actions for. The default is `push` and `pull_request`, but you can remove any event you don't want to generate.
+
 ## Overriding Alchemy Configuration
 
 Alchemy is designed to be a tool that sets up your tests and code styling checks with minimal configuration. Once you have written all the tests you need for your app and have your code styling checks, there's no longer the need for Alchemy's training wheels. At that point, you can remove Alchemy from your project and use PHPUnit or Pest directly with PHP CS Fixer.