UI: API Break changes more verbose in terminal. Colorized some commands terminal output. #2235

ZManak · 2025-07-08T19:34:38Z

Deploy on GitHub Pages

…rminal output for commands

d0sboots · 2025-07-08T20:03:09Z

.github/workflows/Create deploy-dev.yml

@@ -0,0 +1,33 @@
+name: "Deploy new pages build"


This seems accidental? In any case, revert - we already have one of these.

d0sboots · 2025-07-08T20:04:33Z

src/Programs/Programs.ts

-      Terminal.print("This executable cannot be run.");
-      Terminal.print("DeepscanV1.exe lets you run 'scan-analyze' with a depth up to 5.");
+      Terminal.error("This executable cannot be run.");
+      Terminal.warn("DeepscanV1.exe lets you run 'scan-analyze' with a depth up to 5.");


This doesn't feel like a warning to me.

d0sboots · 2025-07-08T20:05:03Z

src/Programs/Programs.ts

-      Terminal.print("This executable cannot be run.");
-      Terminal.print("DeepscanV2.exe lets you run 'scan-analyze' with a depth up to 10.");
+      Terminal.error("This executable cannot be run.");
+      Terminal.warn("DeepscanV2.exe lets you run 'scan-analyze' with a depth up to 10.");


d0sboots · 2025-07-08T20:11:22Z

src/Programs/Programs.ts

      }

-      Terminal.print(targetServer.hostname + ":");
+      if (targetServer.hasAdminRights) {


Admin rights are not relevant to hacking. We should leave this out, to avoid furthering this misconception.

d0sboots · 2025-07-08T20:17:24Z

src/Programs/Programs.ts

+      }
      Terminal.print("Server base security level: " + targetServer.baseDifficulty);
-      Terminal.print("Server current security level: " + targetServer.hackDifficulty);
+      if (targetServer.hackDifficulty > targetServer.baseDifficulty) {


This is complicated and I'm not sure that it's a good idea. Let's revert this part for now, and do a different PR later that focuses on augmenting ServerProfiler if you still want to later. (The built-in.exe tools are intentionally crude to nudge you towards writing your own.)

d0sboots · 2025-07-08T20:19:47Z

src/Programs/Programs.ts

-      Terminal.print("AutoLink.exe lets you automatically connect to other servers when using 'scan-analyze'.");
-      Terminal.print("When using scan-analyze, click on a server's hostname to connect to it.");
+      Terminal.error("This executable cannot be run.");
+      Terminal.warn("AutoLink.exe lets you automatically connect to other servers when using 'scan-analyze'.");


I'm going to comment on all of the following simply with "info" to say that these are informational messages only so I don't think it's appropriate to use .warn

d0sboots · 2025-07-08T20:20:02Z

src/Programs/Programs.ts

-      Terminal.print("This executable cannot be run.");
-      Terminal.print("Formulas.exe lets you use the formulas API.");
+      Terminal.error("This executable cannot be run.");
+      Terminal.warn("Formulas.exe lets you use the formulas API.");


d0sboots · 2025-07-08T20:24:29Z

src/utils/APIBreaks/APIBreak.ts

          ? `\n\nWe found ${pluralize(detail.totalDetectedLines, "affected line")}.`
          : ""),
    );
+


Extra newline

d0sboots · 2025-07-08T20:31:15Z

src/utils/APIBreaks/APIBreak.ts

    ++popUpIndex;
  }
