feat(cli-utils): Expose generate commands as exported functions (Re-a…

…dd) (#207)
0no-co · Apr 15, 2024 · c9c3d0f · c9c3d0f
1 parent aa7ee38
commit c9c3d0f
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 10 deletions.
diff --git a/.changeset/lazy-seas-hunt.md b/.changeset/lazy-seas-hunt.md
@@ -0,0 +1,5 @@
+---
+"@gql.tada/cli-utils": minor
+---
+
+Expose internal generate commands as functions exported by `@gql.tada/cli-utils` (restoring prior functionality)
diff --git a/packages/cli-utils/src/api.ts b/packages/cli-utils/src/api.ts
@@ -0,0 +1,4 @@
+export { generateOutput } from './commands/generate-output';
+export { generatePersisted } from './commands/generate-persisted';
+export { generateSchema } from './commands/generate-schema';
+export { generateTurbo } from './commands/turbo';
diff --git a/packages/cli-utils/src/commands/generate-output/index.ts b/packages/cli-utils/src/commands/generate-output/index.ts
@@ -1,5 +1,6 @@
 import { Command, Option } from 'clipanion';
 
+import type { Options } from './runner';
 import { initTTY } from '../../term';
 import { run } from './runner';
 
@@ -32,3 +33,11 @@ export class GenerateOutputCommand extends Command {
     return process.exitCode || (typeof result === 'object' ? result.exit : 0);
   }
 }
+
+export async function generateOutput(opts: Options): Promise<void> {
+  const tty = initTTY({ disableTTY: true });
+  const result = await tty.start(run(tty, opts));
+  if (result instanceof Error) {
+    throw result;
+  }
+}
diff --git a/packages/cli-utils/src/commands/generate-output/runner.ts b/packages/cli-utils/src/commands/generate-output/runner.ts
@@ -15,7 +15,7 @@ import type { WriteTarget } from '../shared';
 import { writeOutput } from '../shared';
 import * as logger from './logger';
 
