uni-run 1.1.24 → 1.1.25

package/README.md

@@ -9,7 +9,7 @@
 - **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.
+- **Reload Key**: Enable reloading the script with Ctrl+R or F5.
 - **Information Display**: Show detailed information about the script execution.
 
 ## Installation
@@ -29,8 +29,12 @@ To run a script, use the following command:
 ```sh
 run script.ext [options] -- [args for internal bin]
 uni-run script.ext [options] -- [args for internal bin]
+rux script.ext [options] -- [args for internal bin]
+uni-rux script.ext [options] -- [args for internal bin]
 ```
 
+Note: `rux` and `uni-rux` run scripts once and exit (no watch mode by default).
+
 ### Examples
 
 #### Running a JavaScript File
@@ -65,6 +69,25 @@ run ./scripts/main.js -- --some someValue
 
 Here `--some someValue` will be passed to `node` and will be ignored by `uni-run`.
 
+#### Executing with a custom binary
+
+```sh
+run exec python ./scripts/custom.py
+run exec custom-binary arg1 arg2
+```
+
+#### Listing supported scripts
+
+```sh
+run list
+```
+
+#### Cleaning cache
+
+```sh
+run clean
+```
+
 ## Define Custom Configuration
 
 Create `.uni-run.json` file in your user home directory or current working directory.
@@ -123,7 +146,7 @@ uniRun.addExecutorBefore({
 
 #### `start(args?: string[])`:
 
-Starts the application with the provided arguments.
+Starts the application with the provided arguments. If no arguments are provided, it inherits from CLI.
 
 ```typescript
 import uniRun from 'uni-run'
@@ -131,6 +154,22 @@ import uniRun from 'uni-run'
 uniRun.start(['arg1', 'arg2'])
 ```
 
+### Exports
+
+The package also exports the following utilities:
+
+- `currentModule` - Get the current module information
+- `getConfig(cwd?: string)` - Get configuration from `.uni-run.json`
+- `getUserExecutors(cwd?: string)` - Get user-defined executors from `.uni-run.cjs`
+- `ScriptExecutorOptions` and other types from `./scriptExecutors/types.t`
+
+```typescript
+import { getConfig, getUserExecutors } from 'uni-run'
+
+const config = getConfig('/path/to/project')
+const executors = getUserExecutors('/path/to/project')
+```
+
 ### Example Usage
 
 ```typescript

package/dist/app.js

@@ -46,9 +46,10 @@ const getUserExecutors_1 = __importDefault(require("./helpers/getUserExecutors")
 const helpers_1 = require("./scriptExecutors/helpers");
 const local_env_1 = require("./local-env");
 arg.app.on((_a, flags_1) => __awaiter(void 0, [_a, flags_1], void 0, function* ([script, listArs, trailingArgs], flags) {
-    var _b;
+    var _b, _c;
     if ((0, local_env_1.getRuntime)() === 'rux') {
         flags.exit = true;
+        flags.keep = (_b = flags.keep) !== null && _b !== void 0 ? _b : true;
     }
     const executionConfig = (0, getConfig_1.default)(flags.cwd);
     const userExecutors = (0, getUserExecutors_1.default)(flags.cwd);
@@ -67,12 +68,14 @@ arg.app.on((_a, flags_1) => __awaiter(void 0, [_a, flags_1], void 0, function* (
         return;
     const exec = new execution_1.default(Object.assign(Object.assign({}, executionOptions), { watchExtensions: executionOptions.watchExtensions.length
             ? executionOptions.watchExtensions
-            : [...scriptExecutor.exts, ...((_b = runtime.watchExts) !== null && _b !== void 0 ? _b : [])] }), runtime.exec, runtime.compile);
+            : [...scriptExecutor.exts, ...((_c = runtime.watchExts) !== null && _c !== void 0 ? _c : [])] }), runtime.exec, runtime.compile);
     exec.start();
 }));
 arg.exec.on(([listArs, trailingArgs], flags) => {
+    var _a;
     if ((0, local_env_1.getRuntime)() === 'rux') {
         flags.exit = true;
+        flags.keep = (_a = flags.keep) !== null && _a !== void 0 ? _a : true;
     }
     new execution_1.default((0, argHelper_1.mapFlagsToOptions)(flags), [...listArs, ...trailingArgs]).start();
 });

package/dist/arg.d.ts

@@ -43,7 +43,7 @@ export declare const app: NoArg<"uni-run", {
         }>;
         readonly keep: import("noarg/dist/schema/TypeBoolean.cjs").TypeBoolean<{
             aliases: ["k"];
-            description: "Do not clear the console while starting the script";
+            description: "Do not clear the console while starting the script. Default with `rux` or `uni-rux`";
         }>;
         readonly ext: import("noarg/dist/schema/TypeArray.cjs").TypeArray<{
             aliases: ["e"];
@@ -140,7 +140,7 @@ export declare const exec: import("noarg/dist/NoArg/NoArgProgram.cjs").NoArgProg
         }>;
         readonly keep: import("noarg/dist/schema/TypeBoolean.cjs").TypeBoolean<{
             aliases: ["k"];
-            description: "Do not clear the console while starting the script";
+            description: "Do not clear the console while starting the script. Default with `rux` or `uni-rux`";
         }>;
         readonly ext: import("noarg/dist/schema/TypeArray.cjs").TypeArray<{
             aliases: ["e"];

package/dist/argHelper.d.ts

@@ -23,7 +23,7 @@ export declare const executionConfig: {
         }>;
         readonly keep: import("noarg/dist/schema/TypeBoolean.cjs").TypeBoolean<{
             aliases: ["k"];
-            description: "Do not clear the console while starting the script";
+            description: "Do not clear the console while starting the script. Default with `rux` or `uni-rux`";
         }>;
         readonly ext: import("noarg/dist/schema/TypeArray.cjs").TypeArray<{
             aliases: ["e"];

package/dist/argHelper.js

@@ -23,7 +23,7 @@ exports.executionConfig = noarg_1.default.defineConfig({
             .description('Do not show any output of the script'),
         keep: noarg_1.default.boolean()
             .aliases('k')
-            .description('Do not clear the console while starting the script'),
+            .description('Do not clear the console while starting the script. Default with `rux` or `uni-rux`'),
         ext: noarg_1.default.array(noarg_1.default.string())
             .aliases('e')
             .description('Looks for changes only of the given extensions'),

package/package.json

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