From 89cce91212cb58bc4bed1ec78937b480946c61bd Mon Sep 17 00:00:00 2001 From: Sami Samhuri Date: Wed, 18 May 2011 00:14:54 -0700 Subject: [PATCH] update readme --- Readme.md | 65 ++++++++++++++++++++----------------------------------- 1 file changed, 23 insertions(+), 42 deletions(-) diff --git a/Readme.md b/Readme.md index e9ed795..3554ee6 100644 --- a/Readme.md +++ b/Readme.md @@ -5,75 +5,56 @@ Use your text editor to edit commands in Node's repl. (tip o' the hat to Giles Bowkett for [inspiration](http://gilesbowkett.blogspot.com/2010/09/vim-in-irb-with-utility-belt.html)) - Installation ============ npm install repl-edit - Usage ===== -You can fire up a repl with editing capabilities by running `node-repl-edit`. - -(It would be nice to extend an existing repl session but that's not possible with -Node's repl module right now.) +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. Commands ======== -edit ----- - -The first time you run `edit()` in a repl a temporary file is created, specific to that session, -and opened in your editor. Type away and then save and close the file when you're done. The file -is loaded and executed immediately. - - -run ---- - -To run whatever command you've been working on without editing it again type `run()`. - - -setEditor ---------- - -`setEditor('mate -w')` changes your editor to TextMate for this session. Note that this -command sets the environment variable EDITOR for the repl process. - - -stash +.edit ----- -`stash('/path/to/a/file')` saves your command to the named file. +`.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`. -unstash +.run +---- + +`.run` runs the most recent command you've edited. + +.editor ------- -`unstash('/path/to/a/file')` restores the contents of that file for you to run and/or edit. +`.editor mate -w` changes your editor to TextMate for this session, by setting the environment variable `VISUAL`. +.stash +------ -Future -====== +`.stash /path/to/a/file` saves your command to the named file. -Instead of polluting the global namespace with functions I'd rather extend Node's repl -to allow user-defined dot commands (just like `.break` and `.clear`), and then use that -capability to provide commands like `.edit` and `.stash `. +.unstash +-------- -The first time edit() is run in a repl instead of an empty file the command should be seeded -with the last command that was executed. +`.unstash /path/to/a/file` restores the contents of that file for you to run and/or edit. -If the native repl module exports the currently running repl object it will be possible to attach -to an existing repl instead of having to run a separate binary that loads a repl. +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 Sami Samhuri sami@samhuri.net +Copyright 2010 - 2011 Sami Samhuri -MIT (see the file named [LICENSE](/samsonjs/repl-edit/blob/master/LICENSE)) \ No newline at end of file +MIT license, see the included [LICENSE](/samsonjs/repl-edit/blob/master/LICENSE) \ No newline at end of file