mkvoya / eglot-grammarly

Eglot Clients for Grammarly

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

License: GPL v3 JCS-ELPA

eglot-grammarly

CI

eglot client leveraging grammarly-language-server.

πŸ’Ύ Quickstart

πŸ” Step 1. Install Grammarly language server through NPM

First, install the language server using NPM.

npm install -g @emacs-grammarly/grammarly-languageserver

πŸ” Step 2. Configure your Emacs configuration

Consider adding this to your configuration.

(use-package eglot-grammarly
  :ensure t
  :hook (text-mode . (lambda ()
                       (require 'eglot-grammarly)
                       (call-interactively #'eglot))))

If you use straight.el, you can also get this package directly from github.

(use-package eglot-grammarly
  :straight (:host github :repo "emacs-grammarly/eglot-grammarly")
  :defer t  ; defer package loading
  :hook ((text-mode markdown-mode). (lambda ()
                                      (require 'eglot-grammarly)
                                      (eglot-ensure))))

πŸ”§ Configuration

Create .dir-locals.el file in the the project root directory.

((nil
  (eglot-workspace-configuration
   . ((@emacs-grammarly/grammarly-languageserver
       . ((audience . "knowledgeable")))))))

P.S. See all possible configuration here.

Contribute

PRs Welcome Elisp styleguide Donate on paypal Become a patron

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

About

Eglot Clients for Grammarly

License:GNU General Public License v3.0


Languages

Language:Emacs Lisp 96.9%Language:Makefile 3.1%