+  //Made terminal more verbose
+  for (const detail of details) {


I like the idea of showing the info on the terminal, possibly instead of pop-ups. But this is (incorrectly) duplicating logic that the pop-ups use. It should run in the same loop and use the same code.

d0sboots · 2025-07-08T20:34:43Z

@catloversg I've noticed when running the dev version that the number of pop-ups can be quite busy. What do you think about having the main overview still as a single pop-up, but printing the details to the console instead? (This PR currently does it as well.)

This would avoid pop-up exhaustion, and also the console has scrollback.

d0sboots · 2025-07-08T20:44:22Z

src/Terminal/HelpText.ts

-  "    vim [files...]                   Text editor - Open up and edit one or more scripts or text files in vim mode",
-  "    weaken                           Reduce the security of the current machine",
-  "    wget [url] [target file]         Retrieves code/text from a web server",
+  colors.green +


This is going to require a systemically different approach to avoid destroying the formatting we have here.

The first step is to use template string literals. This means it's probably time to turns this whole thing into a single template string, which can embed newlines, rather than having an array of strings.

The next step is to choose a set of short, equal-sized constants to use. You only need three, for green, yellow and reset. I would suggest CMD, ARG and TXT. You can then embed those in the string via {CMD} etc, and the even spacing will be preserved.

catloversg · 2025-07-09T15:45:49Z

@catloversg I've noticed when running the dev version that the number of pop-ups can be quite busy. What do you think about having the main overview still as a single pop-up, but printing the details to the console instead? (This PR currently does it as well.)

This would avoid pop-up exhaustion, and also the console has scrollback.

That sounds like a good idea.

ZManak · 2025-07-09T17:45:39Z

@catloversg I've noticed when running the dev version that the number of pop-ups can be quite busy. What do you think about having the main overview still as a single pop-up, but printing the details to the console instead? (This PR currently does it as well.)

This would avoid pop-up exhaustion, and also the console has scrollback.

I get it would be an only popup with all the relevant info together with a terminal output more detailed

d0sboots · 2025-07-09T20:53:07Z

src/Terminal/HelpText.ts

-  cyan: "\x1b[36m",
-  white: "\x1b[37m",
-  reset: "\x1b[0m",
+  cmd: "\x1b[32m",


My suggestion here was to use all-caps to signify that they're constants, and then just define three separate constants CMD ARGS and TXT, not members of an object.

Normally what you have here would be the better practice, but in this specific case where they're being used so much in string formatting, keeping them small and avoiding visual noise is more important.

d0sboots · 2025-07-09T20:53:40Z

src/Terminal/HelpText.ts

-    "Retrieves code/text from a web server",
-  " ",
-];
+/* const commands = {


d0sboots · 2025-07-09T20:56:41Z

src/Terminal/HelpText.ts

 export const HelpTexts: Record<string, string[]> = {
  alias: [
-    colors.yellow + 'Usage: alias [-g] [name="value"] ',
+    'Usage: alias [-g] [name="value"] ',


If you want, you can also convert these to template strings and add coloring to them. But it is by no means required; this PR is already plenty big.

d0sboots · 2025-07-09T21:05:33Z

src/utils/APIBreaks/APIBreak.ts

-  for (const detail of details) {
-    if (detail.totalDetectedLines > 0) {
-      Terminal.warn("_____________");
+  for (const detail of details) { 


Looking at this, and thinking through the consequences, I realize that switching to writing the details in the terminal will actually be rather involved, with only the smallest part of it being showing the details in color. (There's stuff like renaming fields where "showPopup" isn't correct anymore.)

So, I'm going to suggest that we cut that from this PR to avoid score creep, and do it in a different PR (possibly in parallel) that can focus solely on that.

ZManak and others added 6 commits June 13, 2025 13:35

Create Create deploy-dev.yml

03410bc

Deploy on GitHub Pages

Merge branch 'dev' of https://github.com/ZManak/bitburner-src into dev

88bb45c

more changes

166cfc4

MISC: enhance terminal verbosity for API break warnings. CColorize te…

9abaa65

…rminal output for commands

lint/format

0ad5adf

Merge branch 'bitburner-official:dev' into terminal-color

fda3add

d0sboots reviewed Jul 8, 2025

View reviewed changes

APIBreak output in terminal, reduced popups

aaf750c

d0sboots reviewed Jul 9, 2025

View reviewed changes

catloversg mentioned this pull request Jul 16, 2025

UI: Show terminal warning instead of popup for breaking changes #2244

Merged

UI: API Break changes more verbose in terminal. Colorized some commands terminal output. #2235

Are you sure you want to change the base?

UI: API Break changes more verbose in terminal. Colorized some commands terminal output. #2235

Uh oh!

Conversation

ZManak commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

d0sboots commented Jul 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

catloversg commented Jul 9, 2025

Uh oh!

ZManak commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ZManak commented Jul 8, 2025 •

edited

Loading

ZManak commented Jul 9, 2025 •

edited

Loading