Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/croquiscom/rinore
Rich Node.js REPL
https://github.com/croquiscom/rinore
Last synced: about 2 months ago
JSON representation
Rich Node.js REPL
- Host: GitHub
- URL: https://github.com/croquiscom/rinore
- Owner: croquiscom
- License: mit
- Created: 2017-08-09T13:18:04.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T03:36:29.000Z (about 1 year ago)
- Last Synced: 2024-04-23T06:00:39.599Z (9 months ago)
- Language: TypeScript
- Size: 1.02 MB
- Stars: 15
- Watchers: 17
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/rinore)
[](https://coveralls.io/github/croquiscom/rinore?branch=main)
# Rinore
> **Ri**ch **No**de.js **RE**PL
Rinore was extracted from [CORMO](https://github.com/croquiscom/cormo).
CORMO console provided an interactive shell like
[Rails console](http://guides.rubyonrails.org/command_line.html#rails-console)
or [django shell](https://docs.djangoproject.com/en/1.11/ref/django-admin/#shell).
# Features
Rinore has following features additional to the original Node.js REPL.
- can select JavaScript or CoffeeScript or TypeScript
- expose modules to the REPL
- support Promise
- show function arguments for Tab completion
- reload local module if its content is changed
# Usages
## Run
```
$ rinore
rinore> path.extname('index.html')
'.html'
```
For CoffeeScript:
```
$ rinore -l coffeescript
rinore> path.extname 'index.html'
'.html'
```
For TypeScript:
```
$ rinore -l typescript
rinore> path.extname('index.html')
'.html'
```
## Load modules
Use '-r' or '--require' to load modules:
```
$ rinore -r lodash
Loading module 'lodash'...
rinore> lodash([1, 2, 3]).map(v => v * 2).reverse().value()
[ 6, 4, 2 ]
```
You can specify an another name using `:`:
```
$ rinore -r lodash:l
Loading module 'lodash' as 'l'...
rinore> l([1, 2, 3]).map(v => v * 2).reverse().value()
[ 6, 4, 2 ]
```
If you give a name `*`, all exported objects are spread to the global:
```
$ cat util.js
exports.add = (a, b) => a + b
exports.sub = (a, b) => a - b
$ rinore -r util:*
Loading module 'util' as '*'...
rinore> add(1, 2)
3
rinore> sub(10, 3)
7
```
Or you can use `rinore.context` to expose your objects:
```
$ cat util.js
const rinore = require('rinore');
rinore.context.add = (a, b) => a + b
$ rinore -r util
Loading module 'util'...
rinore> add(1, 2)
3
```
## Promise support
If an expression returns Promise, Rinore waits until it resolves:
```
rinore> new Promise(resolve => resolve('done'))
'done'
```
You can assign the result of Promise to a variable:
```
rinore> result = new Promise(resolve => resolve('done'))
'done'
rinore> result.length
4
```
If you are using TypeScript, you should use await keyword:
```
$ rinore -l typescript
rinore> const result = await new Promise(resolve => resolve('done'))
undefined
rinore> result.length
4
```
## Runtime invocation
Rinore can be started in the middle of a running program.
```
$ cat util.js
const rinore = require('.');
rinore.context.add = (a, b) => a + b
rinore.start();
$ node util.js
rinore> add(1, 2)
3
```
## Show function arguments
Rinore shows function arguments when Tab is pressed.
```
rinore> util.inspect
util.inspect(obj, opts)
rinore> console.log(url.parse(
url.parse(url, parseQueryString, slashesDenoteHost)
```
## package.json
You can specify CLI arguments in the package.json
```
{
"rinore": {
"language": "coffeescript",
"require": [
"bluebird:Promise",
"lodash"
]
}
}
```
## Running Rinore server
You can run a Rinore server via --listen argument.
```
$ rinore --listen 5678
Rinore is listening on 5678
rinore>
```
Or you can programmatically.
```
const net = require('net');
const rinore = require('.');
net.createServer((socket) => {
console.log('Starting new session...');
rinore.start({input: socket, output: socket, terminal: true})
.on('exit', () => {
console.log('Session closed.');
socket.end();
});
}).listen(2000, (error) => {
if (error) {
console.log(error);
} else {
console.log('Rinore is listening on 2000');
}
});
```
You can connect to this server via `telnet` or `rinore-remote`.
```
$ telnet localhost 2000
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
rinore> 1+1
1+1
2
rinore> ^]
telnet> quit
Connection closed.
```
```
$ rinore-remote 2000
rinore> 1+1
2
```
# Inspiration
To find best REPL experience, Rinore has referred some projects:
- [Rails console](http://guides.rubyonrails.org/command_line.html#rails-console)
- [django shell](https://docs.djangoproject.com/en/1.11/ref/django-admin/#shell)
- [local-repl](https://github.com/sloria/local-repl)
- [IPython](https://ipython.org/)
- [bpython](https://bpython-interpreter.org/)
- [pry](https://github.com/pry/pry)
# License
MIT licenses. See [LICENSE](https://github.com/croquiscom/rinore/blob/main/LICENSE) for more details.