feat(schema): support required

unjs · Dec 14, 2022 · f75c15c · f75c15c
1 parent ef1a009
commit f75c15c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/src/generator/dts.ts b/src/generator/dts.ts
@@ -113,11 +113,13 @@ function _genTypes(
     buff.push(...generateJSDoc(val, opts));
     if (val.tsType) {
       buff.push(
-        `${escapeKey(key)}${opts.partial ? "?" : ""}: ${val.tsType},\n`
+        `${escapeKey(key)}${isRequired(schema, key, opts) ? "" : "?"}: ${
+          val.tsType
+        },\n`
       );
     } else if (val.type === "object") {
       buff.push(
-        `${escapeKey(key)}${opts.partial ? "?" : ""}: {`,
+        `${escapeKey(key)}${isRequired(schema, key, opts) ? "" : "?"}: {`,
         ..._genTypes(val, spaces, opts),
         "},\n"
       );
@@ -130,7 +132,11 @@ function _genTypes(
       } else {
         type = getTsType(val, opts);
       }
-      buff.push(`${escapeKey(key)}${opts.partial ? "?" : ""}: ${type},\n`);
+      buff.push(
+        `${escapeKey(key)}${
+          isRequired(schema, key, opts) ? "" : "?"
+        }: ${type},\n`
+      );
     }
   }
 
@@ -257,3 +263,10 @@ function generateJSDoc(schema: Schema, opts: GenerateTypesOptions): string[] {
 
   return [];
 }
+
+function isRequired(schema: Schema, key: string, opts: GenerateTypesOptions) {
+  if (Array.isArray(schema.required) && schema.required.includes(key)) {
+    return true;
+  }
+  return !opts.partial;
+}
diff --git a/src/types.ts b/src/types.ts
@@ -48,6 +48,7 @@ export interface Schema extends TypeDescriptor {
   default?: JSValue;
   resolve?: ResolveFn;
   properties?: { [key: string]: Schema };
+  required?: string[];
   title?: string;
   description?: string;
   $schema?: string;

diff --git a/test/types.test.ts b/test/types.test.ts
@@ -68,11 +68,16 @@ describe("resolveSchema", () => {
             type: "array",
             items: {
               type: "object",
+              required: ["foo"],
               properties: {
                 foo: {
                   type: "number",
                   description: "This is foo prop",
                 },
+                bar: {
+                  type: "number",
+                  description: "This is bar prop",
+                },
               },
             },
           },
@@ -98,7 +103,10 @@ describe("resolveSchema", () => {
 
        manual?: Array<{
         /** This is foo prop */
-        foo?: number,
+        foo: number,
+
+        /** This is bar prop */
+        bar?: number,
        }>,
       }"
     `);