From 71edc4278e27e4850e182ea9e19ee39b0af1e33c Mon Sep 17 00:00:00 2001
From: Brian Henry <BrianHenryIE@gmail.com>
Date: Thu, 30 Nov 2023 11:08:35 -0800
Subject: [PATCH] Add `scripts-descriptions`

---
 CONTRIBUTING.md |  5 +++++
 composer.json   | 14 +++++++++++++-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 382ec7ab..030daf36 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,9 @@
 
+```bash
+# List the available scripts
+composer run-script -l
+```
+
 `composer show --self`
 `composer show --direct`
 `composer show --outdated`
diff --git a/composer.json b/composer.json
index fbb2fd53..8c77c13f 100644
--- a/composer.json
+++ b/composer.json
@@ -164,7 +164,7 @@
         "restore-acceptance-database": [
             "export $(grep -v '^#' .env.testing | xargs); mysql $TEST_SITE_DB_NAME < tests/_data/dump.sql"
         ],
-        "coverage-tests": [
+        "test-coverage": [
             "codecept run unit --coverage unit.cov",
             "codecept run wpunit --coverage wpunit.cov",
             "phpcov merge --clover tests/_output/clover.xml --html tests/_output/html tests/_output;",
@@ -188,5 +188,17 @@
         "github-actions":  [
             "act -P ubuntu-latest=shivammathur/node:latest"
         ]
+    },
+    "scripts-descriptions": {
+        "create-symlinks": "Create sylimks between /wordpress, /wp-content and the root plugin for convenience.",
+        "configure-phpstorm": "Add directories to PhpStorm's excluded folders list and add PHPUnit run configurations.",
+        "prefix-namespaces": "Prefix the namespaces of Composer packages using brianhenryie/strauss to avoid conflicts with other plugins.",
+        "test": "Run PHPUnit tests",
+        "test-coverage": "Run PHPUnit tests with coverage. Use `XDEBUG_MODE=coverage composer test-coverage` to run, `open ./coverage-report/index.html` to view.",
+        "cs-fix": "Run PHP Code Beautifier and Fixer",
+        "cs-fix-changes": "Run @cs-fix on files since the last commmit",
+        "create-plugin-archive": "Generate i18n .pot and create a plugin .zip using the exclusion list in .distignore",
+        "php-compatibility": "Run PHPCompatibilityWP",
+        "github-actions": "Run the GitHub Actions workflow locally using nektos/act"
     }
 }