Merge branch 'main' into openapi-typescript-v7

Author: wolfy1339

scripts/build.js

@@ -38,16 +38,16 @@ async function run() {
     const tempSchema = { ...schema };
     tempSchema.components = {
       schemas: {},
-      examples: {}
+      examples: {},
     };
 
     /**
      *  Function to handle special cases:
-      * Check all instances of `$ref` in the OpenAPI spec, and add them to the definitions
-      * Remove all instances of `enterprise` in the OpenAPI spec for GitHub.com
+     * Check all instances of `$ref` in the OpenAPI spec, and add them to the definitions
+     * Remove all instances of `enterprise` in the OpenAPI spec for GitHub.com
      * @param {object} obj - The object to check for special cases
      * @returns {object} - The object with any special cases handled
-    */
+     */
     const specialHandling = (obj) => {
       if (typeof obj !== "object" || obj === null) return obj;
 
@@ -90,14 +90,15 @@ async function run() {
       if (typeof examples !== "undefined") {
         for (let key of Object.keys(examples)) {
           const example$ref = examples[key].$ref.split("/").at(-1);
-          tempSchema.components.examples[example$ref] = schema.components.examples[example$ref];
+          tempSchema.components.examples[example$ref] =
+            schema.components.examples[example$ref];
         }
       }
     }
 
     writeFileSync(
       `packages/openapi-webhooks/generated/${file}`,
-      await prettier.format(JSON.stringify(tempSchema), { parser: "json" })
+      await prettier.format(JSON.stringify(tempSchema), { parser: "json" }),
     );
     console.log(`packages/openapi-webhooks/generated/${file} written`);
   }
@@ -107,7 +108,7 @@ async function run() {
   for (const name of schemaFileNames) {
     schemasCode += `["${name.replace(
       ".json",
-      ""
+      "",
     )}"]: require("./generated/${name}"),`;
   }
 
@@ -117,8 +118,8 @@ async function run() {
       `# Please do not edit files in this folder
 
 They are all generated, your changes would be overwritten with the next update. If you found a problem with GitHub's OpenAPI schema, file an issue at https://github.com/github/rest-api-description/. If you found a problem specific to the \`x-octokit\` extension or usage of the \`@octokit/openapi\` module, please file an issue at https://github.com/octokit/openapi.`,
-      { parser: "markdown" }
-    )
+      { parser: "markdown" },
+    ),
   );
   writeFileSync(
     "packages/openapi-webhooks/index.js",
@@ -132,8 +133,8 @@ They are all generated, your changes would be overwritten with the next update.
     `,
       {
         parser: "babel",
-      }
-    )
+      },
+    ),
   );
   writeFileSync(
     `packages/openapi-webhooks/package.json`,
@@ -158,15 +159,15 @@ They are all generated, your changes would be overwritten with the next update.
           access: "public",
         },
       }),
-      { parser: "json-stringify" }
-    )
+      { parser: "json-stringify" },
+    ),
   );
 
   writeFileSync(
     `packages/openapi-webhooks/README.md`,
     readFileSync("README.md", "utf8")
       .toString()
-      .replace("(CONTRIBUTING.md)", "(../../CONTRIBUTING.md)")
+      .replace("(CONTRIBUTING.md)", "(../../CONTRIBUTING.md)"),
   );
   copyFileSync("LICENSE", `packages/openapi-webhooks/LICENSE`);
 }

scripts/download.js

@@ -43,27 +43,27 @@ async function run() {
     });
     getDescriptionsOptions.ref = ref;
     console.log(
-      `Open pull requests found by @github-openapi-bot: ${mostRecentPr.html_url}.\nLoading descriptions from "${ref}" branch`
+      `Open pull requests found by @github-openapi-bot: ${mostRecentPr.html_url}.\nLoading descriptions from "${ref}" branch`,
     );
   } else {
     console.log(
-      "No open pull requests found by @github-openapi-bot. Loading descriptions from default branch"
+      "No open pull requests found by @github-openapi-bot. Loading descriptions from default branch",
     );
   }
 
   const { data } = await octokit.request(
     "GET /repos/{owner}/{repo}/contents/{path}",
-    getDescriptionsOptions
+    getDescriptionsOptions,
   );
 
   if (!Array.isArray(data)) {
     throw new Error(
-      "https://github.com/github/rest-api-description/tree/main/descriptions-next is not a directory"
+      "https://github.com/github/rest-api-description/tree/main/descriptions-next is not a directory",
     );
   }
 
   // temporarily hardcode versions until we unblock automated updates
-  const currentGhesVersions = [...await getCurrentVersions()];
+  const currentGhesVersions = [...(await getCurrentVersions())];
 
   for (const folder of data) {
     const { name } = folder;
@@ -98,7 +98,7 @@ async function download(name, remotePath) {
             if (error) return reject(error);
             console.log("%s written", path);
             resolve();
-          })
+          }),
         )
         .on("error", (error) => reject(error.message));
     });
@@ -113,6 +113,6 @@ async function download(name, remotePath) {
     path,
     await prettier.format(JSON.stringify(jsonContent), {
       parser: "json",
-    })
+    }),
   );
 }

scripts/generate-types.js

@@ -53,8 +53,8 @@ async function run() {
           },
           ...packageDefaults,
         }),
-        { parser: "json-stringify" }
-      )
+        { parser: "json-stringify" },
+      ),
     );
     await writeFile(
       `packages/${packageName}/README.md`,
@@ -80,8 +80,8 @@ type Repository = components["schemas"]["full-repository"]
 
 [MIT](LICENSE)
 `,
-        { parser: "markdown" }
-      )
+        { parser: "markdown" },
+      ),
     );
 
     await copyFile("LICENSE", `packages/${packageName}/LICENSE`);
@@ -103,8 +103,8 @@ type Repository = components["schemas"]["full-repository"]
         outputFile,
         {
           parser: "typescript",
-        }
-      )
+        },
+      ),
     );
     console.log(`packages/${packageName}/types.d.ts written`);
   }

scripts/test.js

@@ -6,7 +6,7 @@ console.log("Verifying folders: %j", VERIFY_FOLDERS);
 const files = VERIFY_FOLDERS.map((folder) =>
   readdirSync(folder)
     .filter((file) => file.endsWith(".json"))
-    .map((file) => `${folder}/${file}`)
+    .map((file) => `${folder}/${file}`),
 ).flat();
 
 const errors = [];

scripts/update-package.js

@@ -13,7 +13,7 @@ async function updatePackage() {
   // set semantic-release configuration of npm packages
   const items = await readdir("packages");
   const typePackages = items.filter((item) =>
-    item.startsWith("openapi-webhooks-types")
+    item.startsWith("openapi-webhooks-types"),
   );
 
   pkg.release.plugins = [
@@ -40,11 +40,11 @@ async function updatePackage() {
           pkgRoot: `packages/${packageName}`,
         },
       ];
-    })
+    }),
   );
 
   await writeFile(
     "package.json",
-    await prettier.format(JSON.stringify(pkg), { parser: "json-stringify" })
+    await prettier.format(JSON.stringify(pkg), { parser: "json-stringify" }),
   );
 }