-interface Options {
+export interface Options {
   disablePreprocessing: boolean;
   output: string | undefined;
   tsconfig: string | undefined;

diff --git a/packages/cli-utils/src/commands/generate-persisted/index.ts b/packages/cli-utils/src/commands/generate-persisted/index.ts
@@ -1,5 +1,6 @@
 import { Command, Option } from 'clipanion';
 
+import type { Options } from './runner';
 import { initTTY } from '../../term';
 import { run } from './runner';
 
@@ -32,3 +33,11 @@ export class GeneratePersisted extends Command {
     return process.exitCode || (typeof result === 'object' ? result.exit : 0);
   }
 }
+
+export async function generatePersisted(opts: Options) {
+  const tty = initTTY({ disableTTY: true });
+  const result = await tty.start(run(tty, opts));
+  if (result instanceof Error) {
+    throw result;
+  }
+}
diff --git a/packages/cli-utils/src/commands/generate-persisted/runner.ts b/packages/cli-utils/src/commands/generate-persisted/runner.ts
@@ -8,7 +8,7 @@ import type { WriteTarget } from '../shared';
 import { writeOutput } from '../shared';
 import * as logger from './logger';
 
-interface Options {
+export interface Options {
   tsconfig: string | undefined;
   output: string | undefined;
   failOnWarn: boolean;

diff --git a/packages/cli-utils/src/commands/generate-schema/index.ts b/packages/cli-utils/src/commands/generate-schema/index.ts
@@ -1,6 +1,7 @@
 import * as t from 'typanion';
 import { Command, Option } from 'clipanion';
 
+import type { Options } from './runner';
 import { initTTY } from '../../term';
 import { run } from './runner';
 
@@ -55,3 +56,11 @@ export class GenerateSchema extends Command {
     return process.exitCode || (typeof result === 'object' ? result.exit : 0);
   }
 }
+
+export async function generateSchema(opts: Options) {
+  const tty = initTTY({ disableTTY: true });
+  const result = await tty.start(run(tty, opts));
+  if (result instanceof Error) {
+    throw result;
+  }
+}
diff --git a/packages/cli-utils/src/commands/generate-schema/runner.ts b/packages/cli-utils/src/commands/generate-schema/runner.ts
@@ -9,7 +9,7 @@ import type { WriteTarget } from '../shared';
 import { writeOutput } from '../shared';
 import * as logger from './logger';
 
-interface Options {
+export interface Options {
   input: string;
   headers: Record<string, string> | undefined;
   output: string | undefined;

diff --git a/packages/cli-utils/src/commands/turbo/index.ts b/packages/cli-utils/src/commands/turbo/index.ts
@@ -1,5 +1,6 @@
 import { Command, Option } from 'clipanion';
 
+import type { Options } from './runner';
 import { initTTY } from '../../term';
 import { run } from './runner';
 
@@ -32,3 +33,11 @@ export class TurboCommand extends Command {
     return process.exitCode || (typeof result === 'object' ? result.exit : 0);
   }
 }
+
+export async function generateTurbo(opts: Options) {
+  const tty = initTTY({ disableTTY: true });
+  const result = await tty.start(run(tty, opts));
+  if (result instanceof Error) {
+    throw result;
+  }
+}
diff --git a/packages/cli-utils/src/commands/turbo/runner.ts b/packages/cli-utils/src/commands/turbo/runner.ts
@@ -10,7 +10,7 @@ import * as logger from './logger';
 
 const PREAMBLE_IGNORE = ['/* eslint-disable */', '/* prettier-ignore */'].join('\n') + '\n';
 
-interface Options {
+export interface Options {
   failOnWarn: boolean;
   tsconfig: string | undefined;
   output: string | undefined;

diff --git a/packages/cli-utils/src/index.ts b/packages/cli-utils/src/index.ts
@@ -1,4 +1,5 @@
 import { Cli } from 'clipanion';
+import * as api from './api';
 
 import { CheckCommand } from './commands/check/index';
 import { DoctorCommand } from './commands/doctor/index';
@@ -8,7 +9,7 @@ import { GenerateSchema } from './commands/generate-schema/index';
 import { InitCommand } from './commands/init/index';
 import { TurboCommand } from './commands/turbo/index';
 
-function main() {
+async function _main() {
   const cli = new Cli({
     binaryVersion: process.env.npm_package_version || '0.0.0',
     binaryLabel: 'gql.tada CLI',
@@ -23,7 +24,11 @@ function main() {
   cli.register(InitCommand);
   cli.register(TurboCommand);
 
-  cli.runExit(process.argv.slice(2));
+  await cli.runExit(process.argv.slice(2));
 }
 
+type MainFn = typeof _main & typeof api;
+const main = Object.assign(_main, api) as MainFn;
+
+export * from './api';
 export default main;
diff --git a/packages/cli-utils/src/term/tty.ts b/packages/cli-utils/src/term/tty.ts
@@ -21,6 +21,10 @@ import { text, compose } from './write';
 import { cmd, _setColor, CSI, Mode, PrivateMode } from './csi';
 import { isGithubCI } from './github';
 
+export interface TTYParams {
+  disableTTY?: boolean;
+}
+
 export interface KeypressEvent {
   data?: string;
   sequence: string;
@@ -41,7 +45,7 @@ export interface TTY {
   write(input: readonly string[], ...args: readonly string[]): void;
   write(...input: readonly string[]): void;
 
-  start(outputs: AsyncIterable<ComposeInput>): Promise<string | CLIError>;
+  start(outputs: AsyncIterable<ComposeInput>, disableInput?: boolean): Promise<string | CLIError>;
 
   mode(...modes: readonly (Mode | PrivateMode)[]): void;
   modeOff(...modes: readonly (Mode | PrivateMode)[]): void;
@@ -78,8 +82,8 @@ function fromReadStream(stream: ReadStream): Source<KeypressEvent> {
   });
 }
 
-export function initTTY(): TTY {
-  let isTTY = process.env.TERM !== 'dumb' && !process.env.CI;
+export function initTTY(params: TTYParams = {}): TTY {
+  let isTTY = process.env.TERM !== 'dumb' && !process.env.CI && !params.disableTTY;
   let pipeTo: WriteStream | null = null;
   let output: WriteStream = process.stdout;
   if (isGithubCI) {
@@ -133,7 +137,11 @@ export function initTTY(): TTY {
 
   function start(outputs: AsyncIterable<ComposeInput>): Promise<string | CLIError> {
     const write = (input: string | CLIError) => output.write('' + input);
-    return pipe(compose(outputs), onPush(write), takeUntil(cancelSource), toPromise);
+    if (params.disableTTY) {
+      return pipe(compose(outputs), onPush(write), toPromise);
+    } else {
+      return pipe(compose(outputs), onPush(write), takeUntil(cancelSource), toPromise);
+    }
   }
 
   function mode(...modes: readonly (Mode | PrivateMode)[]): void {