refactor(core): improve typings of server/cli

storybookjs · Nov 3, 2020 · 1394788 · bekos · Dec 21, 2020 · gaetanmaisse
1 parent 0d08492
commit 1394788
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 16 deletions.
diff --git a/lib/core/src/server/cli/dev.ts b/lib/core/src/server/cli/dev.ts
@@ -1,9 +1,35 @@
-import program from 'commander';
+import program, { CommanderStatic } from 'commander';
 import chalk from 'chalk';
 import { logger } from '@storybook/node-logger';
 import { parseList, getEnvConfig, checkDeprecatedFlags } from './utils';
 
-async function getCLI(packageJson: { version: string; name: string }) {
+export interface DevCliOptions {
+  port?: number;
+  host?: number;
+  staticDir?: string[];
+  configDir?: string;
+  https?: boolean;
+  sslCa?: string[];
+  sslCert?: string;
+  sslKey?: string;
+  smokeTest?: boolean;
+  ci?: boolean;
+  loglevel?: string;
+  quiet?: boolean;
+  versionUpdates?: boolean;
+  releaseNotes?: boolean;
+  dll?: boolean;
+  docs?: boolean;
+  docsDll?: boolean;
+  uiDll?: boolean;
+  debugWebpack?: boolean;
+  previewUrl?: string;
+}
+
+export async function getDevCli(packageJson: {
+  version: string;
+  name: string;
+}): Promise<CommanderStatic & DevCliOptions> {
   process.env.NODE_ENV = process.env.NODE_ENV || 'development';
 
   program
@@ -72,8 +98,6 @@ async function getCLI(packageJson: { version: string; name: string }) {
     program.port = parseInt(program.port, 10);
   }
 
-  checkDeprecatedFlags(program);
+  checkDeprecatedFlags(program as DevCliOptions);
   return { ...program };
 }
-
-export default getCLI;
diff --git a/lib/core/src/server/cli/index.ts b/lib/core/src/server/cli/index.ts
@@ -1,4 +1,2 @@
-import getDevCli from './dev';
-import getProdCli from './prod';
-
-export { getDevCli, getProdCli };
+export * from './dev';
+export * from './prod';
diff --git a/lib/core/src/server/cli/prod.ts b/lib/core/src/server/cli/prod.ts
@@ -1,9 +1,27 @@
-import program from 'commander';
+import program, { CommanderStatic } from 'commander';
 import chalk from 'chalk';
 import { logger } from '@storybook/node-logger';
 import { parseList, getEnvConfig, checkDeprecatedFlags } from './utils';
 
-function getCLI(packageJson: { version: string; name: string }) {
+export interface ProdCliOptions {
+  staticDir?: string[];
+  outputDir?: string;
+  configDir?: string;
+  watch?: boolean;
+  quiet?: boolean;
+  loglevel?: string;
+  dll?: boolean;
+  docsDll?: boolean;
+  uiDll?: boolean;
+  debugWebpack?: boolean;
+  previewUrl?: string;
+  docs?: boolean;
+}
+
+export function getProdCli(packageJson: {
+  version: string;
+  name: string;
+}): CommanderStatic & ProdCliOptions {
   process.env.NODE_ENV = process.env.NODE_ENV || 'production';
 
   program
@@ -36,8 +54,6 @@ function getCLI(packageJson: { version: string; name: string }) {
     configDir: 'SBCONFIG_CONFIG_DIR',
   });
 
-  checkDeprecatedFlags(program);
+  checkDeprecatedFlags(program as ProdCliOptions);
   return { ...program };
 }
-
-export default getCLI;
diff --git a/lib/core/src/server/cli/utils.ts b/lib/core/src/server/cli/utils.ts
@@ -1,11 +1,11 @@
 import deprecate from 'util-deprecate';
 import dedent from 'ts-dedent';
 
-export function parseList(str: string) {
+export function parseList(str: string): string[] {
   return str.split(',');
 }
 
-export function getEnvConfig(program: Record<string, any>, configEnv: Record<string, any>) {
+export function getEnvConfig(program: Record<string, any>, configEnv: Record<string, any>): void {
   Object.keys(configEnv).forEach((fieldName) => {
     const envVarName = configEnv[fieldName];
     const envVarValue = process.env[envVarName];