Continue fixing buildtools

Author: leeyi45

docs/src/modules/2-bundle/2-creating/2-creating.md

@@ -42,7 +42,7 @@ The command should have creates a new folder `src/bundles/new_bundle` with all t
 
 ![](./new_bundle.png)
 
-From there you can edit your bundle as necessary
+From there, you can edit your bundle as necessary.
 
 ## Naming your Bundle
 
@@ -52,4 +52,4 @@ The name of your bundle is what Source users will import from to actually use yo
 import { func } from 'new_bundle';
 ```
 
-Your bundle's name should be concise and give be somewhat descriptive of what functionalities your bundle provides.
+Your bundle's name should be concise and be somewhat descriptive of what functionalities your bundle provides.

lib/buildtools/src/commands/build.ts

@@ -35,7 +35,7 @@ export const getBuildBundleCommand = () => new Command('bundle')
     }
 
     const results = await runBuilderWithPrebuild(builders.buildBundle, opts, result.bundle, outDir, 'bundle', false);
-    console.log(formatResultObject(results));
+    console.log(formatResultObject({ prebuild: results }));
     cmdUtils.processResult(results, opts.ci);
   });
 
@@ -63,7 +63,7 @@ export const getBuildTabCommand = () => new Command('tab')
     }
 
     const results = await runBuilderWithPrebuild(builders.buildTab, opts, tab, outDir, 'tab', false);
-    console.log(formatResultObject(results));
+    console.log(formatResultObject({ prebuild: results }));
     cmdUtils.processResult(results, opts.ci);
   });
 
@@ -78,7 +78,7 @@ export const getBuildDocsCommand = () => new Command('docs')
       cmdUtils.logCommandErrorAndExit(`No bundle found at ${directory}!`);
     } else if (manifestResult.severity === 'success') {
       const docResult = await builders.buildSingleBundleDocs(manifestResult.bundle, outDir, logLevel);
-      console.log(formatResultObject({ docs: docResult }));
+      console.log(formatResultObject({ prebuild: { docs: docResult } }));
       cmdUtils.processResult({ results: docResult }, ci);
     } else {
       cmdUtils.logCommandErrorAndExit(manifestResult);
@@ -104,7 +104,7 @@ export const getBuildAllCommand = () => new Command('all')
     }
 
     const result = await builders.buildAll(resolvedResult.asset, opts, outDir, opts.logLevel);
-    console.log(formatResultObject(result));
+    console.log(formatResultObject({ prebuild: result }));
     cmdUtils.processResult(result, opts.ci);
   });
 

lib/buildtools/src/formatter.ts

@@ -2,12 +2,12 @@ import pathlib from 'path';
 import chalk from 'chalk';
 import partition from 'lodash/partition.js';
 import ts from 'typescript';
-import type { OverallResultType, FormattableTscResult, JsonResult } from '@sourceacademy/modules-repotools/build';
+import type { OverallResultType, FormattableTscResult } from '@sourceacademy/modules-repotools/build';
+import type { LintResult } from '@sourceacademy/modules-repotools/prebuild/lint';
 
 interface ResultsObject {
   tsc?: FormattableTscResult;
   lint: LintResult;
-  results?: OverallResultType;
 }
 
 export function formatLintResult({ severity, formatted, input }: LintResult): string {
@@ -23,27 +23,6 @@ export function formatLintResult({ severity, formatted, input }: LintResult): st
   }
 }
 
-/**
- * Formats a single result object into a string
- */
-export function formatResult(result: OverallResultType) {
-  if (result.severity === 'error') {
-    return result.errors.join('\n');
-  }
-
-  const typeStr = type ?? 'output';
-  const successStr = chalk.greenBright(`${typeStr} written to ${result.path}`);
-
-  if (result.severity === 'warn') {
-    return [
-      ...result.warnings,
-      successStr
-    ].join('\n');
-  }
-
-  return successStr;
-}
-
 export function formatTscResult(tscResult: FormattableTscResult): string {
   const prefix = chalk.cyanBright('tsc completed');
 
@@ -80,18 +59,22 @@ export function formatTscResult(tscResult: FormattableTscResult): string {
 /**
  * Formats a larger result object, particularly one with prebuild results too.
  */
-export function formatResultObject(results: ResultsObject): string {
+export function formatResultObject({ tsc, lint }: ResultsObject, result: OverallResultType): string {
   const args: string[] = [];
 
-  if (results.tsc) {
-    args.push(formatTscResult(results.tsc));
+  if (tsc) {
+    args.push(formatTscResult(tsc));
   }
 
-  if (results.lint) {
-    args.push(formatLintResult(results.lint));
+  if (lint) {
+    args.push(formatLintResult(lint));
+  }
+
+  if (result.severity === 'error') {
+    result.diagnostics !== undefined
   }
 
-  if (results.results !== undefined) {
+  if (result.diagnostics !== undefined) {
     args.push(formatResult(results.results));
   }