sjs/repl-edit
1
0
Fork 0
mirror of https://github.com/samsonjs/repl-edit.git synced 2026-03-25 09:25:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Compare commits

base: sjs:master
Branches Tags
sjs:master
sjs:v0.9.4
sjs:v0.9.3
sjs:v0.9.2
sjs:v0.9.1
sjs:v0.9
sjs:v0.0.3
sjs:v0.0.2
..
compare: sjs:v0.9.1
Branches Tags
sjs:master
sjs:v0.9.4
sjs:v0.9.3
sjs:v0.9.2
sjs:v0.9.1
sjs:v0.9
sjs:v0.0.3
sjs:v0.0.2

No commits in common. "master" and "v0.9.1" have entirely different histories.
master ... v0.9.1

4 changed files with 94 additions and 190 deletions
Show stats Expand all files Collapse all files

21
Readme.md
View file

@ -1,13 +1,3 @@
# I'M NOT DEAD, I'M JUST RESTING
Beautiful plumage. But this project no longer functions and some of the functionality here has been implemented
in Node proper via .load and .save in the REPL. I will no longer maintain it (poorly and infrequently).
If you want to contribute a .edit command to Node that would be pretty snazzy. Now that the REPL sucks less
it's less pressing though. You can paste in some code the REPL doesn't understand, or broken syntax, and
then Ctrl-C your way out of it.
repl-edit
=========
@ -25,7 +15,7 @@ Usage
Typically you just type `require('repl-edit')` in node's repl and it will extend it with new commands, just like `.break` and `.clear` that come with node.
(You can also fire up a repl with editing capabilities by running `node-repl-edit` in your shell)
You can also fire up a repl with editing capabilities by running `node-repl-edit` in your shell.
Commands
========
@ -33,7 +23,7 @@ Commands
.edit
-----
The first time you run `.edit` your editor is opened containing the last statement you entered. Type away and then save and close the file when you're done. The code will be loaded and executed immediately. When you subsequently run `.edit` your editor is opened and contains whatever you left there.
`.edit` opens your editor. Type away and then save and close the file when you're done. The command will be loaded and executed immediately.
Your editor is determined by the `VISUAL` and `EDITOR` environment variables, in that order. You can also change the editor for a single edit by doing something like `.edit vim`.
@ -57,9 +47,14 @@ Your editor is determined by the `VISUAL` and `EDITOR` environment variables, in
`.unstash /path/to/a/file` restores the contents of that file for you to run and/or edit.
TODO
====
The first time `.edit` is run instead of an empty file the command should be seeded with the last command that was executed.
License
=======
Copyright 2010 - 2011 Sami Samhuri <sami@samhuri.net>
MIT license, see the included [LICENSE](/samsonjs/repl-edit/blob/master/LICENSE)
MIT license, see the included [LICENSE](/samsonjs/repl-edit/blob/master/LICENSE)

168
lib/index.js
View file

