Skip to content

Commit 787f352

Browse files
committed
Update README.md and flymake-bashate-setup
1 parent 2339c28 commit 787f352

File tree

2 files changed

+10
-16
lines changed

2 files changed

+10
-16
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# flymake-bashate.el
2+
[![MELPA](https://melpa.org/packages/flymake-bashate-badge.svg)](https://melpa.org/#/flymake-bashate)
23
![Build Status](https://github.com/jamescherti/flymake-bashate.el/actions/workflows/ci.yml/badge.svg)
34
![License](https://img.shields.io/github/license/jamescherti/flymake-bashate.el)
45
![](https://raw.githubusercontent.com/jamescherti/flymake-bashate.el/main/.images/made-for-gnu-emacs.svg)
@@ -7,22 +8,15 @@ The `flymake-bashate` Emacs package provides a Flymake backend for the `bashate`
78

89
## Installation
910

10-
### Install using straight
11-
12-
To install the `flymake-bashate` using straight.el`:
13-
14-
1. If you haven't already done so, [add the straight.el bootstrap code](https://github.com/radian-software/straight.el?tab=readme-ov-file#getting-started) to your init file.
15-
16-
2. Add the following code to your Emacs init file:
11+
To install the `flymake-bashate` from MELPA by adding the following code to your Emacs init file:
1712
```emacs-lisp
1813
(use-package flymake-bashate
1914
:ensure t
20-
:straight (flymake-bashate
21-
:type git
22-
:host github
23-
:repo "jamescherti/flymake-bashate.el")
24-
:hook ((sh-mode . flymake-bashate-setup)
25-
(bash-ts-mode . flymake-bashate-setup)))
15+
:commands flymake-bashate-setup
16+
:hook (((bash-ts-mode sh-mode) . flymake-bashate-setup)
17+
((bash-ts-mode sh-mode) . flymake-mode))
18+
:custom
19+
(flymake-bashate-max-line-length 80))
2620
```
2721

2822
## Customization
@@ -69,6 +63,7 @@ You should have received a copy of the GNU General Public License along with thi
6963
## Links
7064

7165
- [flymake-bashate.el @GitHub](https://github.com/jamescherti/flymake-bashate.el)
66+
- [Bashate @MELPA](https://melpa.org/#/flymake-bashate)
7267
- [Bashate @GitHub](https://github.com/openstack/bashate)
7368

7469
Other Emacs packages by the same author:

flymake-bashate.el

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
2424

2525
;;; Commentary:
26-
;; `flymake-bashate' is a Flymake handler for Emacs that checks Bash code style
26+
;; `flymake-bashate' is a Flymake backend that checks Bash code style
2727
;; using Bashate.
2828
;;
2929
;; (Bashate is a Bash script syntax checker, enforcing a set of style and syntax
@@ -108,8 +108,7 @@ environment variable."
108108
;;;###autoload
109109
(defun flymake-bashate-setup ()
110110
"Enable Flymake and flymake-bashate."
111-
(add-hook 'flymake-diagnostic-functions 'flymake-bashate-backend nil t)
112-
(flymake-mode t))
111+
(add-hook 'flymake-diagnostic-functions #'flymake-bashate-backend nil t))
113112

114113
(provide 'flymake-bashate)
115114
;;; flymake-bashate.el ends here

0 commit comments

Comments
 (0)