Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 3.76 KB

README.md

File metadata and controls

121 lines (83 loc) · 3.76 KB
Raw

License: GPL v3 MELPA MELPA Stable

flymake-grammarly

Flymake support for Grammarly.

CI

🔧 Usage

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

(require 'flymake-grammarly)

You can generally call flymake-grammarly-load to any mode-hook for grammarly to start working.

(add-hook 'text-mode-hook 'flymake-grammarly-load)
(add-hook 'latex-mode-hook 'flymake-grammarly-load)
(add-hook 'org-mode-hook 'flymake-grammarly-load)
(add-hook 'markdown-mode-hook 'flymake-grammarly-load)

otherwise you can call flymake-grammarly-maybe-load like the snippt below.

(add-hook 'find-file-hook 'flymake-grammarly-maybe-load)

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

(setq flymake-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

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!

🔬 Development

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

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.