Merge pull request #2820 from MartinFournier/chore/declutter

Declutter repository root

.eslintignore

@@ -1,27 +1,26 @@
 node_modules/
-dist/
-input/
 
 .dist
 .tmp
 .package
-
-assets/
-css/
+.build
 .cypress/
-cypress/
+
+dist/
+input/
+assets/
 doc/
 markdown/
-netscript_tests/
-scripts/
+
+
+test/netscript/
 
 electron/lib
 electron/greenworks.js
 src/ThirdParty/*
 src/JSInterpreter.js
+tools/engines-check/
 
-test/*.bundle.*
 editor.main.js
 main.bundle.js
 webpack.config.js
-webpack.config-test.js

README.md

@@ -6,7 +6,7 @@ Bitburner is a programming-based [incremental game](https://en.wikipedia.org/wik
 that revolves around hacking and cyberpunk themes.
 The game can be played at https://danielyxie.github.io/bitburner or installed through [Steam](https://store.steampowered.com/app/1812820/Bitburner/).
 
-See the [frequently asked questions](./FAQ.md) for more information . To discuss the game or get help, join the [official discord server](https://discord.gg/TFc3hKD)
+See the [frequently asked questions](./doc/FAQ.md) for more information . To discuss the game or get help, join the [official discord server](https://discord.gg/TFc3hKD)
 
 # Documentation
 
@@ -18,13 +18,13 @@ The [in-game documentation](./markdown/bitburner.md) is generated from the [Type
 Anyone is welcome to contribute to the documentation by editing the [source
 files](/doc/source) and then making a pull request with your contributions.
 For further guidance, please refer to the "As A Documentor" section of
-[CONTRIBUTING](CONTRIBUTING.md).
+[CONTRIBUTING](./doc/CONTRIBUTING.md).
 
 # Contribution
 
 There are many ways to contribute to the game. It can be as simple as fixing
 a typo, correcting a bug, or improving the UI. For guidance on doing so,
-please refer to the [CONTRIBUTING](CONTRIBUTING.md) document.
+please refer to the [CONTRIBUTING](./doc/CONTRIBUTING.md) document.
 
 You will retain all ownership of the Copyright of any contributions you make,
 and will have the same rights to use or license your contributions. By

cypress.json

@@ -1,10 +1,14 @@
 {
   "baseUrl": "http://localhost:8000",
-  "fixturesFolder": false,
   "trashAssetsBeforeRuns": true,
-  "screenshotsFolder": ".cypress/screenshots",
-  "videosFolder": ".cypress/videos",
   "videoUploadOnPasses": false,
   "viewportWidth": 1980,
-  "viewportHeight": 1080
+  "viewportHeight": 1080,
+  "fixturesFolder": "test/cypress/fixtures",
+  "integrationFolder": "test/cypress/integration",
+  "pluginsFile": "test/cypress/plugins/index.js",
+  "supportFile": "test/cypress/support/index.js",
+  "screenshotsFolder": ".cypress/screenshots",
+  "videosFolder": ".cypress/videos",
+  "downloadsFolder": ".cypress/downloads"
 }

doc/CONTRIBUTING.md

@@ -182,7 +182,7 @@ To contribute to and view your changes to the BitBurner documentation on [Read T
 Docs](http://bitburner.readthedocs.io/), you will
 need to have Python installed, along with [Sphinx](http://www.sphinx-doc.org).
 
-To make change to the [in-game documentation](./markdown/bitburner.md), you will need to modify the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts), not the markdown files.
+To make change to the [in-game documentation](../markdown/bitburner.md), you will need to modify the [TypeScript definitions](../src/ScriptEditor/NetscriptDefinitions.d.ts), not the markdown files.
 
 We are using [API Extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) (tsdoc hints) to generate the markdown doc. Make your changes to the TypeScript definitions and then run `npm run doc`.
 

doc/source/gamefrozen.rst

@@ -23,4 +23,4 @@ Bug
 ---
 
 Otherwise, the game is probably frozen/stuck due to a bug. To report a bug, follow
-the guidelines `here <https://github.com/danielyxie/bitburner/blob/master/CONTRIBUTING.md#reporting-bugs>`_.
+the guidelines `here <https://github.com/danielyxie/bitburner/blob/master/doc/CONTRIBUTING.md#reporting-bugs>`_.

package.json

@@ -113,7 +113,7 @@
     "build:dev": "webpack --mode development",
     "lint": "eslint --fix . --ext js,jsx,ts,tsx",
     "lint:report": "eslint --ext js,jsx,ts,tsx .",
-    "preinstall": "node ./scripts/engines-check.js",
+    "preinstall": "node ./tools/engines-check/engines-check.js",
     "test": "jest",
     "test:watch": "jest --watch",
     "watch": "webpack --watch --mode production",

src/Themes/README.md

@@ -2,7 +2,7 @@
 
 Feel free to contribute a new theme by submitting a pull request to the game!
 
-See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
+See [CONTRIBUTING.md](/doc/CONTRIBUTING.md) for details.
 
 ## How create a new theme
 

test/jest/Netscript/DynamicRamCalculation.test.js

@@ -1,13 +1,13 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect, test } from "@jest/globals";
 
-import { Player } from "../../src/Player";
-import { NetscriptFunctions } from "../../src/NetscriptFunctions";
-import { getRamCost, RamCostConstants } from "../../src/Netscript/RamCostGenerator";
-import { Environment } from "../../src/Netscript/Environment";
-import { RunningScript } from "../../src/Script/RunningScript";
-import { Script } from "../../src/Script/Script";
-import { SourceFileFlags } from "../../src/SourceFile/SourceFileFlags";
+import { Player } from "../../../src/Player";
+import { NetscriptFunctions } from "../../../src/NetscriptFunctions";
+import { getRamCost, RamCostConstants } from "../../../src/Netscript/RamCostGenerator";
+import { Environment } from "../../../src/Netscript/Environment";
+import { RunningScript } from "../../../src/Script/RunningScript";
+import { Script } from "../../../src/Script/Script";
+import { SourceFileFlags } from "../../../src/SourceFile/SourceFileFlags";
 
 jest.mock(`!!raw-loader!../NetscriptDefinitions.d.ts`, () => "", {
   virtual: true,

test/jest/Netscript/StaticRamCalculation.test.js

@@ -1,9 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect } from "@jest/globals";
 
-import { Player } from "../../src/Player";
-import { getRamCost, RamCostConstants } from "../../src/Netscript/RamCostGenerator";
-import { calculateRamUsage } from "../../src/Script/RamCalculations";
+import { Player } from "../../../src/Player";
+import { getRamCost, RamCostConstants } from "../../../src/Netscript/RamCostGenerator";
+import { calculateRamUsage } from "../../../src/Script/RamCalculations";
 
 jest.mock(`!!raw-loader!../NetscriptDefinitions.d.ts`, () => "", {
   virtual: true,

test/jest/Script/Script.test.ts

@@ -1,8 +1,8 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect, test } from "@jest/globals";
 
-import { Script } from "../../src/Script/Script";
-import { Player } from "../../src/Player";
+import { Script } from "../../../src/Script/Script";
+import { Player } from "../../../src/Player";
 
 jest.mock(`!!raw-loader!../NetscriptDefinitions.d.ts`, () => "", {
     virtual: true,
@@ -26,4 +26,4 @@ describe("Validate Save Script Works", function () {
         expect(script.code).toEqual(code)
         expect(script.server).toEqual(server)
     });
-});
+});

test/jest/StockMarket.test.ts

@@ -1,25 +1,25 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect, test } from '@jest/globals'
 
-import { CONSTANTS } from "../src/Constants";
-import { Player } from "../src/Player";
-import { IMap } from "../src/types";
+import { CONSTANTS } from "../../src/Constants";
+import { Player } from "../../src/Player";
+import { IMap } from "../../src/types";
 
-import { Company } from "../src/Company/Company";
-import { Server } from "../src/Server/Server";
+import { Company } from "../../src/Company/Company";
+import { Server } from "../../src/Server/Server";
 
-import { buyStock, sellStock, shortStock, sellShort } from "../src/StockMarket/BuyingAndSelling";
-import { IStockMarket } from "../src/StockMarket/IStockMarket";
-import { Order } from "../src/StockMarket/Order";
+import { buyStock, sellStock, shortStock, sellShort } from "../../src/StockMarket/BuyingAndSelling";
+import { IStockMarket } from "../../src/StockMarket/IStockMarket";
+import { Order } from "../../src/StockMarket/Order";
 import {
   forecastForecastChangeFromCompanyWork,
   forecastForecastChangeFromHack,
   influenceStockThroughCompanyWork,
   influenceStockThroughServerGrow,
   influenceStockThroughServerHack,
-} from "../src/StockMarket/PlayerInfluencing";
-import { processOrders, IProcessOrderRefs } from "../src/StockMarket/OrderProcessing";
-import { Stock, StockForecastInfluenceLimit } from "../src/StockMarket/Stock";
+} from "../../src/StockMarket/PlayerInfluencing";
+import { processOrders, IProcessOrderRefs } from "../../src/StockMarket/OrderProcessing";
+import { Stock, StockForecastInfluenceLimit } from "../../src/StockMarket/Stock";
 import {
   cancelOrder,
   deleteStockMarket,
@@ -29,15 +29,15 @@ import {
   processStockPrices,
   StockMarket,
   SymbolToStockMap,
-} from "../src/StockMarket/StockMarket";
+} from "../../src/StockMarket/StockMarket";
 import {
   forecastChangePerPriceMovement,
   getBuyTransactionCost,
   getSellTransactionGain,
   processTransactionForecastMovement,
-} from "../src/StockMarket/StockMarketHelpers";
-import { OrderTypes } from "../src/StockMarket/data/OrderTypes";
-import { PositionTypes } from "../src/StockMarket/data/PositionTypes";
+} from "../../src/StockMarket/StockMarketHelpers";
+import { OrderTypes } from "../../src/StockMarket/data/OrderTypes";
+import { PositionTypes } from "../../src/StockMarket/data/PositionTypes";
 
 jest.mock(`!!raw-loader!../NetscriptDefinitions.d.ts`, () => '', {
   virtual: true,

test/jest/StringHelperFunctions.test.ts

@@ -1,6 +1,6 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect, test } from '@jest/globals'
-import { convertTimeMsToTimeElapsedString } from "../src/utils/StringHelperFunctions";
+import { convertTimeMsToTimeElapsedString } from "../../src/utils/StringHelperFunctions";
 
 describe("StringHelperFunctions Tests", function () {
   it("transforms strings", () => {

test/jest/Terminal/Directory.test.js

@@ -1,6 +1,6 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect, test } from '@jest/globals'
-import * as dirHelpers from "../../src/Terminal/DirectoryHelpers";
+import * as dirHelpers from "../../../src/Terminal/DirectoryHelpers";
 
 describe("Terminal Directory Tests", function () {
   describe("removeLeadingSlash()", function () {

test/jest/Terminal/determineAllPossibilitiesForTabCompletion.test.ts

@@ -2,12 +2,12 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { jest, describe, expect, test } from "@jest/globals";
 
-import { Player } from "../../src/Player";
-import { determineAllPossibilitiesForTabCompletion } from "../../src/Terminal/determineAllPossibilitiesForTabCompletion";
-import { Server } from "../../src/Server/Server";
-import { AddToAllServers, prestigeAllServers } from "../../src/Server/AllServers";
-import { LocationName } from "../../src/Locations/data/LocationNames";
-import { CodingContract } from "../../src/CodingContracts";
+import { Player } from "../../../src/Player";
+import { determineAllPossibilitiesForTabCompletion } from "../../../src/Terminal/determineAllPossibilitiesForTabCompletion";
+import { Server } from "../../../src/Server/Server";
+import { AddToAllServers, prestigeAllServers } from "../../../src/Server/AllServers";
+import { LocationName } from "../../../src/Locations/data/LocationNames";
+import { CodingContract } from "../../../src/CodingContracts";
 
 jest.mock(`!!raw-loader!../NetscriptDefinitions.d.ts`, () => "", {
   virtual: true,