Skip to content

Commit

Permalink
[tgui] Bumps node & yarn versions (#87700)
Browse files Browse the repository at this point in the history
- Node 22 LTS and Yarn 4.5.1
- Removes windows 7 compatibility support
- Set to install for you on the next build
- CI also bumped to Node LTS
Oil change for TGUI. Up to date and fresh!

N/A
  • Loading branch information
jlsnow301 authored and LikeLakers2 committed Jan 21, 2025
1 parent c6a521c commit 9796cd6
Showing 8 changed files with 1,038 additions and 962 deletions.
4 changes: 1 addition & 3 deletions dependencies.sh
Original file line number Diff line number Diff line change
@@ -11,9 +11,7 @@ export BYOND_MINOR=1637
export RUST_G_VERSION=3.3.0

#node version
export NODE_VERSION_LTS=20.13.0
# compatiblility mode MUST work with windows 7
export NODE_VERSION_COMPAT=20.2.0
export NODE_VERSION_LTS=22.11.0

# SpacemanDMM git tag
export SPACEMAN_DMM_VERSION=suite-1.8
893 changes: 0 additions & 893 deletions tgui/.yarn/releases/yarn-4.1.1.cjs

This file was deleted.

934 changes: 934 additions & 0 deletions tgui/.yarn/releases/yarn-4.5.1.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion tgui/.yarnrc.yml
Original file line number Diff line number Diff line change
@@ -14,4 +14,4 @@ pnpEnableEsmLoader: false

preferInteractive: true

yarnPath: .yarn/releases/yarn-4.1.1.cjs
yarnPath: .yarn/releases/yarn-4.5.1.cjs
148 changes: 98 additions & 50 deletions tgui/README.md
Original file line number Diff line number Diff line change
@@ -4,15 +4,21 @@

tgui is a robust user interface framework of /tg/station.

tgui is very different from most UIs you will encounter in BYOND programming. It is heavily reliant on Javascript and web technologies as opposed to DM. If you are familiar with NanoUI (a library which can be found on almost every other SS13 codebase), tgui should be fairly easy to pick up.
tgui is very different from most UIs you will encounter in BYOND programming. It
is heavily reliant on Javascript and web technologies as opposed to DM. If you
are familiar with NanoUI (a library which can be found on almost every other
SS13 codebase), tgui should be fairly easy to pick up.

## Learn tgui

People come to tgui from different backgrounds and with different learning styles. Whether you prefer a more theoretical or a practical approach, we hope you’ll find this section helpful.
People come to tgui from different backgrounds and with different learning
styles. Whether you prefer a more theoretical or a practical approach, we hope
you’ll find this section helpful.

### Practical Tutorial

If you are completely new to frontend and prefer to **learn by doing**, start with our [practical tutorial](docs/tutorial-and-examples.md).
If you are completely new to frontend and prefer to **learn by doing**, start
with our [practical tutorial](docs/tutorial-and-examples.md).

### Guides

@@ -21,7 +27,9 @@ This project uses **Inferno** - a very fast UI rendering engine with a similar A
- [React guide](https://reactjs.org/docs/hello-world.html)
- [Inferno documentation](https://infernojs.org/docs/guides/components) - highlights differences with React.

If you were already familiar with an older, Ractive-based tgui, and want to translate concepts between old and new tgui, read this [interface conversion guide](docs/converting-old-tgui-interfaces.md).
If you were already familiar with an older, Ractive-based tgui, and want to
translate concepts between old and new tgui, read this
[interface conversion guide](docs/converting-old-tgui-interfaces.md).

### Other Documentation

@@ -32,37 +40,45 @@ If you were already familiar with an older, Ractive-based tgui, and want to tran

## Pre-requisites

If you are using the tooling provided in this repo, everything is included! Feel free to skip this step.
If you are using the tooling provided in this repo, everything is included! Feel
free to skip this step.

However, if you want finer control over the installation or build process, you will need these:
However, if you want finer control over the installation or build process, you
will need these:

- [Node v16.13+](https://nodejs.org/en/download/)
- [Node v22.11+](https://nodejs.org/en/download/)
- **LTS** release is recommended instead of latest
- **DO NOT install Chocolatey if Node installer asks you to!**
- [Yarn v1.22.4+](https://yarnpkg.com/getting-started/install)
- [Yarn v4.5.1+](https://yarnpkg.com/getting-started/install)
- You can run `npm install -g yarn` to install it.

## Usage

**Via provided cmd scripts (Windows)**:

- `bin/tgui-build` - Build tgui in production mode and run a full suite of code checks.
- `bin/tgui-build` - Build tgui in production mode and run a full suite of code
checks.
- `bin/tgui-dev` - Launch a development server.
- `bin/tgui-dev --reload` - Reload byond cache once.
- `bin/tgui-dev --debug` - Run server with debug logging enabled.
- `bin/tgui-dev --no-hot` - Disable hot module replacement (helps when doing development on IE8).
- `bin/tgui-dev --no-hot` - Disable hot module replacement (helps when doing
development on IE8).
- `bin/tgui-sonar` - Analyze code with SonarQube.
- `bin/tgui-bench` - Run benchmarks.

> To open a CMD or PowerShell window in any open folder, right click **while holding Shift** on any free space in the folder, then click on either `Open command window here` or `Open PowerShell window here`.
> To open a CMD or PowerShell window in any open folder, right click **while
> holding Shift** on any free space in the folder, then click on either
> `Open command window here` or `Open PowerShell window here`.
**Via Juke Build (cross-platform)**:

- `tools/build/build tgui` - Build tgui in production mode.
- `tools/build/build tgui-dev` - Build tgui in production mode.
- `tools/build/build tgui-dev --reload` - Reload byond cache once.
- `tools/build/build tgui-dev --debug` - Run server with debug logging enabled.
- `tools/build/build tgui-dev --no-hot` - Disable hot module replacement (helps when doing development on IE8).
- `tools/build/build tgui-dev --debug` - Run server with debug logging
enabled.
- `tools/build/build tgui-dev --no-hot` - Disable hot module replacement
(helps when doing development on IE8).
- `tools/build/build tgui-lint` - Show (and auto-fix) problems with the code.
- `tools/build/build tgui-sonar` - Analyze code with SonarQube.
- `tools/build/build tgui-test` - Run unit and integration tests.
@@ -84,31 +100,45 @@ Run `yarn install` once to install tgui dependencies.
- `yarn tgui:dev` - Launch a development server.
- `yarn tgui:dev --reload` - Reload byond cache once.
- `yarn tgui:dev --debug` - Run server with debug logging enabled.
- `yarn tgui:dev --no-hot` - Disable hot module replacement (helps when doing development on IE8).
- `yarn tgui:dev --no-hot` - Disable hot module replacement (helps when doing
development on IE8).
- `yarn tgui:lint` - Show (and auto-fix) problems with the code.
- `yarn tgui:sonar` - Analyze code with SonarQube.
- `yarn tgui:tsc` - Check code with TypeScript compiler.
- `yarn tgui:test` - Run unit and integration tests.
- `yarn tgui:analyze` - Run a bundle analyzer.
- `yarn tgui:bench` - Run benchmarks.
- `yarn tgfont:build` - Build icon fonts.
- `yarn tgui-polyfill:build` - Build polyfills. You need to run it when updating any of the static (numbered) polyfills.
- `yarn tgui-polyfill:build` - Build polyfills. You need to run it when updating
any of the static (numbered) polyfills.
## Important Memo
Remember to always run a full build of tgui before submitting a PR, because it comes with the full suite of CI checks, and runs much faster on your computer than on GitHub servers. It will save you some time and possibly a few broken commits! Address the issues that are reported by the tooling as much as possible, because maintainers will beat you with a ruler and force you to address them anyway (unless it's a false positive or something unfixable).
Remember to always run a full build of tgui before submitting a PR, because it
comes with the full suite of CI checks, and runs much faster on your computer
than on GitHub servers. It will save you some time and possibly a few broken
commits! Address the issues that are reported by the tooling as much as
possible, because maintainers will beat you with a ruler and force you to
address them anyway (unless it's a false positive or something unfixable).
## Troubleshooting
**Development server is crashing**
Make sure path to your working directory does not contain spaces, special unicode characters, exclamation marks or any other special symbols. If so, move codebase to a location which does not contain these characters.
Make sure path to your working directory does not contain spaces, special
unicode characters, exclamation marks or any other special symbols. If so, move
codebase to a location which does not contain these characters.
This is a known issue with Yarn (and some other tools, like Webpack), and fix is going to happen eventually.
This is a known issue with Yarn (and some other tools, like Webpack), and fix is
going to happen eventually.
**Development server doesn't find my BYOND cache!**
This happens if your Documents folder in Windows has a custom location, for example in `E:\Libraries\Documents`. Development server tries its best to find this non-standard location (searches for a Windows Registry key), but it can fail. You have to run the dev server with an additional environmental variable, with a full path to BYOND cache.
This happens if your Documents folder in Windows has a custom location, for
example in `E:\Libraries\Documents`. Development server tries its best to find
this non-standard location (searches for a Windows Registry key), but it can
fail. You have to run the dev server with an additional environmental variable,
with a full path to BYOND cache.
```
BYOND_CACHE="E:/Libraries/Documents/BYOND/cache"
@@ -118,7 +148,9 @@ BYOND_CACHE="E:/Libraries/Documents/BYOND/cache"
> Example: `No template for dependency: PureExpressionDependency`
Webpack stores its cache on disk since tgui 4.3, and it is very sensitive to build configuration. So if you update webpack, or share the same cache directory between development and production build, it will start hallucinating.
Webpack stores its cache on disk since tgui 4.3, and it is very sensitive to
build configuration. So if you update webpack, or share the same cache directory
between development and production build, it will start hallucinating.
To fix this kind of problem, run `bin/tgui --clean` and try again.
@@ -127,36 +159,39 @@ To fix this kind of problem, run `bin/tgui --clean` and try again.
When developing with `tgui-dev-server`, you will have access to certain
development only features.
**Debug Logs.**
When running server via `bin/tgui --dev --debug`, server will print debug
logs and time spent on rendering. Use this information to optimize your
code, and try to keep re-renders below 16ms.
**Debug Logs.** When running server via `bin/tgui --dev --debug`, server will
print debug logs and time spent on rendering. Use this information to optimize
your code, and try to keep re-renders below 16ms.
**Kitchen Sink.**
Press `F12` or click the green bug to open the KitchenSink interface. This interface is a
playground to test various tgui components.
**Kitchen Sink.** Press `F12` or click the green bug to open the KitchenSink
interface. This interface is a playground to test various tgui components.
**Layout Debugger.**
Press `F11` to toggle the *layout debugger*. It will show outlines of
all tgui elements, which makes it easy to understand how everything comes
together, and can reveal certain layout bugs which are not normally visible.
**Layout Debugger.** Press `F11` to toggle the _layout debugger_. It will show
outlines of all tgui elements, which makes it easy to understand how everything
comes together, and can reveal certain layout bugs which are not normally
visible.
## Browser Developer Tools
To debug TGUI interfaces with browser-style developer tools, there exists a utility
that Microsoft bundles with Windows to debug any Internet Explorer/Trident-using interface,
which BYOND uses.
To debug TGUI interfaces with browser-style developer tools, there exists a
utility that Microsoft bundles with Windows called IEChooser/F12 to debug any
Internet Explorer/Trident-using interface, which BYOND uses.
This provides invaluable tools such as a local console, a DOM viewer, an interactive debugger, and more.
This provides invaluable tools such as a local console, a DOM viewer, an
interactive debugger, and more.
The 64-bit version that we use is located at `%windir%\SysWOW64\F12\IEChooser.exe`.
There's also a 32-bit one in `system32\`.
You can access the `IEChooser.exe` by pressing <kbd>Win + R</kbd>, then typing
`f12`, then pressing enter. To manually go there: 64-bit version that we use is
located at `%windir%\SysWOW64\F12\IEChooser.exe`. There's also a 32-bit one in
`system32\`.
Simply launch the application after you've opened a TGUI window, and choose the .html name.
This is likely to be something like `tgui-window-1`. There's a refresh button in the top right.
Simply launch the application after you've opened a TGUI window, and choose the
.html name. This is likely to be something like `tgui-window-1`. There's a
refresh button in the top right.
Unfortunately, it seems this program doesn't have a new target chooser if your window is fully closed
so you'll need to restart it if it disconnects from the window.
Unfortunately, it seems this program doesn't have a new target chooser if your
window is fully closed so you'll need to restart it if it disconnects from the
window.
## Project Structure
@@ -165,20 +200,33 @@ so you'll need to restart it if it disconnects from the window.
- `/packages/tgui/index.js` - Application entry point.
- `/packages/tgui/components` - Basic UI building blocks.
- `/packages/tgui/interfaces` - Actual in-game interfaces.
- `/packages/tgui/layouts` - Root level UI components, that affect the final look and feel of the browser window. These hold various window elements, like the titlebar and resize handlers, and control the UI theme.
- `/packages/tgui/routes.js` - This is where tgui decides which interface to pull and render.
- `/packages/tgui/layouts` - Root level UI components, that affect the final
look and feel of the browser window. These hold various window elements, like
the titlebar and resize handlers, and control the UI theme.
- `/packages/tgui/routes.js` - This is where tgui decides which interface to
pull and render.
- `/packages/tgui/styles/main.scss` - CSS entry point.
- `/packages/tgui/styles/functions.scss` - Useful SASS functions. Stuff like `lighten`, `darken`, `luminance` are defined here.
- `/packages/tgui/styles/atomic` - Atomic CSS classes. These are very simple, tiny, reusable CSS classes which you can use and combine to change appearance of your elements. Keep them small.
- `/packages/tgui/styles/components` - CSS classes which are used in UI components. These stylesheets closely follow the [BEM](https://en.bem.info/methodology/) methodology.
- `/packages/tgui/styles/interfaces` - Custom stylesheets for your interfaces. Add stylesheets here if you really need a fine control over your UI styles.
- `/packages/tgui/styles/functions.scss` - Useful SASS functions. Stuff like
`lighten`, `darken`, `luminance` are defined here.
- `/packages/tgui/styles/atomic` - Atomic CSS classes. These are very simple,
tiny, reusable CSS classes which you can use and combine to change appearance
of your elements. Keep them small.
- `/packages/tgui/styles/components` - CSS classes which are used in UI
components. These stylesheets closely follow the
[BEM](https://en.bem.info/methodology/) methodology.
- `/packages/tgui/styles/interfaces` - Custom stylesheets for your interfaces.
Add stylesheets here if you really need a fine control over your UI styles.
- `/packages/tgui/styles/layouts` - Layout-related styles.
- `/packages/tgui/styles/themes` - Contains themes that you can use in tgui. Each theme must be registered in `/packages/tgui/index.js` file.
- `/packages/tgui/styles/themes` - Contains themes that you can use in tgui.
Each theme must be registered in `/packages/tgui/index.js` file.
## License
Source code is covered by /tg/station's parent license - **AGPL-3.0** (see the main [README](../README.md)), unless otherwise indicated.
Source code is covered by /tg/station's parent license - **AGPL-3.0** (see the
main [README](../README.md)), unless otherwise indicated.
Some files are annotated with a copyright header, which explicitly states the copyright holder and license of the file. Most of the core tgui source code is available under the **MIT** license.
Some files are annotated with a copyright header, which explicitly states the
copyright holder and license of the file. Most of the core tgui source code is
available under the **MIT** license.
The Authors retain all copyright to their respective work here submitted.
2 changes: 1 addition & 1 deletion tgui/package.json
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
"private": true,
"name": "tgui-workspace",
"version": "4.3.1",
"packageManager": "yarn@4.1.1",
"packageManager": "yarn@4.5.1",
"workspaces": [
"packages/*"
],
13 changes: 1 addition & 12 deletions tools/bootstrap/node_.ps1
Original file line number Diff line number Diff line change
@@ -31,18 +31,7 @@ if ($Env:TG_BOOTSTRAP_CACHE) {
$Cache = $Env:TG_BOOTSTRAP_CACHE
}

# Get OS version
[int]$OSMajor = (Get-WmiObject -Class Win32_OperatingSystem).Version.Split(".")[0]

# Set Node version based on OS version
if ($OSMajor -lt 10) {
# Anything under Windows 10
$NodeVersion = Extract-Variable -Path "$BaseDir\..\..\dependencies.sh" -Key "NODE_VERSION_COMPAT"
}
else {
$NodeVersion = Extract-Variable -Path "$BaseDir\..\..\dependencies.sh" -Key "NODE_VERSION_LTS"
}

$NodeVersion = Extract-Variable -Path "$BaseDir\..\..\dependencies.sh" -Key "NODE_VERSION_LTS"
$NodeSource = "https://nodejs.org/download/release/v$NodeVersion/win-x64/node.exe"
$NodeTargetDir = "$Cache\node-v$NodeVersion-x64"
$NodeTarget = "$NodeTargetDir\node.exe"
4 changes: 2 additions & 2 deletions tools/ci/install_node.sh
Original file line number Diff line number Diff line change
@@ -5,6 +5,6 @@ source dependencies.sh

if [[ -e ~/.nvm/nvm.sh ]]; then
source ~/.nvm/nvm.sh
nvm install $NODE_VERSION_COMPAT
nvm use $NODE_VERSION_COMPAT
nvm install $NODE_VERSION_LTS
nvm use $NODE_VERSION_LTS
fi

0 comments on commit 9796cd6

Please # to comment.