feat: github as openapi source (#54)

* Add github source option

* Fix command options

* Add pull request support

* Update clipanion

* Deal with provided pull request (--pr=42)

* Add Spinner

* Leaner spinner

* Remove unused import

* Run npm audit fix

* Rename `branch` to `ref` to be more accurate

* Add support for env var

* Update snapshot

Author: fabien0102

README.md

@@ -126,7 +126,7 @@ export default defineConfig({
       source: "github",
       owner: "fabien0102",
       repository: "openapi-codegen",
-      branch: "main",
+      ref: "main",
       specPath: "examples/spec.yaml",
     },
 

cli/README.md

@@ -18,7 +18,7 @@ export default defineConfig({
       source: "github",
       owner: "fabien0102",
       repository: "openapi-codegen",
-      branch: "main",
+      ref: "main",
       specPath: "examples/spec.yaml",
     },
 

cli/examples/openapi-codegen.config.ts

@@ -1,5 +1,4 @@
 import { defineConfig } from "../lib/index.js";
-import { generateFetchers } from "@openapi-codegen/typescript";
 
 export default defineConfig({
   withFile: {
@@ -22,4 +21,17 @@ export default defineConfig({
       console.log(context);
     },
   },
+  withGithub: {
+    from: {
+      source: "github",
+      owner: "fabien0102",
+      ref: "main",
+      repository: "openapi-codegen",
+      specPath: "cli/examples/petstore.json",
+    },
+    outputDir: "petstore",
+    to: async (context) => {
+      console.log(context);
+    },
+  },
 });

cli/package-lock.json

@@ -38,7 +38,7 @@
     "case": "^1.6.3",
     "chalk": "^5.0.0",
     "cli-highlight": "^2.1.11",
-    "clipanion": "^3.2.0-rc.3",
+    "clipanion": "^3.2.0-rc.10",
     "fs-extra": "^10.0.0",
     "got": "^12.0.0",
     "got-fetch": "^5.0.2",
@@ -52,6 +52,7 @@
     "slash": "^4.0.0",
     "swagger2openapi": "^7.0.8",
     "tslib": "^2.3.1",
+    "typanion": "^3.7.1",
     "typescript": "^4.6.2"
   },
   "devDependencies": {

cli/package.json

@@ -19,53 +19,64 @@ const __filename = fileURLToPath(import.meta.url);
 export class GenerateCommand extends Command {
   config = Option.String(`-c,--config`, {
     description: "Configuration file path",
+    env: "OPENAPI_CODEGEN_CONFIG",
   });
 
   namespace = Option.String();
 
   source = Option.String(`--source`, {
     description: "Source of the spec (file, url or github)",
+    env: "OPENAPI_CODEGEN_SOURCE",
     validator: t.isEnum(["file", "url", "github"]),
   });
 
   // source=file options
   relativePath = Option.String(`--relativePath`, {
     description: "[source=file] Relative path of the spec file",
+    env: "OPENAPI_CODEGEN_FILE_PATH",
   });
 
   // source=url options
   url = Option.String("--url", {
     description: "[source=url] URL of the spec file",
+    env: "OPENAPI_CODEGEN_URL",
   });
   method = Option.String("--method", {
     description: "[source=url] HTTP Method",
+    env: "OPENAPI_CODEGEN_URL_METHOD",
     validator: t.isEnum(["get", "post"]),
   });
 
   // source=github options
   owner = Option.String("--owner", {
     description: "[source=github] Owner of the repository",
+    env: "OPENAPI_CODEGEN_GITHUB_OWNER",
   });
-  repository = Option.String("--repository --repo", {
+  repository = Option.String("--repository,--repo", {
     description: "[source=github] Repository name",
+    env: "OPENAPI_CODEGEN_GITHUB_REPOSITORY",
   });
-  branch = Option.String("-b --branch", {
-    description: "[source=github] Branch name",
+  ref = Option.String("--ref", {
+    description: "[source=github] Git reference (commit sha, branch or tag)",
+    env: "OPENAPI_CODEGEN_GITHUB_REF",
   });
   specPath = Option.String("--specPath", {
     description: "[source=github] OpenAPI specs file path",
+    env: "OPENAPI_CODEGEN_GITHUB_SPEC_PATH",
   });
-  pullRequest = Option.String("--pr --pull-request", {
-    description:
-      "[source=github] Select a specific pull-request instead of a branch",
+  pullRequest = Option.String("--pr,--pull-request", {
+    description: "[source=github] Select a specific pull-request as ref",
+    env: "OPENAPI_CODEGEN_GITHUB_PULL_REQUEST",
+    validator: t.isNumber(),
+    tolerateBoolean: true,
   });
 
   static paths = [["gen"], ["generate"], Command.Default];
   static usage = Command.Usage({
     description: "Generate types & components from an OpenAPI file",
     examples: [
       [`From a config key`, `$0 gen myapi`],
-      [`With some override`, `$0 gen myapi --branch awesome-feature`],
+      [`With some override`, `$0 gen myapi --ref awesome-feature`],
     ],
   });
 
@@ -159,16 +170,16 @@ export class GenerateCommand extends Command {
           return {
             ...config.from,
             owner: this.owner ?? config.from.owner,
-            branch: this.branch ?? config.from.branch,
+            ref: this.ref ?? config.from.ref,
             repository: this.repository ?? config.from.repository,
             specPath: this.specPath ?? config.from.specPath,
           };
         } else {
           if (!this.owner) {
             throw new UsageError("--owner argument is missing");
           }
-          if (!this.branch) {
-            throw new UsageError("--branch argument is missing");
+          if (!this.ref && !this.pullRequest) {
+            throw new UsageError("--ref argument is missing");
           }
           if (!this.repository) {
             throw new UsageError("--repository argument is missing");
@@ -179,7 +190,7 @@ export class GenerateCommand extends Command {
 
           return {
             source: "github",
-            branch: this.branch,
+            ref: this.ref || "main", // Fallback for --pr mode
             owner: this.owner,
             repository: this.repository,
             specPath: this.specPath,
@@ -197,7 +208,24 @@ export class GenerateCommand extends Command {
     }
 
     const config = configs[this.namespace];
-    const sourceFile = await getOpenAPISourceFile(this.getFromOptions(config));
+    const options = this.getFromOptions(config);
+    if (options.source === "github" && this.pullRequest) {
+      const { Prompt } = await import("../prompts/Prompt.js");
+      const prompt = new Prompt();
+      const token = await prompt.githubToken();
+      const pullRequest = await prompt.githubPullRequest({
+        ...options,
+        token,
+        pullRequestNumber:
+          typeof this.pullRequest === "number" ? this.pullRequest : undefined,
+      });
+
+      options.ref = pullRequest.ref;
+      options.owner = pullRequest.owner;
+      options.repository = pullRequest.repository;
+    }
+
+    const sourceFile = await getOpenAPISourceFile(options);
     const openAPIDocument = await parseOpenAPISourceFile(sourceFile);
     const prettierConfig = await prettier.resolveConfig(process.cwd());
 

cli/src/commands/GenerateCommand.ts

@@ -141,7 +141,7 @@ export class InitCommand extends Command {
         ? await this.askForFile()
         : source === "url"
         ? await this.askForUrl()
-        : await this.prompt.github();
+        : await this.prompt.github("todo: inject the token");
 
     const namespace = format.camel(
       await this.prompt.input({

cli/src/commands/InitCommand.ts

@@ -71,7 +71,7 @@ describe("generateConfigProperty", () => {
       options: {
         from: {
           source: "github",
-          branch: "main",
+          ref: "main",
           owner: "fabien0102",
           repository: "openapi-codegen",
           specPath: "examples/petstore.json",
@@ -85,7 +85,7 @@ describe("generateConfigProperty", () => {
       "foo: {
           from: {
               source: \\"github\\",
-              branch: \\"main\\",
+              ref: \\"main\\",
               owner: \\"fabien0102\\",
               repository: \\"openapi-codegen\\",
               specPath: \\"examples/petstore.json\\"

cli/src/core/generateConfigProperty.test.ts

@@ -1,4 +1,7 @@
-import { readFileSync } from "fs";
+import { UsageError } from "clipanion";
+import { readFileSync, unlinkSync } from "fs";
+import { HTTPError } from "got";
+import { homedir } from "os";
 import { join, parse } from "path";
 import { URL } from "url";
 import { FromOptions, OpenAPISourceFile } from "../types";
@@ -39,9 +42,79 @@ export const getOpenAPISourceFile = async (
       return { text: file.body, format };
     }
 
-    case "github":
-      // TODO
-      return { text: "", format: "json" };
+    case "github": {
+      // Retrieve Github token
+      const { Prompt } = await import("../prompts/Prompt.js");
+      const prompt = new Prompt();
+
+      const token = await prompt.githubToken();
+
+      // Retrieve specs
+      const { default: got } = await import("got");
+
+      try {
+        const raw = await got
+          .post("https://api.github.com/graphql", {
+            headers: {
+              "content-type": "application/json",
+              "user-agent": "openapi-codegen",
+              authorization: `bearer ${token}`,
+            },
+            body: JSON.stringify({
+              query: `query {
+            repository(name: "${options.repository}", owner: "${options.owner}") {
+              object(expression: "${options.ref}:${options.specPath}") {
+                ... on Blob {
+                  text
+                }
+              }
+            }
+          }`,
+            }),
+          })
+          .json<{
+            data: { repository: { object: { text: string } | null } };
+            errors?: [
+              {
+                message: string;
+              }
+            ];
+          }>();
+
+        prompt.close();
+        if (raw.errors) {
+          throw new UsageError(raw.errors[0].message);
+        }
+        if (raw.data.repository.object === null) {
+          throw new UsageError(`No file found at "${options.specPath}"`);
+        }
+
+        let format: OpenAPISourceFile["format"] = "yaml";
+        if (options.specPath.toLowerCase().endsWith("json")) {
+          format = "json";
+        }
+
+        return { text: raw.data.repository.object.text, format };
+      } catch (e) {
+        if (
+          e instanceof HTTPError &&
+          e.response.statusCode === 401 &&
+          !process.env.GITHUB_TOKEN
+        ) {
+          const removeToken = await prompt.confirm(
+            "Your token doesn't have the correct permissions, should we remove it?"
+          );
+          prompt.close();
+
+          if (removeToken) {
+            const githubTokenPath = join(homedir(), ".openapi-codegen");
+            unlinkSync(githubTokenPath);
+            return await getOpenAPISourceFile(options);
+          }
+        }
+        throw e;
+      }
+    }
   }
 };