fix: migrate yargs and fix typing

Author: ChristopherPHolder

package-lock.json

@@ -23,7 +23,7 @@
     "@puppeteer/replay": "^1.3.1",
     "@types/concurrently": "^7.0.0",
     "@types/puppeteer": "^5.4.7",
-    "@types/yargs": "^17.0.9",
+    "@types/yargs": "^17.0.32",
     "concurrently": "^7.1.0",
     "enquirer": "^2.3.6",
     "lighthouse": "^9.6.7",
@@ -33,7 +33,8 @@
     "puppeteer": "^19.0.0",
     "rxjs": "^7.8.1",
     "ts-node": "10.9.1",
-    "tslib": "^2.3.1"
+    "tslib": "^2.3.1",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@code-pushup/cli": "^0.25.6",

package.json

@@ -14,5 +14,4 @@ export default {
   transformIgnorePatterns: ['/node_modules/(?!markdown-table/.*)'],
   moduleFileExtensions: ['ts', 'js', 'html'],
   coverageDirectory: '../../coverage/packages/cli',
-  testTimeout: 40_000,
 };

packages/cli/jest.config.ts

@@ -22,7 +22,7 @@
   "dependencies": {
     "ts-node": "10.9.1",
     "tslib": "^2.3.1",
-    "yargs": ">=15.4.1",
+    "yargs": "^17.7.2",
     "typescript": "^4.6.3",
     "lighthouse": "^9.6.7",
     "puppeteer": "^19.0.0",

packages/cli/package.json

@@ -1,9 +1,7 @@
-import {RcJsonAsArgv} from "../../types";
+import { logVerbose } from '../../core/loggin';
+import { readBudgets } from './utils/budgets';
 
-import {logVerbose} from "../../core/loggin";
-import {readBudgets} from "./utils/budgets";
-
-export async function runAssertCommand(argv: RcJsonAsArgv) {
+export async function runAssertCommand(): Promise<void> {
   logVerbose(readBudgets());
   return Promise.resolve();
 }

packages/cli/src/lib/commands/assert/command-impl.ts

@@ -1,22 +1,17 @@
 import { YargsCommandObject } from '../../core/yargs/types';
-import { logVerbose } from '../../core/loggin/index';
-import { readBudgets } from './utils/budgets';
+import { logVerbose } from '../../core/loggin';
 import { readFile } from '../../core/file';
-import { getCollectCommandOptionsFromArgv } from '../collect/utils/params';
-import { RcJson } from '../../types';
 import { generateMdReport } from './utils/md-report';
 
 export const assertCommand: YargsCommandObject = {
   command: 'assert',
   description: 'Setup .user-flowrc.json',
   module: {
-    handler: async (argv: any) => {
+    handler: async () => {
       logVerbose(`run "assert" as a yargs command`);
-      const cfg = getCollectCommandOptionsFromArgv(argv);
       const json = JSON.parse(readFile('./packages/cli/docs/raw/order-coffee.uf.json').toString());
       const mdReport = generateMdReport(json);
       console.log('md report', mdReport);
-      //  await run(cfg);
     }
   }
 };

packages/cli/src/lib/commands/assert/index.ts

@@ -0,0 +1,27 @@
+import { SharedFlagsSettings } from 'lighthouse/types/lhr/settings';
+import { Options } from 'yargs';
+
+const budgets = {
+  alias: 'j',
+  type: 'array',
+  string: true,
+  description: 'Performance budgets (RC file only)'
+} satisfies Options;
+
+const budgetPath = {
+  alias: 'k',
+  type: 'string',
+  description: 'Path to budgets.json'
+} satisfies Options;
+
+export const assertOptions = {
+  budgetPath,
+  budgets
+} satisfies Record<string, Options>;
+
+// @TODO this type has overlap with the one in rc-json.ts we should fix that and only have one
+export type AssertRcOptions = {
+  budgetPath?: string,
+  budgets?: SharedFlagsSettings['budgets']
+}
+export type AssertArgvOptions = AssertRcOptions;