uni-run 1.1.1 → 1.1.3

package/README.md

@@ -83,15 +83,16 @@ Now you can run your script with `run script.js` or `run script.ts` with your ow
 ## 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.
 
 ```js
 module.exports = [
   {
-    name: 'Something',
+    name: 'Name',
     exts: ['ext'],
     getRuntime(args, options, config) {
       return {
-        run: ['YOUR_BIN', ...args],
+        start: ['YOUR_BIN', ...args],
       }
     },
   },
@@ -104,16 +105,20 @@ Now you can run your script with `run script.ext`.
 
 The `uni-run` package provides a simple API to manage and execute scripts.
 
-#### `addExecutor(options: ExecutorOptions)`:
+#### `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.
 
 ```typescript
 import uniRun from 'uni-run'
 
-uniRun.addExecutor({
+uniRun.addExecutorBefore({
   name: 'Name',
-  exts: ['something'],
+  exts: ['ext'],
   getRuntime(args, options, config) {
-    return ['something-binary', ...args]
+    return {
+      start: ['YOUR_BIN', ...args],
+    }
   },
 })
 ```
@@ -134,11 +139,13 @@ uniRun.start(['arg1', 'arg2'])
 import uniRun from 'uni-run'
 
 // Add the Executor to uni-run
-uniRun.addExecutor({
+uniRun.addExecutorBefore({
   name: 'Name',
-  exts: ['something'],
+  exts: ['ext'],
   getRuntime(args, options, config) {
-    return ['something-binary', ...args]
+    return {
+      start: ['YOUR_BIN', ...args],
+    }
   },
 })
 

package/dist/app.js

@@ -42,6 +42,7 @@ const argHelper_1 = require("./argHelper");
 const scriptExecutors_1 = __importDefault(require("./scriptExecutors"));
 const checkRuntime_1 = __importDefault(require("./scriptExecutors/checkRuntime"));
 const getUserExecutors_1 = __importDefault(require("./helpers/getUserExecutors"));
+const colors_1 = __importDefault(require("./lib/colors"));
 arg.app.on((_a, flags_1) => __awaiter(void 0, [_a, flags_1], void 0, function* ([script, listArs, trailingArgs], flags) {
     var _b;
     const userExecutors = (0, getUserExecutors_1.default)(flags.cwd);
@@ -52,13 +53,13 @@ arg.app.on((_a, flags_1) => __awaiter(void 0, [_a, flags_1], void 0, function* (
     ];
     const scriptExecutor = totalExecutors.find((executor) => executor.exts.includes(script.split('.').pop()));
     if (!scriptExecutor) {
-        console.log('Unsupported script:', script);
+        console.error('Unsupported script:', script);
         return console.log('You may try "run exec YOUR_BIN script.ext -- --flags"');
     }
     const executionOptions = (0, argHelper_1.mapFlagsToOptions)(flags);
     const runtime = scriptExecutor.getRuntime([script, ...listArs, ...trailingArgs], executionOptions, executionConfig);
     (0, checkRuntime_1.default)(runtime);
-    execution_1.default.start(runtime.run, Object.assign(Object.assign({}, executionOptions), { watchExtensions: executionOptions.watchExtensions.length
+    execution_1.default.start(runtime.start, Object.assign(Object.assign({}, executionOptions), { watchExtensions: executionOptions.watchExtensions.length
             ? executionOptions.watchExtensions
             : [...scriptExecutor.exts, ...((_b = runtime.watchExts) !== null && _b !== void 0 ? _b : [])] }));
 }));
@@ -71,14 +72,8 @@ arg.list.on(() => {
         ...(Array.isArray(userExecutors) ? userExecutors : []),
         ...scriptExecutors_1.default,
     ];
-    console.log('Supported scripts:');
-    totalExecutors
-        .sort((a, b) => {
-        if (a.name < b.name)
-            return -1;
-        if (a.name > b.name)
-            return 1;
-        return 0;
-    })
-        .forEach(({ name }) => console.log(`- ${name}`));
+    console.log(colors_1.default.bold('Supported scripts:'));
+    totalExecutors.forEach(({ name, exts }) => {
+        console.log(`- ${colors_1.default.magenta(name)}`, `[${exts.map((e) => '.' + colors_1.default.green(e)).join(', ')}]`);
+    });
 });

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import './app';
 import { ScriptExecutorOptions } from './scriptExecutors/types.t';
 declare const _default: {
-    addExecutor(executor: ScriptExecutorOptions): void;
+    addExecutorBefore(executor: ScriptExecutorOptions): void;
+    addExecutorAfter(executor: ScriptExecutorOptions): void;
     start(args?: string[]): void;
 };
 export default _default;

package/dist/index.js

@@ -7,9 +7,12 @@ require("./app");
 const arg_1 = require("./arg");
 const scriptExecutors_1 = __importDefault(require("./scriptExecutors"));
 exports.default = {
-    addExecutor(executor) {
+    addExecutorBefore(executor) {
         scriptExecutors_1.default.unshift(executor);
     },
+    addExecutorAfter(executor) {
+        scriptExecutors_1.default.push(executor);
+    },
     start(args) {
         arg_1.app.start(args);
     },

package/dist/scriptExecutors/checkRuntime.d.ts

@@ -1,2 +1,2 @@
 import { RuntimeOptions } from './types.t';
-export default function (runtime: RuntimeOptions): false | undefined;
+export default function (runtime: RuntimeOptions): void;

package/dist/scriptExecutors/checkRuntime.js

@@ -4,39 +4,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = default_1;
+const colors_1 = __importDefault(require("../lib/colors"));
 const confirm_1 = __importDefault(require("@inquirer/confirm"));
 const cross_spawn_1 = require("cross-spawn");
 function default_1(runtime) {
-    if (!isInstalled(runtime.isInstalled)) {
-        renderHowToInstall(runtime.run[0], runtime.installHints);
-        return canBeInstalled(runtime.install);
-    }
-}
-function isInstalled(commands) {
-    if (!(commands === null || commands === void 0 ? void 0 : commands.length))
-        return true;
-    const [command, ...args] = commands;
-    const result = (0, cross_spawn_1.sync)(command, args, {
-        stdio: 'ignore',
-    });
-    if (result.status === 1)
-        return false;
-    return true;
-}
-function renderHowToInstall(name, hints) {
-    if (!(hints === null || hints === void 0 ? void 0 : hints.length))
+    var _a, _b, _c, _d;
+    if (!((_b = (_a = runtime.install) === null || _a === void 0 ? void 0 : _a.check) === null || _b === void 0 ? void 0 : _b.length))
         return;
-    console.error(`${name} is not installed.`);
-    console.log('How to install:');
-    hints.forEach((hint) => console.log(hint));
-}
-function canBeInstalled(installCommands) {
-    if (!(installCommands === null || installCommands === void 0 ? void 0 : installCommands.length))
-        return false;
-    (0, confirm_1.default)({ message: 'Do you want to install it?' }).then((ans) => {
-        if (!ans)
-            return;
-        const [command, ...args] = installCommands;
-        (0, cross_spawn_1.sync)(command, args, { stdio: 'inherit' });
-    });
+    const [command, ...args] = runtime.install.check;
+    const result = (0, cross_spawn_1.sync)(command, args, { stdio: 'ignore' });
+    if (result.status === 0)
+        return;
+    if ((_c = runtime.install.hints) === null || _c === void 0 ? void 0 : _c.length) {
+        console.error(`${runtime.start[0]} is not installed.`);
+        console.log(colors_1.default.bold('How to install:'));
+        runtime.install.hints.forEach((hint) => console.log(hint));
+    }
+    if ((_d = runtime.install.command) === null || _d === void 0 ? void 0 : _d.length) {
+        (0, confirm_1.default)({ message: 'Do you want to install it?' }).then((ans) => {
+            var _a;
+            if (!ans)
+                return;
+            const [command, ...args] = (_a = runtime.install) === null || _a === void 0 ? void 0 : _a.command;
+            (0, cross_spawn_1.sync)(command, args, { stdio: 'inherit' });
+        });
+    }
 }

package/dist/scriptExecutors/index.js

@@ -23,9 +23,11 @@ exports.default = (0, as_1.default)([
                     break;
             }
             return {
-                run: [runtime, ...args],
-                isInstalled: [runtime, '--version'],
-                installHints,
+                start: [runtime, ...args],
+                install: {
+                    check: [runtime, '--version'],
+                    hints: installHints,
+                },
             };
         },
     },
@@ -54,10 +56,12 @@ exports.default = (0, as_1.default)([
                     break;
             }
             return {
-                run: [runtime, ...args],
-                isInstalled: [runtime, '--version'],
-                installHints,
+                start: [runtime, ...args],
                 watchExts: ['js', 'javascript', 'jsx', 'cjs', 'cjsx', 'mjs', 'mjsx'],
+                install: {
+                    check: [runtime, '--version'],
+                    hints: installHints,
+                },
             };
         },
     },
@@ -66,9 +70,11 @@ exports.default = (0, as_1.default)([
         exts: ['py'],
         getRuntime(args, options, config) {
             return {
-                run: ['python', ...args],
-                isInstalled: ['python', '--version'],
-                installHints: ['Please install Python from https://www.python.org'],
+                start: ['python', ...args],
+                install: {
+                    check: ['python', '--version'],
+                    hints: ['Please install Python from https://www.python.org'],
+                },
             };
         },
     },
@@ -77,9 +83,11 @@ exports.default = (0, as_1.default)([
         exts: ['java'],
         getRuntime(args, options, config) {
             return {
-                run: ['java', ...args],
-                isInstalled: ['java', '--version'],
-                installHints: ['Please install Java from https://www.oracle.com/java'],
+                start: ['java', ...args],
+                install: {
+                    check: ['java', '--version'],
+                    hints: ['Please install Java from https://www.oracle.com/java'],
+                },
             };
         },
     },
@@ -88,11 +96,13 @@ exports.default = (0, as_1.default)([
         exts: ['ps1'],
         getRuntime(args, options, config) {
             return {
-                run: ['powershell', '-File', ...args],
-                isInstalled: ['powershell', '-command', 'echo ok'],
-                installHints: [
-                    'Please install Powershell from https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell',
-                ],
+                start: ['powershell', '-File', ...args],
+                install: {
+                    check: ['powershell', '-command', 'echo ok'],
+                    hints: [
+                        'Please install Powershell from https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell',
+                    ],
+                },
             };
         },
     },
@@ -101,9 +111,11 @@ exports.default = (0, as_1.default)([
         exts: ['cmd', 'bat'],
         getRuntime(args, options, config) {
             return {
-                run: ['cmd', '/c', ...args],
-                isInstalled: ['cmd', '/c', 'echo ok'],
-                installHints: ['Please install Command Prompt from Windows'],
+                start: ['cmd', '/c', ...args],
+                install: {
+                    check: ['cmd', '/c', 'echo ok'],
+                    hints: ['Please install Command Prompt from Windows'],
+                },
             };
         },
     },
@@ -112,11 +124,11 @@ exports.default = (0, as_1.default)([
         exts: ['sh'],
         getRuntime(args, options, config) {
             return {
-                run: ['bash', ...args],
-                isInstalled: ['bash', '--version'],
-                installHints: [
-                    'Please install Bash from https://www.gnu.org/software/bash',
-                ],
+                start: ['bash', ...args],
+                install: {
+                    check: ['bash', '--version'],
+                    hints: ['Please install Bash from https://www.gnu.org/software/bash'],
+                },
             };
         },
     },
@@ -125,9 +137,11 @@ exports.default = (0, as_1.default)([
         exts: ['fish'],
         getRuntime(args, options, config) {
             return {
-                run: ['fish', ...args],
-                isInstalled: ['fish', '--version'],
-                installHints: ['Please install Fish from https://fishshell.com'],
+                start: ['fish', ...args],
+                install: {
+                    check: ['fish', '--version'],
+                    hints: ['Please install Fish from https://fishshell.com'],
+                },
             };
         },
     },
@@ -136,9 +150,37 @@ exports.default = (0, as_1.default)([
         exts: ['lua'],
         getRuntime(args, options, config) {
             return {
-                run: ['lua', ...args],
-                isInstalled: ['lua', '-v'],
-                installHints: ['Please install Lua from https://www.lua.org'],
+                start: ['lua', ...args],
+                install: {
+                    check: ['lua', '-v'],
+                    hints: ['Please install Lua from https://www.lua.org'],
+                },
+            };
+        },
+    },
+    {
+        name: 'Ruby',
+        exts: ['rb'],
+        getRuntime(args, options, config) {
+            return {
+                start: ['ruby', ...args],
+                install: {
+                    check: ['ruby', '-v'],
+                    hints: ['Please install Ruby from https://www.ruby-lang.org'],
+                },
+            };
+        },
+    },
+    {
+        name: 'Go',
+        exts: ['go'],
+        getRuntime(args, options, config) {
+            return {
+                start: ['go', 'run', ...args],
+                install: {
+                    check: ['go', '-v'],
+                    hints: ['Please install Ruby from https://www.ruby-lang.org'],
+                },
             };
         },
     },
@@ -147,9 +189,11 @@ exports.default = (0, as_1.default)([
         exts: ['sass', 'scss'],
         getRuntime(args, options, config) {
             return {
-                run: ['sass', ...args],
-                isInstalled: ['sass', '--version'],
-                installHints: ['Please install SASS from https://sass-lang.com'],
+                start: ['sass', ...args],
+                install: {
+                    check: ['sass', '--version'],
+                    hints: ['Please install SASS from https://sass-lang.com'],
+                },
             };
         },
     },
@@ -158,12 +202,14 @@ exports.default = (0, as_1.default)([
         exts: ['html', 'htm'],
         getRuntime(args, options, config) {
             return {
-                run: ['http-server', ...args],
-                isInstalled: ['http-server', '--version'],
-                installHints: [
-                    'Please install http-server from https://www.npmjs.com/package/http-server',
-                ],
+                start: ['http-server', ...args],
                 watchExts: ['css', 'js', 'javascript', 'json'],
+                install: {
+                    check: ['http-server', '--version'],
+                    hints: [
+                        'Please install http-server from https://www.npmjs.com/package/http-server',
+                    ],
+                },
             };
         },
     },

package/dist/scriptExecutors/types.t.d.ts

@@ -4,11 +4,13 @@ export type ExecutorConfig = Partial<{
     'typescript-runtime': string;
 }>;
 export type RuntimeOptions = {
-    run: string[];
-    install?: string[];
-    installHints?: string[];
-    isInstalled?: string[];
+    start: string[];
     watchExts?: string[];
+    install?: {
+        check?: string[];
+        hints?: string[];
+        command?: string[];
+    };
 };
 export type ScriptExecutorOptions = {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uni-run",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Universal Runner for many language",
   "type": "commonjs",
   "scripts": {

package/dist/helpers/get-config.d.ts

@@ -1 +0,0 @@
-export default function (...extraDirs: string[]): any;

package/dist/helpers/get-config.js

@@ -1,30 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_path_1 = __importDefault(require("node:path"));
-function getExistedFile(...files) {
-    for (const file of files) {
-        if (node_fs_1.default.existsSync(file))
-            return file;
-    }
-}
-function default_1(...extraDirs) {
-    var _a;
-    const userPath = (_a = process.env.HOME) !== null && _a !== void 0 ? _a : process.env.USERPROFILE;
-    if (!userPath)
-        return;
-    const configFile = getExistedFile(...extraDirs.map((dir) => node_path_1.default.join(dir, '/.uni-run.json')), node_path_1.default.join(process.cwd(), '/.uni-run.json'), node_path_1.default.join(userPath, '/.uni-run.json'));
-    if (!configFile)
-        return;
-    try {
-        const config = node_fs_1.default.readFileSync(configFile, 'utf-8');
-        return JSON.parse(config);
-    }
-    catch (_b) {
-        return {};
-    }
-}