better type for builder

HubSpot · Jan 15, 2025 · 001438e · 001438e
1 parent cac1307
commit 001438e
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/commands/account/info.ts b/commands/account/info.ts
@@ -5,14 +5,21 @@ import { getAccessToken } from '@hubspot/local-dev-lib/personalAccessKey';
 import { addConfigOptions } from '../../lib/commonOpts';
 import { i18n } from '../../lib/lang';
 import { getTableContents } from '../../lib/ui/table';
-import { CommonOptions } from '../../types/Yargs';
+import { CommonArguments } from '../../types/Yargs';
 
 const i18nKey = 'commands.account.subcommands.info';
 export const describe = i18n(`${i18nKey}.describe`);
 
 export const command = 'info [account]';
 
-export async function handler(options: CommonOptions): Promise<void> {
+type AccountInfoOptions = {
+  config?: string;
+  someNewField: number;
+};
+
+export async function handler(
+  options: CommonArguments<AccountInfoOptions>
+): Promise<void> {
   const { derivedAccountId } = options;
   const config = getAccountConfig(derivedAccountId);
   // check if the provided account is using a personal access key, if not, show an error
@@ -41,7 +48,7 @@ export async function handler(options: CommonOptions): Promise<void> {
   }
 }
 
-export function builder(yargs: Argv): Argv {
+export function builder(yargs: Argv): Argv<AccountInfoOptions> {
   addConfigOptions(yargs);
 
   yargs.example([

diff --git a/commands/doctor.ts b/commands/doctor.ts
@@ -14,6 +14,7 @@ const { i18n } = require('../lib/lang');
 
 export interface DoctorOptions {
   'output-dir'?: string;
+  someNewField: number;
 }
 
 const i18nKey = 'commands.doctor';

diff --git a/types/Yargs.ts b/types/Yargs.ts
@@ -1,6 +1,6 @@
-import { Arguments } from 'yargs';
+import { ArgumentsCamelCase } from 'yargs';
 
-export type CommonOptions<T = object> = Arguments<
+export type CommonArguments<T = object> = ArgumentsCamelCase<
   T & {
     derivedAccountId: number;
     providedAccountId?: number;