From f233440507d91e1039d3869f12999dfb17c9b16e Mon Sep 17 00:00:00 2001 From: Dan Orzechowski Date: Tue, 4 Dec 2018 00:23:36 -0500 Subject: [PATCH 1/5] Create README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..924d1df --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# flymake-eslint +Flymake backend for Javascript using eslint + +Download to `~/.emacs.d/lisp`, then edit `~/.emacs` or equivalent: +```lisp +(add-to-list 'load-path "~/.emacs.d/lisp") +(require "flymake-eslint.el") +(add-hook 'web-mode-hook ; or whatever the mode-hook is for your mode of choice + (lambda () + (flymake-mode) ; or some other mode like eglot-mode which enables flymake-mode automatically + (flymake-eslint-enable))) +``` From cc55a602938a710336f849a544817f96a45c4af6 Mon Sep 17 00:00:00 2001 From: Dan Orzechowski Date: Tue, 4 Dec 2018 00:25:57 -0500 Subject: [PATCH 2/5] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 924d1df..072cbc6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # flymake-eslint Flymake backend for Javascript using eslint +## Installation + Download to `~/.emacs.d/lisp`, then edit `~/.emacs` or equivalent: ```lisp (add-to-list 'load-path "~/.emacs.d/lisp") @@ -10,3 +12,6 @@ Download to `~/.emacs.d/lisp`, then edit `~/.emacs` or equivalent: (flymake-mode) ; or some other mode like eglot-mode which enables flymake-mode automatically (flymake-eslint-enable))) ``` +## Customization + +useful variables are members of the `flymake-eslint` group and can be viewed and modified with the command `M-x customize-group [RET] flymake-eslint [RET]`. From 33cf3707a92be9529c315ab1b3be3fe51d7a85ac Mon Sep 17 00:00:00 2001 From: Dan Orzechowski Date: Tue, 4 Dec 2018 00:26:32 -0500 Subject: [PATCH 3/5] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 072cbc6..db26442 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ Download to `~/.emacs.d/lisp`, then edit `~/.emacs` or equivalent: ```lisp (add-to-list 'load-path "~/.emacs.d/lisp") (require "flymake-eslint.el") +``` + +## Usage + +```lisp (add-hook 'web-mode-hook ; or whatever the mode-hook is for your mode of choice (lambda () (flymake-mode) ; or some other mode like eglot-mode which enables flymake-mode automatically From 7f8b8d773075bc4b864e2381e4dcf159a9a74ee3 Mon Sep 17 00:00:00 2001 From: Dan Orzechowski Date: Tue, 4 Dec 2018 00:32:56 -0500 Subject: [PATCH 4/5] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index db26442..94175a3 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Flymake backend for Javascript using eslint ## Installation -Download to `~/.emacs.d/lisp`, then edit `~/.emacs` or equivalent: +Download and place inside `~/.emacs.d/lisp` then edit `~/.emacs` or equivalent: ```lisp (add-to-list 'load-path "~/.emacs.d/lisp") (require "flymake-eslint.el") @@ -11,6 +11,7 @@ Download to `~/.emacs.d/lisp`, then edit `~/.emacs` or equivalent: ## Usage +also in `~/.emacs` or wherever: ```lisp (add-hook 'web-mode-hook ; or whatever the mode-hook is for your mode of choice (lambda () From d18c2a11d6a7041a5d81f66b6eabc6a71d64448e Mon Sep 17 00:00:00 2001 From: Dan Orzechowski Date: Tue, 4 Dec 2018 00:38:57 -0500 Subject: [PATCH 5/5] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 94175a3..b7b460d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ Flymake backend for Javascript using eslint ## Installation -Download and place inside `~/.emacs.d/lisp` then edit `~/.emacs` or equivalent: +0. Make sure `eslint` is installed and present on your emacs `exec-path`. For Linux systems `exec-path` usually equals your `$PATH` environment variable; for other systems, you're on your own. +1. Download and place inside `~/.emacs.d/lisp` +2. Edit `~/.emacs` or equivalent: ```lisp (add-to-list 'load-path "~/.emacs.d/lisp") (require "flymake-eslint.el")