https://github.com/MTadder/YueRunner
🌙 provides Yuescript compilation support to VSCode.
https://github.com/MTadder/YueRunner
vscode-extension yuescript
Last synced: 2 months ago
JSON representation
🌙 provides Yuescript compilation support to VSCode.
- Host: GitHub
- URL: https://github.com/MTadder/YueRunner
- Owner: MTadder
- License: mit
- Created: 2024-08-11T02:25:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-26T07:07:42.000Z (8 months ago)
- Last Synced: 2026-03-09T10:31:44.133Z (3 months ago)
- Topics: vscode-extension, yuescript
- Language: TypeScript
- Homepage:
- Size: 223 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-yue - YueRunner - provides YueScript compilation support (Editor Tools / VSCode)
README
# YueRunner
## Features
Provides palette commands and a convenient status bar button for compiling and running Yuescript files.
**New in v0.4.0:**
- Fixed status bar button visibility issue - button now appears immediately when opening Yuescript files
- Auto-save before compile/run (configurable)
- Success notifications on compilation (optional)
- Clear terminal before running commands (optional)
- Improved configuration descriptions with helpful context
### Commands
> Open your command palette with `CTRL` + `SHIFT` + `P`
- `Run this Yuescript`
- `Compile this Yuescript`
- `Compile all Yuescripts (in this directory)`
- `Compile all Yuescripts & Run LOVE2D (in this directory)`
## Requirements
- Install [`yuescript`](https://yuescript.org)
- Ensure that `yue` is visible within your `PATH`.
- If you want [`LÖVE2D`](https://love2d.org) support, [install it](https://github.com/love2d/love/releases/latest), and add it to your `PATH`.
## Extension Settings
This extension contributes the following settings:
### Compilation Options
- `yuescriptrunner.targetLuaVersion` - Select the Lua version to target for compilation (5.1, 5.2, 5.3, or 5.4)
- `yuescriptrunner.useMinification` - Enable code minification to reduce output size
- `yuescriptrunner.useSpacesInstead` - Use spaces instead of tabs for indentation
- `yuescriptrunner.reserveComments` - Preserve comments from source in compiled output
- `yuescriptrunner.writeLineNumbers` - Include line number information for debugging
- `yuescriptrunner.useImplicitReturn` - Automatically add return statement for last expression
- `yuescriptrunner.matchLineNumbers` - Maintain same line numbers as source file
### Debug and Output Options
- `yuescriptrunner.dumpGlobals` - Output list of global variables with their locations
- `yuescriptrunner.dumpToStdout` - Print compiled code to terminal instead of file
- `yuescriptrunner.dumpCompileTime` - Display compilation time in terminal
### UI and Behavior Options
- `yuescriptrunner.defaultAction` - Choose the default action for the status bar button
- `yuescriptrunner.iconOnly` - Show only icon on status bar button (saves space)
- `yuescriptrunner.reFocusDocument` - Return focus to editor after running commands
- `yuescriptrunner.autoSaveBeforeRun` - Automatically save file before compiling/running
- `yuescriptrunner.showNotifications` - Show success notifications on compilation
- `yuescriptrunner.clearTerminalBeforeRun` - Clear terminal before running commands
### LÖVE2D Options
- `yuescriptrunner.loveExecutable` - Choose LÖVE executable (love or lovec)
## Known Issues
> Help out by reporting any issues to the [Github](https://github.com/MTadder/YueRunner)
- If _you try to use `LÖVE2D` without it being installed_, an error will occur.
---
**Enjoy!**