@ -8,127 +8,101 @@
// TODO proper error handling, better intregration with node/lib/repl.js
var fs = require('fs')
, replModule = require('repl')
, spawn = require('child_process').spawn
, util = require('util')
, vm = require('vm')
, Hint = 'Commands: .edit, .run, .stash <filename>, .unstash <filename>, .editor <editor>'
, theRepl
module.exports = { startRepl: startRepl, extendRepl: extendRepl }
var repl
// Start a repl
function startRepl() {
if (theRepl) {
if (repl) {
console.error('repl is already running, only one instance is allowed')
return
}
return extendRepl(replModule.start('> '))
extendRepl(require('repl').start())
}
function log(s) {
if (theRepl.outputStream) {
theRepl.outputStream.write(s + '\n' + theRepl.prompt)
theRepl.displayPrompt()
}
}
function extendRepl(aRepl) {
if (theRepl) {
function extendRepl(theRepl) {
if (repl) {
console.error('repl is already running, only one instance is allowed')
return
}
if (!aRepl || typeof aRepl.defineCommand !== 'function') {
if (!theRepl || typeof theRepl.defineCommand !== 'function') {
console.error('bad argument, repl is not compatible')
return
}
theRepl = aRepl
repl = theRepl
var tmpfile = makeTempfile()
process.on('exit', function() {
try {
fs.unlinkSync(tmpfile)
}
catch (e) {
} catch (e) {
// might not exist
}
})
log(Hint)
repl.outputStream.write('Commands: .edit, .run, .stash <filename>, .unstash <filename>, .editor <editor>\n')
repl.displayPrompt()
theRepl.defineCommand('edit', {
help: 'Edit the current command in your text editor'
, action: function(editor) {
repl.defineCommand('edit', {
help: 'Edit the current command in your text editor',
action: function(editor) {
edit(tmpfile, editor)
}
})
theRepl.defineCommand('run', {
help: 'Run the previously edited command'
, action: function() {
repl.defineCommand('run', {
help: 'Run the previously edited command',
action: function() {
pause()
run(tmpfile, function() { unpause() })
}
})
theRepl.defineCommand('stash', {
help: 'Write the current command to the named file'
, action: function(dest) {
repl.defineCommand('stash', {
help: 'Write the current command to the named file',
action: function(dest) {
stash(tmpfile, dest)
}
})
theRepl.defineCommand('unstash', {
help: 'Replace the current command with the contents of the named file'
, action: function(source) {
repl.defineCommand('unstash', {
help: 'Replace the current command with the contents of the named file',
action: function(source) {
unstash(tmpfile, source)
}
})
theRepl.defineCommand('editor', function(editor) {
repl.defineCommand('editor', function(editor) {
process.env['VISUAL'] = editor
})
return theRepl
}
// Commands
function edit(cmdFile, editor) {
function edit(cmdfile, editor) {
editor = editor || process.env['VISUAL'] || process.env['EDITOR']
// TODO seed the file with repl.context._ if the file doesn't exist yet
var fds = [process.openStdin(), process.stdout, process.stdout]
, args = [cmdFile]
, args = [cmdfile]
// handle things like 'mate -w' and 'emacsclient --server-file <filename>'
if (editor.match(/\s/)) {
var words = editor.split(/\s+/) // FIXME this should do proper word splitting ...
args = words.slice(1).concat(args)
editor = words[0]
}
// seed the file with repl.context._ if the file doesn't exist yet
try {
fs.statSync(cmdFile)
}
catch (e) {
// skip history[0], it's the .edit command
var lastCmd = theRepl.rli.history[1]
if (lastCmd && lastCmd[0] !== '.') {
fs.writeFileSync(cmdFile, lastCmd)
}
}
pause()
spawn(editor, args, {customFds: fds}).on('exit', function(code) {
// some editors change the terminal resulting in skewed output, clean up
spawn('reset').on('exit', function(_) {
if (code === 0) {
run(cmdFile, function() { unpause() })
}
else {
run(cmdfile, function() { unpause() })
} else {
unpause()
}
})
@ -138,41 +112,30 @@ function edit(cmdFile, editor) {
function stash(cmdFile, dest) {
try {
fs.statSync(cmdFile)
}
catch (e) {
log('nothing to stash')
return
}
dest = dest.trim()
if (!dest) {
log('try: .stash /path/to/file')
} catch (e) {
console.log('nothing to stash')
return
}
var read = fs.createReadStream(cmdFile)
read.on('end', function() {
log('stashed')
console.log('stashed')
unpause()
})
// TODO confirm before overwriting an existing file
pause()
util.pump(read, fs.createWriteStream(dest))
}
function unstash(cmdFile, source) {
source = source.trim()
if (!source) {
log('try: .unstash /path/to/file')
return
}
try {
fs.statSync(source)
}
catch (e) {
log('no stash at ' + source)
} catch (e) {
console.log('no stash at ' + source)
return
}
var read = fs.createReadStream(source)
read.on('end', function() {
log('unstashed')
console.log('unstashed')
unpause()
})
pause()
@ -183,30 +146,31 @@ function run(filename, callback) {
// check if file exists. might not have been saved.
try {
fs.statSync(filename)
}
catch (e) {
log('nothing to run\n')
} catch (e) {
repl.stream.write('nothing to run\n')
callback()
return
}
var read = fs.createReadStream(filename)
, cmd = ''
read.on('data', function(d) { cmd += d })
var evalcx = require('vm').Script.runInContext
, read = fs.createReadStream(filename)
, s = ''
read.on('data', function(d) { s += d })
read.on('end', function() {
// The catchall for errors
try {
var ret = vm.runInContext(cmd, theRepl.context, 'repl');
theRepl.context._ = ret
theRepl.outputStream.write(replModule.writer(ret) + '\n')
}
catch (e) {
// Use evalcx to supply the global context
var ret = evalcx(s, repl.context, "repl");
if (ret !== undefined) {
repl.context._ = ret;
repl.writer(ret) + "\n"
}
} catch (e) {
// On error: Print the error and clear the buffer
if (e.stack) {
log(e.stack + '\n')
}
else {
log(e.toString() + '\n')
repl.stream.write(e.stack + "\n");
} else {
repl.stream.write(e.toString() + "\n");
}
}
if (callback) callback()
@ -217,19 +181,19 @@ function run(filename, callback) {
var origPrompt
function unpause() {
theRepl.prompt = origPrompt
theRepl.rli.enabled = true
theRepl.outputStream.resume()
theRepl.inputStream.resume()
theRepl.displayPrompt()
repl.prompt = origPrompt
repl.rli.enabled = true
repl.outputStream.resume()
repl.inputStream.resume()
repl.displayPrompt()
}
function pause() {
theRepl.outputStream.pause()
theRepl.inputStream.pause()
theRepl.rli.enabled = false
origPrompt = theRepl.prompt || '> '
theRepl.prompt = ''
repl.outputStream.pause()
repl.inputStream.pause()
repl.rli.enabled = false
origPrompt = repl.prompt || '> '
repl.prompt = ''
}
function makeTempfile() {
@ -249,9 +213,5 @@ function makeTempfile() {
return path.join(tmpdir, 'node-repl-' + process.pid + '.js')
}
if (require.main === module) {
startRepl()
}
else if (module.parent && module.parent.id === 'repl') {
extendRepl(module.parent.exports.repl)
}
if (require.main === module) startRepl()
else if (module.parent && module.parent.id === 'repl') extendRepl(module.parent.exports.repl)

53
package.json
View file

@ -1,34 +1,23 @@
{
"name": "repl-edit",
"description": "Edit code in the repl using a real text editor",
"version": "0.9.5",
"homepage": "http://samhuri.net/proj/repl-edit",
"author": "Sami Samhuri <sami@samhuri.net>",
"repository": {
"type": "git",
"url": "git://github.com/samsonjs/repl-edit.git"
},
"bugs": {
"email": "sami.samhuri@gmail.com",
"url": "https://github.com/samsonjs/repl-edit/issues"
},
"directories": {
"lib": "./lib"
},
"bin": {
"node-repl-edit": "./repl.js"
},
"main": "./lib/index",
"engines": {
"node": ">=0.4.0"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/samsonjs/repl-edit/raw/master/LICENSE"
{ "name" : "repl-edit"
, "description" : "Edit code in the repl using a real text editor"
, "version" : "0.9.1"
, "homepage" : "http://samhuri.net/proj/repl-edit"
, "author" : "Sami Samhuri <sami@samhuri.net>"
, "repository" :
{ "type" : "git"
, "url" : "https://github.com/samsonjs/repl-edit.git"
}
, "bugs" :
{ "mail" : "sami.samhuri@gmail.com"
, "web" : "https://github.com/samsonjs/repl-edit/issues"
}
, "directories" : { "lib" : "./lib" }
, "bin" : { "node-repl-edit" : "./repl.js" }
, "main" : "./lib/index"
, "engines" : { "node" : ">=0.4.0" }
, "licenses" :
[ { "type" : "MIT"
, "url" : "https://github.com/samsonjs/repl-edit/raw/master/LICENSE"
}
],
"dependencies": {},
"devDependencies": {},
"optionalDependencies": {}
]
}

42
repl.js
View file

@ -1,43 +1,3 @@
#!/usr/bin/env node
var fs = require('fs')
, path = require('path')
, repl = require('./lib/index').startRepl()
, DefaultHistoryFile = path.join(process.env.HOME, '.node_history')
, historyFile
if ('NODE_HISTORY' in process.env)
historyFile = process.env.NODE_HISTORY
else
historyFile = DefaultHistoryFile
// restore history immediately
if (historyFile) {
try {
fs.statSync(historyFile)
var json = fs.readFileSync(historyFile)
repl.rli.history = JSON.parse(json)
}
catch (e) {
if (e.code !== 'ENOENT') {
console.error('!!! Error reading history from ' + historyFile)
if (e.message === 'Unexpected token ILLEGAL') {
console.error('is this a JSON array of strings? -> ' + json)
}
else {
console.error(e.message)
}
}
}
// save history on exit
process.on('exit', function() {
try {
fs.writeFileSync(historyFile, JSON.stringify(repl.rli.history))
}
catch (e) {
console.error('Error writing history file to ' + historyFile)
console.error(e)
}
})
}
require('./lib/index').startRepl()