feat(env): update schema

brandingbrand · Dec 9, 2024 · b52e604 · b52e604
1 parent 4ff643f
commit b52e604
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 8 deletions.
diff --git a/packages/app-env/.flagshipcoderc.json b/packages/app-env/.flagshipcoderc.json
@@ -2,23 +2,20 @@
   "options": [
     {
       "flags": "--app-env-initial <value>",
-      "description": "Specifies the initial environment to be used when the application starts.",
+      "description": "Specifies the initial environment to be used when the application starts (e.g., 'development', 'staging', or 'production').",
       "required": true,
-      "valueDescription": "The name of the environment, such as 'development', 'staging', or 'production'.",
       "example": "--app-env-initial development"
     },
     {
       "flags": "--app-env-dir <value>",
-      "description": "Defines the directory path where environment configuration files are stored.",
+      "description": "Defines the directory path where environment configuration files are stored (relative or absolute path).",
       "required": true,
-      "valueDescription": "A relative or absolute path to the environments directory.",
       "example": "--app-env-dir ./config/environments"
     },
     {
       "flags": "--app-env-hide <value>",
-      "description": "Specifies one or more environments to hide from selection or visibility.",
+      "description": "Specifies one or more environments to hide from selection or visibility (comma-separated list).",
       "required": false,
-      "valueDescription": "A comma-separated list of environment names to hide.",
       "example": "--app-env-hide staging,test"
     }
   ]

diff --git a/packages/cli/schema.json b/packages/cli/schema.json
@@ -23,8 +23,22 @@
           },
           "description": {
             "type": "string",
-            "description": "A brief description of the option for the CLI help output.",
-            "minLength": 1
+            "description": "A brief description of the option, including the expected value format or type.",
+            "minLength": 1,
+            "examples": [
+              "Specifies the initial environment to use, e.g., 'development', 'staging', or 'production'.",
+              "Defines the path to the environments directory.",
+              "A comma-separated list of environments to hide."
+            ]
+          },
+          "example": {
+            "type": "string",
+            "description": "A concrete example showing how to use the option.",
+            "examples": [
+              "--app-env-initial development",
+              "--app-env-dir ./config/environments",
+              "--app-env-hide staging,test"
+            ]
           },
           "defaultValue": {
             "description": "The default value for the option if it is not specified by the user.",