emacs-grammarly/flycheck-grammarly

Grammarly support for Flycheck

flycheck-grammarly

Grammarly support for Flycheck.

🔨 Usage

To enable this package, simply add loading to your config like the code below.

(with-eval-after-load 'flycheck
  (flycheck-grammarly-setup))

If you encounter the performance issue, try raise flycheck-grammarly-check-time higher. The request will be send by this time everytime the buffer has changed.

(setq flycheck-grammarly-check-time 0.8)

Todo List

• Strip only text data, if other data like # header or > quote will return nothing.
• Usable but not fast enough, really depends on Grammarly's analyzer.

🛠️ Contribute

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!

🔬 Development

To run the test locally, you will need the following tools:

• Eask
• Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.

flycheck-grammarly's Issues

How can we limit messages to only errors and warnings?

The grammarly checker shows messages from different categories: errors, warnings, and info. On checking the code on the Grammarly website, I get to see only the errors. I have a free account, so the other features are limited.

How can we limit the information listed by grammarly checker to only say errors or errors and warnings, and leave out infos? Thanks.

`flycheck-grammarly` doesn't work with AUCTeX.

On Ubuntu 20.04, I'm using the latest git master version of Emacs, and installed the flycheck-grammarly as follows:

(use-package flycheck-grammarly)

But I can't see the effect represented here, as shown by the following screenshot:

Any hints for this problem?

Regards,
HY

Support gfm-mode

While markdown-mode is supported, GitHub Flavored Markdown (gfm-mode) doesn't.

-

Doesn't seem to work with non-trivial files?

Hi,

Thanks for writing this package, it looks like it could be very useful for my use cases. I was unable to get it working with files that contain anything more than simple sentences. Maybe it's due to something in my environment?

With this configuration:

(setq debug-on-error t)

(add-hook 'after-init-hook
          (lambda ()
            (setq debug-on-error nil)))

(require 'package)

(setq package-enable-at-startup nil)

(package-initialize)

(setq package-archives '(("org" . "https://orgmode.org/elpa/")
                         ("gnu" . "https://elpa.gnu.org/packages/")
                         ("melpa" . "https://melpa.org/packages/")))

(unless package-archive-contents
  (package-refresh-contents))

(unless (package-installed-p 'use-package)
  (package-refresh-contents)
  (package-install 'use-package))

(eval-when-compile
  (require 'use-package))

(setq use-package-always-ensure t)
(setq use-package-always-demand t)

;; macOS modifiers.
(setq mac-command-modifier 'meta)
;; Setting "Option" to nil allows me to type umlauts with "Option+u".
(setq mac-option-modifier nil)
(setq mac-control-modifier 'control)
(setq ns-function-modifier 'hyper)

(use-package flycheck)
(use-package flycheck-grammarly)

and this text (from https://orgmode.org/worg/org-tutorials/org4beginners.html, added first paragraph)

** Lord of the Rings
   My name Bob.

   My favorite scenes are (in this order)
   1. The attack of the Rohirrim
   2. Eowyn's fight with the witch king
      + this was already my favorite scene in the book
      + I really like Miranda Otto.
   3. Peter Jackson being shot by Legolas
       - on DVD only
      He makes a really funny face when it happens.
   But in the end, no individual scenes matter but the film as a whole.
   Important actors in this film are:
   - Elijah Wood :: He plays Frodo
   - Sean Austin :: He plays Sam, Frodo's friend.  I still remember
     him very well from his role as Mikey Walsh in The Goonies.

enabling flycheck-mode doesn't do anything. Changing the text to

** Lord of the Rings
   My name Bob.

correctly shows the flycheck error: "Your sentence appears to be missing a verb."

I have also tried exporting the document to Markdown and the behavior is the same.

Please let me know if you need more information.

GNU Emacs 28.0.50 (build 1, x86_64-apple-darwin19.5.0, NS appkit-1894.50 Version 10.15.5 (Build 19F101)) of 2020-10-03

flycheck-grammarly.el

;; Version: 0.1.5
;; Package-Version: 20200823.926
;; Package-Commit: 4ee6480871df74b05ada5f0afab5190930a70be9

Dictionary change

Hi, I'm using British english, but flycheck-grammarly marks -ise as an error. Is there a way to let flycheck grammarly use the British english?

LaTeX ?

This looks excellent. Did you consider supporting latex? Perhaps via RTF.

Transfer to flycheck organization?

Hi @cpitclaudel,

Would you mind if I transfer this package to the organization flycheck?

Let me know what you think! Thanks!

Request callback error

Hi,

Suppose I have a text buffer or a file with the following content.

This text has bug but Grammarly do not finds it.

The flycheck checkers are set as follows.

Syntax checkers for buffer *scratch* in text-mode:

First checker to run:

  textlint
    - may enable:         yes
    - executable:         Found at /home/swarnendu/tmp/textlint-workspace/node_modules/.bin/textlint
    - configuration file: Found at "/home/swarnendu/tmp/textlint-workspace/textlintrc.json"
    - textlint plugin:    @textlint/text
    - next checkers:      grammarly

Checkers that may run as part of the first checker's chain:

  grammarly
    - may enable: yes

The following syntax checkers are not registered:
  - proselint
Try adding these syntax checkers to `flycheck-checkers'.

Flycheck Mode is enabled. Use C-u C-c ! x to enable disabled checkers.

--------------------

Flycheck version: 32snapshot (package: 20210321.852)
Emacs version:    27.1
System:           x86_64-pc-linux-gnu
Window system:    x

Flycheck does not list errors from Grammarly. Opening the file or Invoking flycheck-buffer shows the following error.

connecting as swarnendu@**********
[error] request--callback: peculiar error: 401
connecting as swarnendu@**********
[error] request--callback: peculiar error: 401

I have a PRO account with Grammarly, and VS Code works fine. What could be the issue here? Thanks.

How to see the suggested change?

Hi there,

Thank you for creating this program. It is very useful. One thing I couldn't figure out is how to see the suggested change. For example, in the case of the example "She go there." in the screenshot, "go" is suggested to be changed to "goes" when you use the actually Grammarly. I see the explanation displayed but not the suggestion. How could I see that?

emacs-version:
GNU Emacs 26.3 (build 1, x86_64-w64-mingw32) of 2019-08-29

flycheck-grammarly:
20210814.1627

Grammarly Privacy Concerns

See emacs-grammarly/flymake-grammarly#2.

Replace info correction to something else

On this line (L176). I'm using info for trivial errors/warnings. Should I use warning instead of info?

https://github.com/jcs-elpa/flycheck-grammarly/blob/958a433c5f3c9b6ffd2d1c630f4d30e13d9b1a71/flycheck-grammarly.el#L176

Trivial warnings/errors are like,

• Vocabulary
• Formality
• Clarity

, etc.

Any suggestions are welcome!

Would you support mu4e-compose-mode?

Hi,

I use mu4e for email clients in Emacs and want to use Grammarly while composing an email, but it turns out flycheck-grammarly does not support the mu4e-compose-mode yet.

Would you support the mode in the future, please?

Thanks,

Proper documentation

As of now the package's dependencies are completely unknown. Although it can be installed, I don't know how to start it. The official readme should include installation instructions.

Premium Grammarly

Hi, Thank you for this nice package. Is there a way to use a premium account of Grammarly using this package?
What do you think is the best alternative to using the premium account?