emacs-grammarly / unofficial-grammarly-language-server

Unofficial Grammarly extension
https://www.npmjs.com/package/@emacs-grammarly/unofficial-grammarly-language-server
MIT License
21 stars 3 forks source link
grammarly language-server-protocol lsp

⚠️ Notice: This language server is deprecated; we now move to the newer one, grammarly-language-server.

License: MIT Release npm npm-dt npm-dm

Grammarly

CI/CD dependencies Status

Update: Grammarly API is released, so this project will switch to official API. See https://github.com/znck/grammarly/issues/206

Unofficial Grammarly extension.

Preview of Grammarly diagnostics

Using a Paid Grammarly Account

Use the Grammarly: Login to grammarly.com command to enter your account credentials. The command will prompt you first for username and then for a password.

set credentials screencast

Configuring alert severity

You can assign severity levels to the Grammarly diagnostics category. To find diagnostics category name, hover on a problem in the editor. (see category name highlighted in the following example)

Grammarly diagnostic category

{
  "grammarly.severity": {
    "Fragment": 2 // Sets Fragment category to Warning.
  }
}

Severity Levels

Name Value
Error 1
Warning 2
Information 3
Hint 4

Extension Settings

This extension contributes to the following settings:

Release Notes

Version 0.12.0

Version 0.11.0

Version 0.10.0

Version 0.9.0

Version 0.8.0

Version 0.7.0

Using the keytar package to store user credentials in the system keychain.

Version 0.6.0

Ignore diagnostics in regions of markdown. By default, fenced code blocks are ignored.

To ignore inline code snippets, set grammarly.diagnostics to:

{
  "[markdown]": {
    "ignore": ["inlineCode", "code"]
  }
}

The ignore option uses node types from remark AST, you can find supported type in this example on ASTExplorer.

Version 0.5.0

Custom Grammarly goals per document.

Version 0.4.0

Dismiss alerts.

Version 0.3.0

Save words to local or Grammarly dictionary.

Add to dictionary example

Version 0.1.0

Uses incremental document sync to send operational transformation messages to Grammarly API which gives near real-time feedback/diagnostics.

Version 0.0.0

The initial release of unofficial Grammarly extension.

Enjoy!