Skip to content

Commit 78f98c5

Browse files
committed
Improve README
1 parent d38211f commit 78f98c5

File tree

2 files changed

+50
-22
lines changed

2 files changed

+50
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,59 @@ Description
88

99
This program is derived from comint-mode and provides the following features.
1010

11-
* token completion, same as Node.js REPL
12-
* file name completion in string
13-
* incremental history search
14-
* sending JavaScript codes to REPL
11+
* token completion, same as Node.js REPL
12+
* file name completion in string
13+
* incremental history search
14+
* sending JavaScript codes to REPL
1515

1616
Usage
1717
-----
1818

1919
Put this file in your Emacs lisp path (e.g. ~/.emacs.d/site-lisp)
2020
and add the following line to your .emacs:
2121

22-
(require 'nodejs-repl)
22+
```elisp
23+
(require 'nodejs-repl)
24+
```
2325

2426
Type `M-x nodejs-repl` to run Node.js REPL.
2527
See also `comint-mode` to check key bindings.
2628

2729
You can define key bindings to send JavaScript codes to REPL like below:
2830

29-
(add-hook 'js-mode-hook
30-
(lambda ()
31-
(define-key js-mode-map (kbd "C-x C-e") 'nodejs-repl-send-last-expression)
32-
(define-key js-mode-map (kbd "C-c C-j") 'nodejs-repl-send-line)
33-
(define-key js-mode-map (kbd "C-c C-r") 'nodejs-repl-send-region)
34-
(define-key js-mode-map (kbd "C-c C-l") 'nodejs-repl-load-file)
35-
(define-key js-mode-map (kbd "C-c C-z") 'nodejs-repl-switch-to-repl)))
31+
```elisp
32+
(add-hook 'js-mode-hook
33+
(lambda ()
34+
(define-key js-mode-map (kbd "C-x C-e") 'nodejs-repl-send-last-expression)
35+
(define-key js-mode-map (kbd "C-c C-j") 'nodejs-repl-send-line)
36+
(define-key js-mode-map (kbd "C-c C-r") 'nodejs-repl-send-region)
37+
(define-key js-mode-map (kbd "C-c C-l") 'nodejs-repl-load-file)
38+
(define-key js-mode-map (kbd "C-c C-z") 'nodejs-repl-switch-to-repl)))
39+
```
3640

3741
When a version manager such as nvm is used to run different versions
3842
of Node.js, it is often desirable to start the REPL of the version
3943
specified in the .nvmrc file per project. In such case, customize the
4044
`nodejs-repl-command` variable with a function symbol. That function
4145
should query nvm for the Node.js command to run. For example:
4246

43-
(require 'nodejs-repl)
44-
(defun nvm-which ()
45-
(let* ((shell (concat (getenv "SHELL") " -l -c 'nvm which'"))
46-
(output (shell-command-to-string shell)))
47-
(cadr (split-string output "[\n]+" t))))
48-
(setq nodejs-repl-command #'nvm-which)
47+
```elisp
48+
(require 'nodejs-repl)
49+
(defun nvm-which ()
50+
(let* ((shell (concat (getenv "SHELL") " -l -c 'nvm which'"))
51+
(output (shell-command-to-string shell)))
52+
(cadr (split-string output "[\n]+" t))))
53+
(setq nodejs-repl-command #'nvm-which)
54+
```
4955

5056
The `nvm-which` function can be simpler, and perhaps can run faster,
5157
too, if using Bash:
5258

53-
(defun nvm-which ()
54-
(let ((output (shell-command-to-string "source ~/.nvm/nvm.sh; nvm which")))
55-
(cadr (split-string output "[\n]+" t))))
59+
```elisp
60+
(defun nvm-which ()
61+
(let ((output (shell-command-to-string "source ~/.nvm/nvm.sh; nvm which")))
62+
(cadr (split-string output "[\n]+" t))))
63+
```
5664

5765
Author
5866
------
@@ -63,7 +71,7 @@ Takeshi Arabiki (abicky)
6371
Copyright and License
6472
---------------------
6573

66-
Copyright (C) 2012-2017 Takeshi Arabiki (abicky)
74+
Copyright (C) 2012-2018 Takeshi Arabiki (abicky)
6775

6876
This program is free software: you can redistribute it and/or modify
6977
it under the terms of the GNU General Public License as published by

nodejs-repl.el

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,26 @@
4444
;; (define-key js-mode-map (kbd "C-c C-l") 'nodejs-repl-load-file)
4545
;; (define-key js-mode-map (kbd "C-c C-z") 'nodejs-repl-switch-to-repl)))
4646
;;
47+
;; When a version manager such as nvm is used to run different versions
48+
;; of Node.js, it is often desirable to start the REPL of the version
49+
;; specified in the .nvmrc file per project. In such case, customize the
50+
;; `nodejs-repl-command` variable with a function symbol. That function
51+
;; should query nvm for the Node.js command to run. For example:
52+
;;
53+
;; (require 'nodejs-repl)
54+
;; (defun nvm-which ()
55+
;; (let* ((shell (concat (getenv "SHELL") " -l -c 'nvm which'"))
56+
;; (output (shell-command-to-string shell)))
57+
;; (cadr (split-string output "[\n]+" t))))
58+
;; (setq nodejs-repl-command #'nvm-which)
59+
;;
60+
;; The `nvm-which` function can be simpler, and perhaps can run faster,
61+
;; too, if using Bash:
62+
;;
63+
;; (defun nvm-which ()
64+
;; (let ((output (shell-command-to-string "source ~/.nvm/nvm.sh; nvm which")))
65+
;; (cadr (split-string output "[\n]+" t))))
66+
;;
4767

4868
(require 'cc-mode)
4969
(require 'comint)

0 commit comments

Comments
 (0)