JsMacros Intellisense

A Visual Studio Code extension that adds type hints for JsMacros JavaScript macros. This extension is not affiliated with JsMacros.

Installation

Install the extension from the VSCode marketplace or use the .vsix installer

Features

• Type hints: copies the declaration files to your current working directory, generates or extends a tsconfig to create a TypeScript project.
• Version manage: multiple versions of declarations can be downloaded, select one to be in current use.

Usage

1. Open a workspace
2. Run either JsMacros Intellisense: fetch newest declarations or JsMacros Intellisense: fetch a specific declaration version, the downloaded version will automatically be selected as the current one. If you already have a version downloaded use JsMacros Intellisense: change the declaration version for your current workspace and select one.

Common Issues

• JsMacros (specifically GraalJS) cannot handle TypeScript, either compile or use the following workarounds in JavaScript.
• Variables might clash, use a // @ts-ignore. Making the file a module does not work since JsMacros cannot parse ES Modules, the isolatedModules option in the tsconfig would otherwise prevent this. (Maybe there is a never GraalJS version that JsMacros could use or it is intentionally disabled)

// @ts-ignore
const commandBuilder = Chat.getCommandManager().createCommandBuilder("rejoin"); //  might clash
commandBuilder.executes(JavaWrapper.methodToJava(rejoin))
commandBuilder.register()

// @ts-ignore
function rejoin() { // might clash
    GlobalVars.putString("server", World.getCurrentServerAddress().split("/")[1])
    Client.disconnect()
    Time.sleep(1)
    Client.connect(GlobalVars.getString("server"))
}

• If there are any type discrepencies either use // @ts-ignore or JSDoc (@type, @param). You need to absolutely certain when overriding the type!

/**
 * @type {AnvilInventory}
 */
// @ts-ignore
const inventory = Player.openInventory();

• Most of the time JsMacros.assertEvent(event, eventType) overrides the type and raises a runtime exception if the types dont match. Sometimes TS may get confused because multiple asserts might be in the global scope.

event.message // Events.BaseEvent doesn't have the members of Events.RecvMessage
JsMacros.assertEvent(event, "RecvMessage");
event.message // TS now treats it as Events.RecvMessage

Commands

All declarations live in the global extension storage, the list of available versions is driven by its contents. The currently selected version is stored as an entry in the workspace state (vscode.ExtensionContext.workspaceState) and should always be changed through commands.

• fetch newest declarations: fetches the newest version and saves them as latest. After downloading it will not be checked for updates
• fetch a specific declaration version: shows a version selection, fetches one and saves it as the name of the release, for example Release 1.9.2. If the specific version is the newest it will not be saved as latest.
• change the declaration version for your current workspace
• list all currently installed versions
• remove declarations for a specific version

Config

• repoUrl: URL to the JsMacros GitHub repo.
• assetRegExp: Regular Expression used to filter for the TS declarations in release assets.
• askWhenMultipleWorkspaces: When actions can only target one workspace ask which one to use.