Add pipeline check that ensures docs and commands synchronisation (#117)

Author: wolfo951

.github/workflows/ci.yaml

@@ -42,6 +42,18 @@ jobs:
           name: build
           path: dist
 
+      - name: Run docs-generator
+        run: npm run docs-generator
+
+      - name: Check for documentation changes
+        run: |
+          if [[ -n $(git status --porcelain docs/) ]]; then
+            echo "The following files in the docs directory and/or the commands related to them have been modified:"
+            git status --porcelain docs/
+            echo "Please run 'npm run docs-generator' locally and commit the changes."
+            exit 1
+          fi
+
       - name: Audit
         run: npm audit
 

CONTRIBUTING.md

@@ -63,6 +63,10 @@ git checkout -b johndoe/add-auth-command
 ### **3. Make Your Changes**
 - Follow existing code patterns and structure.
 - Write clear commit messages.
+- **If you add a new command or modify documentation**, run the following command to ensure commands and documentation are synchronized:
+  ```bash
+  npm run docs-generator
+  ```
 
 ### **4. Commit Your Changes**
 ```bash

package.json

@@ -165,7 +165,8 @@
     "test:formatting": "mocha --forbid-only \"integration-tests/main-cases/formatting.test.ts\"",
     "test:service": "mocha --forbid-only \"integration-tests/main-cases/service-client.test.ts\"",
     "test:native": "mocha --forbid-only \"integration-tests/main-cases/native-client.test.ts\"",
-    "version": "oclif readme && git add README.md"
+    "version": "oclif readme && git add README.md",
+    "docs-generator": "node ./bin/run.js docs-generator"
   },
   "types": "dist/index.d.ts"
 }