feat: better names for oneOf/anyOf selector (#151)

* feat: better names for oneOf/anyOf selector * chore: update JST * fix: only apply $ref based naming for oneOf/anyOf * chore: add missing snapshot patch * chore: capitalize -> firstUpper * chore: missing option
stoplightio · Jun 22, 2021 · 3ceb51e · 3ceb51e
1 parent 5fe5348
commit 3ceb51e
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 23 deletions.
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
   "dependencies": {
     "@fortawesome/free-solid-svg-icons": "^5.15.2",
     "@stoplight/json": "^3.10.0",
-    "@stoplight/json-schema-tree": "^2.0.1",
+    "@stoplight/json-schema-tree": "^2.1.0",
     "@stoplight/react-error-boundary": "^1.0.0",
     "@types/json-schema": "^7.0.7",
     "classnames": "^2.2.6",

diff --git a/src/__fixtures__/combiners/oneof-within-array-item.json b/src/__fixtures__/combiners/oneof-within-array-item.json
@@ -15,17 +15,21 @@
         }
       },
       {
-        "type": "object",
-        "title": "B",
-        "properties": {
-          "foo": {
-            "type": "number"
-          },
-          "bar": {
-            "type": "string"
-          }
-        }
+        "$ref": "#/__bundled__/someBundledObj"
       }
     ]
+  },
+  "__bundled__": {
+    "someBundledObj": {
+      "type": "object",
+      "properties": {
+        "foo": {
+          "type": "number"
+        },
+        "bar": {
+          "type": "string"
+        }
+      }
+    }
   }
 }
diff --git a/src/__tests__/__snapshots__/index.spec.tsx.snap b/src/__tests__/__snapshots__/index.spec.tsx.snap
@@ -2753,7 +2753,7 @@ exports[`HTML Output should match combiners/oneof-within-array-item.json 1`] = `
               <select size=\\"2\\">
                 <option></option>
                 <option value=\\"0\\">1. array of A-s</option>
-                <option value=\\"1\\">2. array of B-s</option>
+                <option value=\\"1\\">2. array of SomeBundledObj-s</option>
               </select>
             </label>
           </div>

diff --git a/src/components/SchemaRow/useChoices.ts b/src/components/SchemaRow/useChoices.ts
@@ -15,7 +15,7 @@ function calculateChoiceTitle(node: SchemaNode, isPlural: boolean): string {
   const complexObjectSuffix = isPlural ? '-s' : '';
   const primitiveSuffix = isPlural ? 's' : '';
   if (isRegularNode(node)) {
-    const realName = printName(node);
+    const realName = printName(node, { shouldUseRefNameFallback: true });
     if (realName) {
       return realName + complexObjectSuffix;
     }

diff --git a/src/utils/printName.ts b/src/utils/printName.ts
@@ -1,23 +1,35 @@
+import { getLastPathSegment } from '@stoplight/json';
 import { isReferenceNode, isRegularNode, RegularNode, SchemaNodeKind } from '@stoplight/json-schema-tree';
+import upperFirst from 'lodash/upperFirst.js';
 
 import { isNonNullable } from '../guards/isNonNullable';
 import { isComplexArray, isPrimitiveArray } from '../tree';
 
-export function printName(schemaNode: RegularNode): string | null {
+type PrintNameOptions = {
+  shouldUseRefNameFallback?: boolean;
+};
+
+export function printName(
+  schemaNode: RegularNode,
+  { shouldUseRefNameFallback = false }: PrintNameOptions = {},
+): string | undefined {
   if (
     schemaNode.primaryType !== SchemaNodeKind.Array ||
     !isNonNullable(schemaNode.children) ||
     schemaNode.children.length === 0
   ) {
-    return schemaNode.title;
+    return schemaNode.title ?? (shouldUseRefNameFallback ? getNodeNameFromOriginalRef(schemaNode) : undefined);
   }
 
-  return printArrayName(schemaNode);
+  return printArrayName(schemaNode, { shouldUseRefNameFallback });
 }
 
-function printArrayName(schemaNode: RegularNode): string | null {
+function printArrayName(
+  schemaNode: RegularNode,
+  { shouldUseRefNameFallback = false }: PrintNameOptions,
+): string | undefined {
   if (!isNonNullable(schemaNode.children) || schemaNode.children.length === 0) {
-    return schemaNode.title;
+    return schemaNode.title ?? (shouldUseRefNameFallback ? getNodeNameFromOriginalRef(schemaNode) : undefined);
   }
 
   if (schemaNode.children.length === 1 && isReferenceNode(schemaNode.children[0])) {
@@ -48,6 +60,8 @@ function printArrayName(schemaNode: RegularNode): string | null {
     const firstChild = schemaNode.children[0];
     if (firstChild.title) {
       return `array of ${firstChild.title}-s`;
+    } else if (shouldUseRefNameFallback && getNodeNameFromOriginalRef(schemaNode)) {
+      return `array of ${getNodeNameFromOriginalRef(schemaNode)}-s`;
     } else if (firstChild.primaryType) {
       return `array of ${firstChild.primaryType}s`;
     } else if (firstChild.combiners?.length) {
@@ -56,5 +70,12 @@ function printArrayName(schemaNode: RegularNode): string | null {
     return 'array';
   }
 
-  return null;
+  return undefined;
+}
+
+function getNodeNameFromOriginalRef(node: RegularNode) {
+  if (typeof node.originalFragment.$ref === 'string') {
+    return upperFirst(getLastPathSegment(node.originalFragment.$ref));
+  }
+  return undefined;
 }
diff --git a/yarn.lock b/yarn.lock
@@ -2393,10 +2393,10 @@
     json-schema-compare "^0.2.2"
     lodash "^4.17.4"
 
-"@stoplight/json-schema-tree@^2.0.1":
-  version "2.0.1"
-  resolved "https://registry.yarnpkg.com/@stoplight/json-schema-tree/-/json-schema-tree-2.0.1.tgz#0affbc2c71b7cffab275385b367332fe0eaaf04e"
-  integrity sha512-K+NP7dNbcwoA3OUuGsG0uZ6PJjVSP9kq0QN5+j9uHCshbLfUHwtgx9JXCX64HFWyew6HhF9wUTnzFGw/vvo+5g==
+"@stoplight/json-schema-tree@^2.1.0":
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/@stoplight/json-schema-tree/-/json-schema-tree-2.1.0.tgz#a921d6682971f5734a163ca11817ebd9f0266fbf"
+  integrity sha512-i4OXbL3A7aslphG+ezxL+ld6dsDtQhw+Iy2jxQYSIjuapvPeP7uY6MxAnbJkOvnRtefYYgCG0pl26xfjrt6n0Q==
   dependencies:
     "@stoplight/json" "^3.12.0"
     "@stoplight/json-schema-merge-allof" "^0.7.5"