feat: add types for Cli

salesforce · Jun 13, 2019 · b3f0b42 · b3f0b42
1 parent 7f3cf58
commit b3f0b42
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 17 deletions.
diff --git a/packages/@best/cli/src/cli/args.ts b/packages/@best/cli/src/cli/args.ts
@@ -1,4 +1,5 @@
 import { Options } from "yargs";
+import { BestCliOptions } from "@best/config";
 
 export const check = () => {
     // TODO: Implement checks
@@ -80,3 +81,22 @@ export const options: { [key: string]: Options } = {
         type: 'boolean',
     }
 };
+
+export function normalize(args: { [x: string]: any; _: string[]; $0: string }): BestCliOptions {
+    const { _, help, clearCache, clearResults, gitIntegration, useHttp, externalStorage, runner, runnerConfig, config, projects, iterations, compareStats } = args;
+    return {
+        _,
+        help: Boolean(help),
+        clearCache: Boolean(clearCache),
+        clearResults: Boolean(clearResults),
+        useHttp: Boolean(useHttp),
+        gitIntegration,
+        externalStorage,
+        runner,
+        runnerConfig: runnerConfig ? JSON.parse(runnerConfig): {},
+        config,
+        projects: projects || [],
+        iterations: parseInt(iterations, 10),
+        compareStats
+    };
+}
diff --git a/packages/@best/cli/src/cli/index.ts b/packages/@best/cli/src/cli/index.ts
@@ -1,25 +1,26 @@
-import * as args from './args';
+import { normalize, usage, options, docs, check } from './args';
 import Output from './output';
 import yargs from 'yargs';
 import rimraf from 'rimraf';
-import { getConfigs } from '@best/config';
+import { getConfigs, BestCliOptions } from '@best/config';
 import { preRunMessager, errorMessager } from '@best/messager';
 import { runBest } from '../run_best';
 import { runCompare } from '../run_compare';
 
-function buildArgs(maybeArgv: string[]) {
-    const argsv = yargs(maybeArgv || process.argv.slice(2))
-        .usage(args.usage)
+export function buildArgs(maybeArgv?: string[]): BestCliOptions {
+    const parsedArgs = yargs(maybeArgv || process.argv.slice(2))
+        .usage(usage)
         .alias('help', 'h')
-        .options(args.options)
-        .epilogue(args.docs)
-        .check(args.check)
+        .options(options)
+        .epilogue(docs)
+        .check(check)
         .version(false).argv;
-    return argsv;
+
+    return normalize(parsedArgs);
 }
 
-function getProjectListFromCLIArgs(argsCLI: any, project: string): string[] {
-    const projects = argsCLI.projects ? argsCLI.projects : [];
+function getProjectListFromCLIArgs(argsCLI: BestCliOptions, project?: string): string[] {
+    const projects = argsCLI.projects;
 
     if (project) {
         projects.push(project);
@@ -32,7 +33,7 @@ function getProjectListFromCLIArgs(argsCLI: any, project: string): string[] {
     return projects;
 }
 
-export async function run(maybeArgv: string[], project: string) {
+export async function run(maybeArgv?: string[], project?: string) {
     try {
         const argsCLI = buildArgs(maybeArgv);
         const projects = getProjectListFromCLIArgs(argsCLI, project);
@@ -46,7 +47,7 @@ export async function run(maybeArgv: string[], project: string) {
     }
 }
 
-export async function runCLI(argsCLI: any, projects: string[]) {
+export async function runCLI(argsCLI: BestCliOptions, projects: string[]) {
     const outputStream: any = process.stdout;
     let rawConfigs;
     let results;
@@ -94,3 +95,5 @@ export async function runCLI(argsCLI: any, projects: string[]) {
 
     return true;
 }
+
+export { BestCliOptions };
diff --git a/packages/@best/config/src/defaults.ts b/packages/@best/config/src/defaults.ts
@@ -1,7 +1,7 @@
 import { cacheDirectory } from '@best/utils';
-import { BestCliOptions } from "./types";
+import { BestBuildOptions } from "./types";
 
-const defaultOptions: BestCliOptions = {
+const defaultOptions: BestBuildOptions = {
     cache: true,
     cacheDirectory: cacheDirectory(),
     useHttp: true,

diff --git a/packages/@best/config/src/index.ts b/packages/@best/config/src/index.ts
@@ -5,6 +5,9 @@ import { replacePathSepForRegex } from '@best/regex-util';
 import DEFAULT_CONFIG from './defaults';
 import { addGitInformation } from './git';
 import { PACKAGE_JSON, BEST_CONFIG } from './constants';
+import { BestCliOptions } from './types';
+
+export { BestCliOptions };
 
 const TARGET_COMMIT = process.env.TARGET_COMMIT;
 const BASE_COMMIT = process.env.BASE_COMMIT;
@@ -335,7 +338,7 @@ export async function readConfig(argsCLI: any, packageRoot: string, parentConfig
     return { configPath, globalConfig, projectConfig };
 }
 
-export async function getConfigs(projectsFromCLIArgs: string[], argv: string[]) {
+export async function getConfigs(projectsFromCLIArgs: string[], argv: BestCliOptions) {
     let globalConfig;
     let configs: any = [];
     let projects = projectsFromCLIArgs;

diff --git a/packages/@best/config/src/types.ts b/packages/@best/config/src/types.ts
@@ -1,4 +1,4 @@
-export interface BestCliOptions {
+export interface BestBuildOptions {
     [key: string]: any,
     cache: boolean,
     cacheDirectory: string,
@@ -28,3 +28,19 @@ export interface BestCliOptions {
     histogramMaxWidth: number,
     rootDir?: string
 }
+
+export interface BestCliOptions {
+    _: string[],
+    help: boolean,
+    clearCache: boolean,
+    clearResults: boolean,
+    gitIntegration: string | undefined,
+    useHttp: boolean,
+    externalStorage: string | undefined,
+    runner: string,
+    runnerConfig: { [x:string]: any },
+    config: string | undefined,
+    projects: string[],
+    iterations: number,
+    compareStats: string[] | undefined
+};