fix: experimental support in generate types and schema compilation (#36)

Author: alexander-akait

compile-to-definitions/index.js

@@ -129,6 +129,7 @@ const preprocessSchema = (schema, root = schema, path = []) => {
 				schema.properties[key] = {
 					description: result.description,
 					deprecated: result.deprecated,
+					experimental: result.experimental,
 					anyOf: [property],
 				};
 			} else if (
@@ -140,6 +141,7 @@ const preprocessSchema = (schema, root = schema, path = []) => {
 				schema.properties[key] = {
 					description: property.description || result.description,
 					deprecated: property.deprecated || result.deprecated,
+					experimental: property.experimental || result.experimental,
 					anyOf: property.oneOf,
 				};
 				preprocessSchema(schema.properties[key], root, [...path, key]);

generate-types/index.js

@@ -633,9 +633,20 @@ const printError = (diagnostic) => {
 			.getJsDocTags(checker)
 			.filter((tag) => tag.name === "deprecated");
 
-		if (!commentText && deprecatedTags.length === 0) return "";
+		const experimentalTags = symbol
+			.getJsDocTags(checker)
+			.filter((tag) => tag.name === "experimental");
+
+		if (
+			!commentText &&
+			deprecatedTags.length === 0 &&
+			experimentalTags.length === 0
+		) {
+			return "";
+		}
 
 		const lines = commentText ? commentText.split("\n") : [];
+
 		for (const tag of deprecatedTags) {
 			const text = normalizeText(tag.text);
 			if (text && !commentText) {
@@ -646,6 +657,16 @@ const printError = (diagnostic) => {
 			}
 		}
 
+		for (const tag of experimentalTags) {
+			const text = normalizeText(tag.text);
+			if (text && !commentText) {
+				lines.push(...text.split("\n"));
+				lines.push("@experimental");
+			} else {
+				lines.push(text ? `@experimental ${text}` : "@experimental");
+			}
+		}
+
 		return `\n/**\n${lines
 			.map((line) => (line ? ` * ${line}` : " *"))
 			.join("\n")}\n */\n`;