refactor: rename report command to upload

Author: patrickhulce

README.md

@@ -22,10 +22,10 @@ lighthouse-ci collect --numberOfRuns=5 --url=https://example.com
 
 Runs Lighthouse `N` times and stores the LHRs in a local `.lighthouseci/` folder, similar to the way test coverage tools operate.
 
-### `report`
+### `upload`
 
 ```bash
-lighthouse-ci report
+lighthouse-ci upload
 ```
 
 Saves all the runs in the `.lighthouseci/` folder to the server as a single build, similar to a Coveralls/CodeCov upload step. In the future, I imagine this can also return the results of the server's assertions against the parent hash.
@@ -73,7 +73,7 @@ lighthouse-ci --rc-file=path/to/different/rc/file <command>
     "collect": {
       "numberOfRuns": 2
     },
-    "report": {
+    "upload": {
       "serverBaseUrl": "http://localhost:9009"
     },
     "server": {

src/cli.js

@@ -10,7 +10,7 @@ const yargs = require('yargs');
 const loadAndParseRcFile = require('./shared/lighthouserc.js').loadAndParseRcFile;
 const getVersion = require('./shared/version.js').getVersion;
 const assertCmd = require('./assert/assert.js');
-const reportCmd = require('./report/report.js');
+const uploadCmd = require('./upload/upload.js');
 const collectCmd = require('./collect/collect.js');
 const serverCmd = require('./server/server.js');
 const wizardCmd = require('./wizard/wizard.js');
@@ -27,8 +27,8 @@ async function run() {
     .command('collect', 'Run Lighthouse and save the results to a local folder', commandYargs =>
       collectCmd.buildCommand(commandYargs)
     )
-    .command('report', 'Save the results to the server', commandYargs =>
-      reportCmd.buildCommand(commandYargs)
+    .command('upload', 'Save the results to the server', commandYargs =>
+      uploadCmd.buildCommand(commandYargs)
     )
     .command('assert', 'Assert that the latest results meet expectations', commandYargs =>
       assertCmd.buildCommand(commandYargs)
@@ -44,8 +44,8 @@ async function run() {
     case 'assert':
       await assertCmd.runCommand(argv);
       break;
-    case 'report':
-      await reportCmd.runCommand(argv);
+    case 'upload':
+      await uploadCmd.runCommand(argv);
       break;
     case 'server': {
       const {port} = await serverCmd.runCommand(argv);

src/shared/lighthouserc.js

@@ -9,7 +9,7 @@ const fs = require('fs');
 const path = require('path');
 const _ = require('./lodash.js');
 
-/** @typedef {Partial<LHCI.AssertCommand.Options & LHCI.CollectCommand.Options & LHCI.ReportCommand.Options & LHCI.ServerCommand.Options & {extends?: string | undefined}>} YargsOptions */
+/** @typedef {Partial<LHCI.AssertCommand.Options & LHCI.CollectCommand.Options & LHCI.UploadCommand.Options & LHCI.ServerCommand.Options & {extends?: string | undefined}>} YargsOptions */
 
 /**
  * @param {string} pathToRcFile
@@ -31,7 +31,7 @@ function loadAndParseRcFile(pathToRcFile) {
 function convertRcFileToYargsOptions(rcFile, pathToRcFile) {
   const {ci = {}} = rcFile;
   /** @type {YargsOptions} */
-  let merged = {...ci.assert, ...ci.collect, ...ci.report, ...ci.server};
+  let merged = {...ci.assert, ...ci.collect, ...ci.upload, ...ci.server};
   if (ci.extends) {
     const extendedRcFilePath = path.resolve(path.dirname(pathToRcFile), ci.extends);
     const extensionBase = loadAndParseRcFile(extendedRcFilePath);

src/report/report.js src/upload/upload.js

@@ -106,7 +106,7 @@ function getAncestorHash() {
 }
 
 /**
- * @param {LHCI.ReportCommand.Options} options
+ * @param {LHCI.UploadCommand.Options} options
  * @return {Promise<void>}
  */
 async function runCommand(options) {

test/cli.test.js

@@ -104,12 +104,12 @@ describe('Lighthouse CI CLI', () => {
     }, 60000);
   });
 
-  describe('report', () => {
+  describe('upload', () => {
     let uuids;
     it('should read LHRs from folders', () => {
       let {stdout = '', stderr = '', status = -1} = spawnSync(
         CLI_PATH,
-        ['report', `--serverBaseUrl=http://localhost:${serverPort}`],
+        ['upload', `--serverBaseUrl=http://localhost:${serverPort}`],
         {env: {...process.env, LHCI_TOKEN: projectToken}}
       );
 

test/fixtures/lighthouserc.json

@@ -13,7 +13,7 @@
         "budgets": [{"resourceSizes": [{"resourceType": "script", "budget": 1}]}]
       }
     },
-    "report": {
+    "upload": {
       "serverBaseUrl": "http://localhost:9009"
     },
     "server": {

types/lighthouserc.d.ts

@@ -11,7 +11,7 @@ declare global {
         extends?: string;
         assert?: Partial<AssertCommand.Options>;
         collect?: Partial<CollectCommand.Options>;
-        report?: Partial<ReportCommand.Options>;
+        upload?: Partial<UploadCommand.Options>;
         server?: Partial<ServerCommand.Options>;
       };
     }

types/report.d.ts types/upload.d.ts

@@ -6,7 +6,7 @@
 
 declare global {
   namespace LHCI {
-    namespace ReportCommand {
+    namespace UploadCommand {
       export interface Options {
         token: string;
         serverBaseUrl: string;