Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History

scripts

README.md

MQTTX Utility Scripts

This directory contains utility scripts that help with development, build processes, and fixing compatibility issues in dependencies.

Available Scripts

1. gen-version.js

A version generator script that updates version information before builds.

Function: Creates a version file with the current application version from package.json. This ensures that the application displays the correct version information at runtime.

When to run:

  • Before building the application
  • After changing the version in package.json
  • This script is automatically run during the build process

2. patch-mcp-sdk.js

Fixes Node.js module import compatibility issues in the MCP SDK for Electron environments.

Problem: Modern Node.js modules use the 'node:' prefix for built-in modules (e.g., 'node:fs'), but Electron and older Node.js versions don't fully support this syntax, leading to errors like "Cannot find module 'node:fs'".

Solution: This script removes all 'node:' prefixes from import statements and require() calls in the MCP SDK files. It also patches the pkce-challenge module which has modern syntax issues.

What it modifies:

  • Removes 'node:' prefixes from import statements in MCP SDK files
  • Converts require('node:module') to require('module')
  • Replaces the pkce-challenge module implementation with a compatible version

3. patch-monaco-clipboard.js

Fixes clipboard functionality in Monaco Editor when running in Electron.

Problem: Monaco Editor doesn't properly detect Electron's renderer process as a web environment, causing clipboard functionality (especially paste) to fail. This issue became more prominent with Electron 34+ where execCommand('paste') support was dropped.

Solution: This patch removes the platform.isWeb check in the clipboard.js file, allowing clipboard operations to work in Electron regardless of platform detection.

Related Issue: monaco-editor#4855

What it modifies:

  • Changes the condition if (!result && platform.isWeb) to if (!result) in Monaco's clipboard implementation
  • Adds comments explaining the patch for future reference

How to Use

Most scripts run automatically at appropriate times through npm/yarn scripts in package.json.

The patch scripts run automatically after yarn install through the postinstall script in package.json.

If you need to run them manually:

# Generate version info
node scripts/gen-version.js

# Run Monaco Editor clipboard patch
node scripts/patch-monaco-clipboard.js

# Run MCP SDK patch
node scripts/patch-mcp-sdk.js

When to Run Patches

  • After installing or updating dependencies
  • If you encounter clipboard issues in Monaco Editor within Electron
  • If you encounter import errors with the MCP SDK
  • If you see version information missing in the application