fix: restore comments

packages/json-schema-producer/src/from-website.ts

@@ -6,6 +6,7 @@ import { getHtml } from "./browser";
 import { classNames as globalClassNames } from "./globals";
 import { bigBadHacks } from "./hack";
 import { definitionTypes } from "./json-schema";
+import { sortKeys } from "./objects";
 import { scrapeClassPage } from "./scrape/classes";
 import { scrapeConcepts } from "./scrape/concepts";
 import { scrapeDefines } from "./scrape/defines";
@@ -58,22 +59,15 @@ export const produce = async ({
     );
   }
 
-  const aFewDefinitions = Object.keys(definitions)
-    .slice(0, 1)
-    .reduce((acc, key) => {
-      acc[key] = definitions[key];
-      return acc;
-    }, {} as typeof definitions);
   const schema: JSONSchema6 = {
     type: "object",
     description: "Factorio Lua API",
     required: [...globalClassNames, "defines"],
     definitions,
-    properties: {
+    properties: sortKeys({
       ...definitions,
-      // ...aFewDefinitions,
       defines,
-    },
+    }),
     additionalProperties: false,
   };
   await fs.writeFile("factorio.schema.json", JSON.stringify(schema));

packages/json-schema-producer/src/langs/typescript.ts

@@ -10,6 +10,9 @@ declare module "json-schema" {
   }
 }
 
+const getDocBlock = (schema: JSONSchema6) =>
+  schema.description ? `/* ${schema.description} */\n  ` : "";
+
 const toTsType = (jtype: JSONSchema6): string => {
   // primitives
   const jtt = jtype.type;
@@ -81,9 +84,9 @@ export const withType = {
     const isRO = opts.parseMode
       ? !mode.some((rw: string) => !!rw.match(/w/i))
       : false;
-    return `${isRO ? "readonly " : ""}"${name}": ${toTsType(
-      schema.properties?.type as JSONSchema6
-    )}`;
+    return `${getDocBlock(schema)}${
+      isRO ? "readonly " : ""
+    }"${name}": ${toTsType(schema.properties?.type as JSONSchema6)}`;
   },
   method: (schema: JSONSchema6) => {
     const args = ((schema.items as JSONSchema6[]) || [])
@@ -98,13 +101,13 @@ export const withType = {
     if (!retSchema) {
       throw new Error("missing return value");
     }
-    return `(${args}) => ${toTsType(retSchema)}`;
+    return `${getDocBlock(schema)}(${args}) => ${toTsType(retSchema)}`;
   },
   class: (schema: JSONSchema6, opts: { asStruct?: boolean }) => {
-    const members = (schema.properties!.members as JSONSchema6)
-      .properties as Record<string, JSONSchema6>;
+    const members = schema.properties!.members as JSONSchema6;
+    const membersProperties = members.properties as Record<string, JSONSchema6>;
     const { properties: propNames, methods: methodNames } = Object.entries(
-      members as Record<string, JSONSchema6>
+      membersProperties
     ).reduce(
       (acc, [name, aSchema]) => {
         if (aSchema.properties?.return) acc.methods.push(name);
@@ -115,12 +118,12 @@ export const withType = {
     );
     const sort = (a: string, b: string) => a.localeCompare(b);
     const propStrs = propNames.sort(sort).map((name) => {
-      return withType.classProperty(name, members[name], {
+      return withType.classProperty(name, membersProperties[name], {
         parseMode: !opts?.asStruct,
       });
     });
     const methodStrs = methodNames.sort(sort).map((name) => {
-      return `${name}: ${withType.method(members[name])}`;
+      return `${name}: ${withType.method(membersProperties[name])}`;
     });
     return `
 {

packages/json-schema-producer/src/objects.ts

@@ -0,0 +1,7 @@
+export const sortKeys = <T extends Record<string, any>>(o: T): T => {
+  const keys = Object.keys(o).sort((a, b) => a.localeCompare(b));
+  return keys.reduce((acc, key) => {
+    acc[key as keyof T] = o[key];
+    return acc;
+  }, {} as T);
+};

packages/json-schema-producer/src/scrape/classes.ts

@@ -235,11 +235,7 @@ const prefixDescription = (description: string) => (schema: JSONSchema6) => {
   return schema;
 };
 
-const scrapeClassFromEl = (
-  document: Document,
-  el: IElement,
-  pageMeta: PageMeta
-) => {
+const ofEl = (document: Document, el: IElement, pageMeta: PageMeta) => {
   const rootSiblings = el.children;
   const classNameEl = rootSiblings.find(
     (it) => "className" in it && it.className === "type-name"
@@ -291,7 +287,7 @@ const scrapeClassFromEl = (
 export const scrapeClassPage = (document: Document, pageMeta: PageMeta) => {
   const classEls = getClassListingEls(document);
   const classes = classEls
-    .map((el) => scrapeClassFromEl(document, el, pageMeta))
+    .map((el) => ofEl(document, el, pageMeta))
     .map(
       prefixDescription(
         getDescription(document.body.getElementsByTagName("h1")[0], pageMeta)