docs(docs): writting docs

libs/cli/src/generators/challenge/schema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "GeneratorNxChallenge",
+  "title": "Creates the setup for a new Angular Challenge.",
+  "description": "Creates the boilerplate for an Angular Challenge.",
+  "type": "object",
+  "cli": "nx",
+  "properties": {
+    "name": {
+      "description": "The name of the application. (should be in kebab case)",
+      "type": "string",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the application?",
+      "pattern": "^[a-zA-Z].*$"
+    },
+    "title": {
+      "description": "Title of your challenge. (use quote to add spaces)",
+      "type": "string",
+      "maxLength": "25",
+      "$default": {
+        "$source": "argv",
+        "index": 1
+      },
+      "x-priority": "important"
+    },
+    "challengeDifficulty": {
+      "description": "The difficulty of the challenge.",
+      "type": "string",
+      "x-priority": "important",
+      "x-prompt": {
+        "message": "Which category would you like?",
+        "type": "list",
+        "items": [
+          {
+            "value": "🟢",
+            "label": "Easy"
+          },
+          {
+            "value": "🟠",
+            "label": "Medium"
+          },
+          {
+            "value": "🔴",
+            "label": "Hard"
+          }
+        ]
+      }
+    },
+    "docRepository": {
+      "type": "string",
+      "description": "The category of your challenge.",
+      "x-priority": "important",
+      "x-prompt": {
+        "message": "Which category would you like?",
+        "type": "list",
+        "items": [
+          {
+            "value": "angular",
+            "label": "Angular"
+          },
+          {
+            "value": "angular-performance",
+            "label": "Angular Performance"
+          },
+          {
+            "value": "ngrx",
+            "label": "NgRx"
+          },
+          {
+            "value": "rxjs",
+            "label": "RxJs"
+          },
+          {
+            "value": "nx",
+            "label": "Nx"
+          },
+          {
+            "value": "testing",
+            "label": "Testing"
+          },
+          {
+            "value": "typescript",
+            "label": "Typescript"
+          }
+        ]
+      }
+    },
+    "directory": {
+      "description": "The directory of the new application.",
+      "type": "string",
+      "x-priority": "important"
+    },
+    "addTest": {
+      "description": "add spec files.",
+      "type": "boolean",
+      "default": true,
+      "alias": "S"
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    },
+    "rootProject": {
+      "description": "Create an application at the root of the workspace.",
+      "type": "boolean",
+      "default": false,
+      "hidden": true,
+      "x-priority": "internal"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["name", "title", "challengeDifficulty", "docRepository"]
+}