NETSCRIPT: Add .script deprecation notice & migration guide

src/Documentation/doc/index.md

@@ -53,3 +53,4 @@
 
 - [v1.0.0 script migration guide](migrations/v1.md)
 - [v2.0.0 script migration guide](migrations/v2.md)
+- [Netscript 2 migration guide](migrations/ns2.md)

src/Documentation/doc/migrations/ns2.md

@@ -0,0 +1,57 @@
+# Netscript 2 Migration Guide
+
+With the deprecation of NS1 (`.script`) there are required changes to migrate scripts over to NS2 (`.js`).
+
+## Basic Steps
+1. You need to wrap the entire script inside of an exported main function, like so:
+```js
+/** @param {NS} ns */
+export async function main(ns) {
+  // your code here
+}
+```
+2. Add `ns.` as a prefix to all game functions (such as `ns.hack()` or `ns.nuke()`).
+3. If a function returns a `Promise`, you need to put the `await` keyword before it (With the JSDoc comment you can hover over the function to see the return type).
+4. Long-running loops (like `while(true)`) need to `await` a function (usually `ns.sleep()`) at least once or they will crash the game.
+
+## A demonstration of migration
+
+Original (`early-hacking-template.script`):
+```js
+var target = "n00dles";
+var moneyThresh = getServerMaxMoney(target) * 0.9;
+var securityThresh = getServerMinSecurityLevel(target) + 5;
+
+while(true) {
+  if (getServerSecurityLevel(target) > securityThresh) {
+    weaken(target);
+  } else if (getServerMoneyAvailable(target) < moneyThresh) {
+    grow(target);
+  } else {
+    hack(target);
+  }
+}
+```
+Migrated (`early-hacking-template.js`):
+```js
+/** @param {NS} ns */
+export async function main(ns) {
+  const target = "n00dles";
+  const moneyThresh = ns.getServerMaxMoney(target) * 0.9;
+  const securityThresh = ns.getServerMinSecurityLevel(target) + 5;
+
+  while(true) {
+    if (ns.getServerSecurityLevel(target) > securityThresh) {
+      await ns.weaken(target);
+    } else if (ns.getServerMoneyAvailable(target) < moneyThresh) {
+      await ns.grow(target):
+    } else {
+      await ns.hack(target);
+    }
+  }
+}
+```
+
+## Additional problems or edge cases
+
+To get additional help with the migration join the [official Discord server](https://discord.gg/TFc3hKD).

src/Documentation/pages.ts

@@ -40,6 +40,7 @@ import file37 from "!!raw-loader!./doc/programming/go_algorithms.md";
 import file38 from "!!raw-loader!./doc/programming/hackingalgorithms.md";
 import file39 from "!!raw-loader!./doc/programming/learn.md";
 import file40 from "!!raw-loader!./doc/programming/remote_api.md";
+import file41 from "!!raw-loader!./doc/migrations/ns2.md"
 
 interface Document {
   default: string;
@@ -86,3 +87,4 @@ AllPages["programming/go_algorithms.md"] = file37;
 AllPages["programming/hackingalgorithms.md"] = file38;
 AllPages["programming/learn.md"] = file39;
 AllPages["programming/remote_api.md"] = file40;
+AllPages["migrations/ns2.md"] = file41;

src/Terminal/commands/common/deprecation.ts

@@ -0,0 +1,8 @@
+import { Terminal } from "../../../Terminal";
+
+export function sendDeprecationNotice() {
+  return Terminal.warn(
+    "NOTICE: NS1 (.script) scripts are deprecated and will be removed in a future update." +
+    " Migrate to NS2 (.js) scripts instead."
+  );
+}

src/Terminal/commands/common/editor.ts

@@ -6,6 +6,7 @@ import { CursorPositions } from "../../../ScriptEditor/CursorPositions";
 import { ScriptFilePath, hasScriptExtension } from "../../../Paths/ScriptFilePath";
 import { TextFilePath, hasTextExtension } from "../../../Paths/TextFilePath";
 import { getGlobbedFileMap } from "../../../Paths/GlobbedFiles";
+import { sendDeprecationNotice } from "./deprecation";
 
 // 2.3: Globbing implementation was removed from this file. Globbing will be reintroduced as broader functionality and integrated here.
 
@@ -30,12 +31,14 @@ export function commonEditor(
 ): void {
   if (args.length < 1) return Terminal.error(`Incorrect usage of ${command} command. Usage: ${command} [scriptname]`);
   const files = new Map<ScriptFilePath | TextFilePath, string>();
+  let hasNs1 = false;
   for (const arg of args) {
     const pattern = String(arg);
 
     // Glob of existing files
     if (pattern.includes("*") || pattern.includes("?")) {
       for (const [path, file] of getGlobbedFileMap(pattern, server, Terminal.currDir)) {
+        if (path.endsWith(".script")) hasNs1 = true;
         files.set(path, file.content);
       }
       continue;
@@ -47,10 +50,14 @@ export function commonEditor(
     if (!hasScriptExtension(path) && !hasTextExtension(path)) {
       return Terminal.error(`${command}: Only scripts or text files can be edited. Invalid file type: ${arg}`);
     }
+    if (path.endsWith(".script")) hasNs1 = true;
     const file = server.getContentFile(path);
     const content = file ? file.content : isNs2(path) ? newNs2Template : "";
     files.set(path, content);
     if (content === newNs2Template) CursorPositions.saveCursor(path, { row: 3, column: 5 });
   }
+  if (hasNs1) {
+    sendDeprecationNotice();
+  }
   Router.toPage(Page.ScriptEditor, { files, options });
 }

src/Terminal/commands/runScript.ts

@@ -8,6 +8,7 @@ import { formatRam } from "../../ui/formatNumber";
 import { ScriptArg } from "@nsdefs";
 import { isPositiveInteger } from "../../types";
 import { ScriptFilePath } from "../../Paths/ScriptFilePath";
+import { sendDeprecationNotice } from "./common/deprecation";
 
 export function runScript(path: ScriptFilePath, commandArgs: (string | number | boolean)[], server: BaseServer): void {
   // This takes in the absolute filepath, see "run.ts"
@@ -52,6 +53,9 @@ export function runScript(path: ScriptFilePath, commandArgs: (string | number |
   const success = startWorkerScript(runningScript, server);
   if (!success) return Terminal.error(`Failed to start script`);
 
+  if (path.endsWith(".script")) {
+    sendDeprecationNotice();
+  }
   Terminal.print(
     `Running script with ${numThreads} thread(s), pid ${runningScript.pid} and args: ${JSON.stringify(args)}.`,
   );