uni-run

uni-run is a versatile CLI tool designed to run various types of scripts, including but not limited to JavaScript, TypeScript, Python, Java, HTML, SASS, Lua, and more. It provides a unified interface to execute scripts with additional features like watching for file changes, benchmarking execution time, and more.

Features

• Watch Mode: Automatically re-run scripts when files change.
• Benchmarking: Measure and display the execution time of scripts.
• Environment Variables: Set environment variables for script execution.
• Shell Execution: Run scripts in a shell for more control.
• Console Clearing: Clear the console before running the script.
• Reload Key: Enable reloading the script with a specific key combination.
• Information Display: Show detailed information about the script execution.

Installation

To install uni-run, use npm:

npm install -g uni-run

CLI Usage

Basic Command

To run a script, use the following command:

run script.ext [options] -- [args for internal bin]
uni-run script.ext [options] -- [args for internal bin]

Examples

Running a JavaScript File

run ./scripts/main.js

Running a TypeScript File

run ./scripts/main.ts

Running a Python File

run ./scripts/main.py

Running a Java File

run ./scripts/Main.java

Running with script argv

run ./scripts/main.js -- --some someValue

Here --some someValue will be passed to node and will be ignored by uni-run.

Define Custom Configuration

Create .uni-run.json file in your user home directory or current working directory.

{
  "javascript-runtime": "bun",
  "typescript-runtime": "deno"
}

Now you can run your script with run script.js or run script.ts with your own runtime.

Setup Custom Executors

Create .uni-run.cjs file in your user home directory or current working directory. NOTE: Your custom executors will have more priority than the default executors.

module.exports = [
  {
    name: 'Name',
    exts: ['ext'],
    getRuntime(args, options, config) {
      return {
        exec: ['YOUR_BIN', ...args],
      }
    },
  },
]

Now you can run your script with run script.ext.

API

The uni-run package provides a simple API to manage and execute scripts.

addExecutorBefore(options: ExecutorOptions) or addExecutorAfter(options: ExecutorOptions):

Both methods add an executor to the list of executors. The addExecutorBefore method adds the executor before the default executors, while the addExecutorAfter method adds the executor after the default executors. This means that the executor will be used before or after checking the default executors.

import uniRun from 'uni-run'

uniRun.addExecutorBefore({
  name: 'Name',
  exts: ['ext'],
  getRuntime(args, options, config) {
    return {
      exec: ['YOUR_BIN', ...args],
    }
  },
})

start(args?: string[]):

Starts the application with the provided arguments.

import uniRun from 'uni-run'

uniRun.start(['arg1', 'arg2'])

Example Usage

import uniRun from 'uni-run'

// Add the Executor to uni-run
uniRun.addExecutorBefore({
  name: 'Name',
  exts: ['ext'],
  getRuntime(args, options, config) {
    return {
      exec: ['YOUR_BIN', ...args],
    }
  },
})

// Start the application with arguments
uniRun.start(['arg1.some'])

// Or inherit from CLI
uniRun.start()