feat!: Refactor/Simplify cli (#268)

* feat!: Replace custom prompts with clark

This is simplify the stack by removing the dependencies to react, ink and apollo.

Breaking change: `--pr` without pull request number is not supported

* chore: Replace rollup with tsup

* docs: Apply eslint warnings

* Fix imports

Author: fabien0102

README.md

@@ -33,7 +33,7 @@
 1. **Initialize the generator**
 
    ```bash
-   $ npx @openapi-codegen/cli init
+   npx @openapi-codegen/cli init
    ```
 
    <img style="max-width: 400px" src="https://user-images.githubusercontent.com/271912/194000679-5a4501b8-5fc0-430c-9217-028bf91a5dcd.gif">
@@ -43,7 +43,7 @@
 2. **Start Generation**
 
    ```bash
-   $ npx openapi-codegen gen {namespace}
+   npx openapi-codegen gen {namespace}
    ```
    After the code generation is done, you will notice the following files:
 
@@ -55,7 +55,7 @@
    &nbsp;
 
    > **Warning**
-   > 
+   >
    > If `{namespace}Fetcher.ts` or `{namespace}Context.tsx` already exist in the output folder, they will not be replaced. However, `{namespace}Components.tsx` and `{namespace}Schemas.ts` will be re-generated each time based on the Open API spec file provided.
 
 3. **Configure the Fetcher** (optional)
@@ -71,9 +71,11 @@
    If during generator setup you picked `> React Query components`, then you will need to install and configure React Query in order for the generated React hooks to work properly:
 
    - Install the library
-     ```bash
-     npm i @tanstack/react-query
-     ```
+
+      ```bash
+      npm i @tanstack/react-query
+      ```
+
    - Wire up the `QueryClient` as described [here](https://tanstack.com/query/v4/docs/adapters/react-query).
 
 ## Philosophy
@@ -161,17 +163,14 @@ And since this generated from the specs, everything is safe at build time!
 The only thing you need to manage is the configuration.
 Everything is typed and self-documented, but just in case, you can find here example configuration below:
 
-
 ### Example Config
+
 ```ts
 // openapi-codegen.config.ts
 import { defineConfig } from "@openapi-codegen/cli";
 import {
   generateSchemaTypes,
   generateReactQueryComponents,
-  /* generateExpressControllers, */
-  /* generateRestfulReactComponents, */
-  /* ... */
 } from "@openapi-codegen/typescript";
 
 export default defineConfig({
@@ -207,54 +206,71 @@ export default defineConfig({
 ```
 
 ### Plugins
+
 the `@openapi-codegen/cli` supports these generator plugins:
+
 #### **generateSchemaTypes** (frontend/backend)
+
   generate all schema types for your specification:
+  
   ```ts
    const { schemasFiles } = await generateSchemaTypes(context, {
         /* config */
       });
   ```
+  
 output: `{namespace}Schemas.ts`
 
 #### **generateFetchers** (frontend)
-  generate all fetchers with types for your specification *needs schemafiles*
+
+  generate all fetchers with types for your specification _needs schemafiles_
+  
   ```ts
      await generateFetchers(context, {
         /* config */
         schemasFiles,
       });
   ```
+  
 output: `{namespace}Fetchers.ts`
 
 #### **generateReactQueryComponents** (frontend)
+
   generate all React Query Components for useQuery() and useMutation()
+  
   ```ts
       await generateReactQueryComponents(context, {
         /* config*/
         schemasFiles,
       });
   ```
+  
   output: `{namespace}Components.ts`
+  
 #### **generateReactQueryFunctions** (frontend)
+
   generate all React Query Functions used for e.g. React-Router 6.6.0+ loader functions
+  
   ```ts
      await generateReactQueryFunctions(context, {
         filenamePrefix,
         schemasFiles,
       });
   ```
+  
   output: `{namespace}Functions.ts`
 
   example usage in react-route-loader:
+  
   ```ts
   export const routeLoader = (queryClient: QueryClient) =>
     async ({ params }: MyParams) => 
       await queryClient.fetchQuery(...getYourQueryNameQuery({}), {
         /*options*/
       })
   ```
-  *more infos: https://reactrouter.com/en/main/guides/data-libs*
+  
+  _more infos: https://reactrouter.com/en/main/guides/data-libs_
 
 
 You can import any generator into the `to` section, those can be the ones provided by this project or your own custom ones. You have full control of what you are generating!

cli/README.md

@@ -2,7 +2,7 @@
 
 ## Getting started
 
-1. Add a `openapi-codegen.config.ts` at the root of your project
+1. Add a `openapi-codegen.config.ts` at the root of your project or run `npx @openapi-codegen/cli init`
 
 ```ts
 // openapi-codegen.config.ts
@@ -56,7 +56,21 @@ export default defineConfig({
 3. Run the generator (`example` is the config key defined in the step 1)
 
 ```bash
-$ yarn gen example
+$ npm run gen example
 ```
 
 4. Start playing! 🥳
+
+## How to test the cli locally
+
+1. Build the CLI (watch mode)
+
+```bash
+npm run watch
+```
+
+1. Start working working (new terminal)
+
+```bash
+./lib/cli.js init --dry-run
+```

cli/codegen.yml

@@ -24,56 +24,43 @@
   ],
   "license": "MIT",
   "scripts": {
-    "build": "rollup -c",
-    "prepublishOnly": "npm run build",
-    "gen": "graphql-codegen --config codegen.yml -r dotenv/config"
+    "watch": "tsup src/index.ts src/cli.ts --outDir lib --format esm --watch",
+    "prebuild": "tsc --emitDeclarationOnly --declaration -p tsconfig.package.json",
+    "build": "tsup src/index.ts src/cli.ts --outDir lib --format esm",
+    "prepublishOnly": "npm run build"
   },
   "files": [
     "lib",
     "README.md"
   ],
   "dependencies": {
-    "@apollo/client": "^3.5.10",
+    "@clack/prompts": "^0.9.1",
+    "@octokit/request": "^9.2.0",
     "@swc/core": "^1.2.118",
     "case": "^1.6.3",
-    "chalk": "^5.0.0",
     "cli-highlight": "^2.1.11",
-    "clipanion": "^3.2.0-rc.10",
+    "clipanion": "^4.0.0-rc.4",
     "fs-extra": "^10.0.0",
     "got": "^12.0.0",
     "got-fetch": "^5.1.1",
-    "graphql": "^15.8.0",
-    "ink": "^5.0.0",
     "js-yaml": "^4.1.0",
     "openapi3-ts": "^2.0.1",
     "prettier": "^3.2.5",
-    "rxjs": "^7.5.4",
     "slash": "^4.0.0",
     "swagger2openapi": "^7.0.8",
     "tslib": "^2.3.1",
-    "typanion": "^3.7.1",
+    "typanion": "^3.14.0",
     "typescript": "4.8.2"
   },
   "devDependencies": {
-    "@graphql-codegen/cli": "^2.6.2",
-    "@graphql-codegen/typescript": "^2.4.5",
-    "@graphql-codegen/typescript-operations": "^2.3.2",
-    "@graphql-codegen/typescript-react-apollo": "^3.2.8",
-    "@rollup/plugin-commonjs": "^22.0.0",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@rollup/plugin-typescript": "^8.3.2",
     "@swc-node/register": "^1.4.0",
     "@types/fs-extra": "^9.0.13",
     "@types/js-yaml": "^4.0.3",
     "@types/nock": "^11.1.0",
     "@types/prettier": "^3.0.0",
-    "@types/react": "^18.3.2",
     "@types/slash": "^3.0.0",
     "nock": "^13.2.1",
     "react": "^18.3.1",
-    "rollup-plugin-auto-external": "^2.0.0",
-    "rollup-plugin-internal": "^1.0.4",
-    "rollup-plugin-preserve-shebang": "^1.0.1"
+    "tsup": "^8.3.5"
   }
 }

cli/package.json

@@ -10,7 +10,8 @@ import slash from "slash";
 import { Config, FromOptions, Namespace } from "../types";
 import { getOpenAPISourceFile } from "../core/getOpenAPISourceFile.js";
 import { parseOpenAPISourceFile } from "../core/parseOpenAPISourceFile.js";
-import { Prompt } from "../prompts/Prompt.js";
+import { getGithubToken } from "../utils/getGithubToken";
+import { resolveGithubPullRequest } from "../utils/resolveGithubPullRequest";
 
 const __filename = fileURLToPath(import.meta.url);
 
@@ -69,7 +70,6 @@ export class GenerateCommand extends Command {
     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];
@@ -214,13 +214,11 @@ export class GenerateCommand extends Command {
     const config = configs[this.namespace];
     const options = this.getFromOptions(config);
     if (options.source === "github" && this.pullRequest) {
-      const prompt = new Prompt();
-      const token = await prompt.githubToken();
-      const pullRequest = await prompt.githubPullRequest({
-        ...options,
+      const token = await getGithubToken();
+      const pullRequest = await resolveGithubPullRequest({
+        pullRequestNumber: this.pullRequest,
+        options,
         token,
-        pullRequestNumber:
-          typeof this.pullRequest === "number" ? this.pullRequest : undefined,
       });
 
       options.ref = pullRequest.ref;