Skip to content

Flycheck integration for the vale natural language linter

License

Notifications You must be signed in to change notification settings

abingham/flycheck-vale

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 

Repository files navigation

flycheck-vale

MELPA

This package provides flycheck integration for vale. Flycheck is an Emacs system for on-the-fly syntax checking. Vale is a natural language linter. So with flycheck-vale you get on-the-fly natural language linting.

Right now flycheck-vale is very new and unpolished. Ideas, PRs, etc. are welcome!

Quickstart

Install flycheck-vale from MELPA using package-install or something equivalent.

To use flycheck-vale just require it and run flycheck-vale-setup:

(require 'flycheck-vale)
(flycheck-vale-setup)

Dis/enabling flycheck-vale for specific buffers

The buffer-local variable flycheck-vale-enabled allows you to enabled or disable vale linting for specific buffers. If this variable is t then vale linting will be performed (assuming you've got flycheck-mode enabled, etc.) Likewise, if it is nil then vale linting will never be performed.

You can use flycheck-vale-toggle-enabled to toggle this variable between t and nil. (And of course you can set it other ways if you want.) By default the variable is t.

Enabling flycheck-vale for new modes

By default flycheck-vale will only be enabled for the modes in flycheck-vale-modes (currently text-mode, markdown-mode, rst-mode, and org-mode). To enable it for some other mode, use the function flycheck-add-mode. If you think that this mode should be supported by flycheck-vale by default, bring it up in an issue.

About

Flycheck integration for the vale natural language linter

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published