From 7b061ecbb82e6c7f94346ae373997497eebb754f Mon Sep 17 00:00:00 2001
From: Jon Edvald <edvald@gmail.com>
Date: Mon, 22 Jul 2019 18:34:30 +0200
Subject: [PATCH] docs: improve rendering of "alternatives" schema type

---
 docs/reference/config.md          |  6 +++---
 garden-service/src/docs/config.ts | 20 +++++++++++++++++++-
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/docs/reference/config.md b/docs/reference/config.md
index 41032bd013..04b45dbf6a 100644
--- a/docs/reference/config.md
+++ b/docs/reference/config.md
@@ -136,9 +136,9 @@ A key/value map of variables that modules can reference when using this environm
 
 A list of environments to configure for the project.
 
-| Type           | Required |
-| -------------- | -------- |
-| `alternatives` | No       |
+| Type                            | Required |
+| ------------------------------- | -------- |
+| `array[object] | array[string]` | No       |
 
 Example:
 
diff --git a/garden-service/src/docs/config.ts b/garden-service/src/docs/config.ts
index 3a92aee61a..ebbefdf193 100644
--- a/garden-service/src/docs/config.ts
+++ b/garden-service/src/docs/config.ts
@@ -143,8 +143,11 @@ function normalizeKeyDescription(description: Description): NormalizedDescriptio
   let hasChildren: boolean = false
   let arrayType: string | undefined
   const { type } = description
+  const formattedType = formatType(description)
+
   const children = type === "object" && Object.entries(description.children || {})
   const items = type === "array" && description.items
+
   if (children && children.length > 0) {
     hasChildren = true
   } else if (items && items.length > 0) {
@@ -164,7 +167,6 @@ function normalizeKeyDescription(description: Description): NormalizedDescriptio
   }
 
   const formattedName = type === "array" ? `${description.name}[]` : description.name
-  const formattedType = (type === "array" && arrayType ? `array[${arrayType}]` : type) || ""
 
   return {
     ...description,
@@ -178,6 +180,22 @@ function normalizeKeyDescription(description: Description): NormalizedDescriptio
   }
 }
 
+function formatType(description: Description) {
+  const { type } = description
+  const items = type === "array" && description.items
+
+  if (items && items.length > 0) {
+    // We don't consider an array of primitives as children
+    const arrayType = items[0].type
+    return `array[${arrayType}]`
+  } else if (type === "alternatives") {
+    // returns e.g. "string|number"
+    return uniq(description.alternatives.map(formatType)).join(" | ")
+  } else {
+    return type || ""
+  }
+}
+
 export function getDefaultValue(description: Joi.Description) {
   const defaultSpec = get(description, "flags.default")