Scripts Refactor (#296)

* Relocate script configuration files

* Update template scripts to use commander with extra typings

* Scripts v3

* Update eslint configuration to work with new scripts folder layout

* Fix bundle tests

* Fix jest setup for scripts

* Fix prebuild tests

* Fixed bug where jsons were not writing descriptions for functions

* Relocate retrieveManifest to make it easier to mock during testing

* Fixing broken tests

* Update jest and astring packages

* Standardize tests for commands

* Fix tsc tests

* Temporarily skip json tests

* Update linting for modules

* Update CI to use node 20

* Update CI to install dependencies required by gl

* Fix linting errors

* Fix bug where return types of functions were not being generated correctly

* Add handling case for unknown types generated by typedoc

* Use array for function parameters to respect parameter order

* Update to flat config for ESLint configuration

* Update dependencies

* Fix tests and standardize commands

* Fix linting with new eslint configuration

* Fix regression where linter wasn't properly linting all files

* Fix issue where jsons were being generated with invalid types

* Use import attributes instead of assertions and update linting configuration to ignore more files

* Update linting configuration to use spaces instead of tabs uniformly

* Disable Prettier for project

Prevents conflicts when VS Code already has format-on-save set up.

* Add .node-version file

* Add tests for template command and fix template command bugs

* Fix the issue where the scripts wouldn't exit automatically after execution

* Remove some uh, idk what this is supposed to be

* Update linting packages and configurations

* Fix linting again :(

* Run linting with updated config

* Bump CI workflow dependencies

* Reformat

* Update eslint configuration again

* Run linting with updated configuration

* Run linter

* Fix incorrect comment location

* Fix the import order for @src imports

* Change import duplicates lint rule setting to not prefer inline type modifier

* Replace magic numbers with constants

For better code readability.

* Remove remaining stray tab characters

* Enforce semicolons

* Fix lockfile post-merge

* Deduplicate dependencies

* Fix lint post-merge

* Fix lint error post-merge

* Fix test compile error

---------

Co-authored-by: Richard Dominick <34370238+RichDom2185@users.noreply.github.com>

Author: leeyi45

.eslintrc.base.cjs

@@ -10,19 +10,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Use Node.js 💻
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: 20
+          cache: yarn
 
-      - name: Install Dependencies 📦
+      - name: Install dependencies (apt)
         run: |
-          yarn --frozen-lockfile
+          sudo apt-get update && \
+          sudo apt-get install -y --no-install-recommends libxi-dev libgl1-mesa-dev
+      
+      - name: Install Dependencies 📦
+        run: yarn install --frozen-lockfile
 
       - name: Build Modules 🔧
-        run: yarn run build --tsc --lint
+        run: yarn build --tsc --lint
 
       - name: Deploy 🚀
         uses: peaceiris/actions-gh-pages@v3

.eslintrc.test.cjs

@@ -10,12 +10,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
         - name: Check out source code
-          uses: actions/checkout@v2
+          uses: actions/checkout@v4
 
         - name: Use Node.js 💻
-          uses: actions/setup-node@v1
+          uses: actions/setup-node@v4
           with:
-            node-version: '16.x'
+            node-version: 20
+            cache: yarn
+
+        - name: Install dependencies (apt)
+          run: |
+            sudo apt-get update && \
+            sudo apt-get install -y --no-install-recommends libxi-dev libgl1-mesa-dev
 
         - name: Install dependencies
           run: yarn install --frozen-lockfile

.github/workflows/pages-deploy.yml

@@ -0,0 +1 @@
+20.11.1

.github/workflows/pull-request.yml

@@ -0,0 +1,2 @@
+# We don't use Prettier for this project
+*

.node-version

@@ -1,8 +1,4 @@
 {
-  "eslint.workingDirectories": [
-    "src",
-    "scripts/src",
-    "devserver"
-  ],
+  "eslint.experimental.useFlatConfig": true,
   "files.eol": "\r\n",
 }

.prettierignore

@@ -1,5 +1,5 @@
-import { AnchorButton, Button, Icon, type IconName, Intent } from "@blueprintjs/core";
-import React from "react";
+import { AnchorButton, Button, Icon, type IconName, Intent } from '@blueprintjs/core';
+import React from 'react';
 
 type ButtonOptions = {
   className: string;
@@ -8,7 +8,7 @@ type ButtonOptions = {
   iconOnRight: boolean;
   intent: Intent;
   minimal: boolean;
-  type?: "submit" | "reset" | "button";
+  type?: 'button' | 'reset' | 'submit';
 };
 
 type ControlButtonProps = {
@@ -20,45 +20,45 @@ type ControlButtonProps = {
 };
 
 const defaultOptions = {
-	className: "",
-	fullWidth: false,
-	iconOnRight: false,
-	intent: Intent.NONE,
-	minimal: true
+  className: '',
+  fullWidth: false,
+  iconOnRight: false,
+  intent: Intent.NONE,
+  minimal: true
 };
 
 const ControlButton: React.FC<ControlButtonProps> = ({
-	label = "",
-	icon,
-	onClick,
-	options = {},
-	isDisabled = false
+  label = '',
+  icon,
+  onClick,
+  options = {},
+  isDisabled = false
 }) => {
-	const buttonOptions: ButtonOptions = {
-		...defaultOptions,
-		...options
-	};
-	const iconElement = icon && <Icon icon={icon} color={buttonOptions.iconColor} />;
-	// Refer to #2417 and #2422 for why we conditionally
-	// set the button component. See also:
-	// https://blueprintjs.com/docs/#core/components/button
-	const ButtonComponent = isDisabled ? AnchorButton : Button;
+  const buttonOptions: ButtonOptions = {
+    ...defaultOptions,
+    ...options
+  };
+  const iconElement = icon && <Icon icon={icon} color={buttonOptions.iconColor} />;
+  // Refer to #2417 and #2422 for why we conditionally
+  // set the button component. See also:
+  // https://blueprintjs.com/docs/#core/components/button
+  const ButtonComponent = isDisabled ? AnchorButton : Button;
 
-	return (
-		<ButtonComponent
-			disabled={isDisabled}
-			fill={buttonOptions.fullWidth}
-			intent={buttonOptions.intent}
-			minimal={buttonOptions.minimal}
-			className={buttonOptions.className}
-			type={buttonOptions.type}
-			onClick={onClick}
-			icon={!buttonOptions.iconOnRight && iconElement}
-			rightIcon={buttonOptions.iconOnRight && iconElement}
-		>
-			{label}
-		</ButtonComponent>
-	);
+  return (
+    <ButtonComponent
+      disabled={isDisabled}
+      fill={buttonOptions.fullWidth}
+      intent={buttonOptions.intent}
+      minimal={buttonOptions.minimal}
+      className={buttonOptions.className}
+      type={buttonOptions.type}
+      onClick={onClick}
+      icon={!buttonOptions.iconOnRight && iconElement}
+      rightIcon={buttonOptions.iconOnRight && iconElement}
+    >
+      {label}
+    </ButtonComponent>
+  );
 };
 
 export default ControlButton;