Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliot-akira/zxel
Interactive terminal shell for JavaScript runtimes with syntax highlight and zx utilities
https://github.com/eliot-akira/zxel
Last synced: 19 days ago
JSON representation
Interactive terminal shell for JavaScript runtimes with syntax highlight and zx utilities
- Host: GitHub
- URL: https://github.com/eliot-akira/zxel
- Owner: eliot-akira
- License: mit
- Created: 2024-04-22T16:06:19.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-23T14:29:17.000Z (7 months ago)
- Last Synced: 2024-04-23T18:10:43.478Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 74.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# zxel
`zxel` is an interactive terminal shell for JavaScript runtimes with syntax highlight and `zx` utilities.
## Usage
Prerequisites: [Node](https://nodejs.org/en/) (version 18 or above)
```sh
npx zxel
```
Alternatively, with [Bun](https://bun.sh/).
```sh
bunx zxel
```
## Features
- Read-eval-print-loop of JavaScript expression
- Syntax highlight using [`emphasize`](https://github.com/wooorm/emphasize)
- [Keyboard shortcuts](#keyboard-shortcuts) similar to `readline`
- Top-level `await`
- Globals from [`zx`](https://google.github.io/zx/api)
- Runs with Bun if installed
## Environment
Assign variables on `this` to make it available for subsequent lines of code.
```js
this.a = 123
```
Using `let` or `const` doesn't work because every line is evaluated in its own function scope.
Global utilities like `fs` and `glob` are also defined on `this`.
```js
Object.keys(this).sort()
```
### Globals
Utilities from [`zx`](https://google.github.io/zx/api) are defined as global variables.
- `$` - Run shell command with return value
```js
const text = await $`cat readme.md`
const files = (await $`ls -1`).split('\n')
```
- `$see` - Run shell command with console output
```js
await $see`ls -1`
```
- `cd` - Change directory
- `fetch` - Fetch
- `fs` - File system utilities from [`fs-extra`](https://github.com/jprichardson/node-fs-extra)
- `glob` - Pattern match files using [`globby`](https://github.com/sindresorhus/globby)
```js
for (const file of await glob('*.txt')) {
console.log(file)
}
```
- `globDir` - Pattern match directories
- `os` - OS info from [`os`](https://nodejs.org/api/os.html)
- `path` - Path utilities from [`path`](https://nodejs.org/api/path.html)
Also [globals from Node](https://nodejs.org/api/globals.html), or [Bun](https://bun.sh/docs/api/globals) with [`Database`](https://bun.sh/docs/api/sqlite).
## Keyboard shortcuts
| Shortcut | Comment |
| ---------------------- | --------------------------------- |
| `Enter` | Run code |
| `Escape` | Cancel |
| `→` | Forward one character |
| `Ctrl`+`→` | Forward one word |
| `←` | Backward one character |
| `Ctrl`+`←` | Backward one word |
| `Home`, `Ctrl`+`A` | Beginning of line |
| `End`, `Ctrl`+`E` | End of line |
| `↓` | Next line in history |
| `↑` | Previous line in history |
| `Ctrl`+`C` | Exit shell |
| `Backspace` | Delete previous character |
| `Delete` | Delete next character |
| `Ctrl`+`L` | Clear screen |
## TODO
- Multiline mode
## References
- [ANSI Escape Sequences](https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797)