fix: labels in object arrays

kickstartDS · Oct 11, 2024 · e67e073 · e67e073
1 parent b73dc5f
commit e67e073
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 4 deletions.
diff --git a/common/changes/@kickstartds/jsonschema2stackbit/main_2024-10-11-15-12.json b/common/changes/@kickstartds/jsonschema2stackbit/main_2024-10-11-15-12.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@kickstartds/jsonschema2stackbit",
+      "comment": "use correct labels in arrays of objects",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@kickstartds/jsonschema2stackbit"
+}
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/tools/jsonschema2stackbit/package.json b/tools/jsonschema2stackbit/package.json
@@ -20,7 +20,8 @@
   "dependencies": {
     "@kickstartds/jsonschema-utils": "workspace:*",
     "ajv": "^8.12.0",
-    "object-traversal": "^1.0.1"
+    "object-traversal": "^1.0.1",
+    "pluralize": "^8.0.0"
   },
   "devDependencies": {
     "@rushstack/eslint-config": "^3.2.0",
@@ -31,6 +32,7 @@
     "@types/common-tags": "^1.8.4",
     "@types/heft-jest": "1.0.3",
     "@types/node": "^18.16.4",
+    "@types/pluralize": "^0.0.33",
     "@types/ramda": "^0.28.20",
     "@types/uuid": "~9.0.2",
     "@typescript-eslint/parser": "~5.59.2",

diff --git a/tools/jsonschema2stackbit/src/index.ts b/tools/jsonschema2stackbit/src/index.ts
@@ -24,6 +24,7 @@ import {
 } from '@stackbit/types';
 import { type JSONSchema, TypeName } from 'json-schema-typed/draft-07';
 import { traverse } from 'object-traversal';
+import { singular } from 'pluralize';
 
 import { GenericType, ITypeMapping } from './@types/index.js';
 export * from './@types/index.js';
@@ -230,15 +231,16 @@ function processObject({
     const modelName =
       classification && ['component', 'template', 'global'].includes(classification) && subSchema.$id
         ? getSchemaName(subSchema.$id).replaceAll('-', '_')
-        : name.replaceAll('-', '_');
+        : singular(name.replaceAll('-', '_'));
     const modelLabel =
       (classification && ['component', 'template', 'global'].includes(classification) && subSchema.title) ||
+      title ||
       toPascalCase(modelName);
 
     const model: FieldModel = {
       name: name.replaceAll('-', '_'),
-      label: title || toPascalCase(name),
-      description,
+      label: parentSchema.title || toPascalCase(name),
+      description: parentSchema.description || description,
       type: 'model',
       models: [modelName]
     };