Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/errata-ai/vale

:pencil: A markup-aware linter for prose built with speed and extensibility in mind.
https://github.com/errata-ai/vale

linter linting nlp vale

Last synced: 2 months ago
JSON representation

:pencil: A markup-aware linter for prose built with speed and extensibility in mind.

Lists

README 

        
# Vale: Your style, our editor [![Build status](https://ci.appveyor.com/api/projects/status/snk0oo6ih1nwuf6r?svg=true)](https://ci.appveyor.com/project/jdkato/vale) [![Go Report Card](https://img.shields.io/badge/%F0%9F%93%9D%20%20go%20report-A%2B-75C46B?color=00ACD7)](https://goreportcard.com/report/github.com/errata-ai/vale) [![GitHub All Releases](https://img.shields.io/github/downloads/errata-ai/vale/total?logo=GitHub&color=ff69b4)](https://github.com/errata-ai/vale/releases) [![Docker Pulls](https://img.shields.io/docker/pulls/jdkato/vale?color=orange&logo=docker&logoColor=white)](https://hub.docker.com/r/jdkato/vale) [![Chocolatey](https://img.shields.io/chocolatey/dt/vale?color=white&label=chocolatey&logo=chocolatey)](https://community.chocolatey.org/packages/vale) [![Homebrew](https://img.shields.io/homebrew/installs/dy/vale?color=yellow&label=homebrew&logo=homebrew)](https://formulae.brew.sh/formula/vale)



> Enjoying Vale? Please consider writing a user [testimonial][5].





  Vale is a command-line tool that brings code-like linting to prose. It's fast, cross-platform (Windows, macOS, and Linux), and highly customizable.







Docs

Vale Studio

Package Hub

Rule Explorer

Config Generator






## :heart: Sponsors



> Hi there! I'm [@jdkato](https://github.com/jdkato), the sole developer of Vale. If you'd like to help me dedicate more time to _developing_, _documenting_, and _supporting_ Vale, feel free to donate through [GitHub Sponsors](https://github.com/sponsors/jdkato) or [Open Collective](https://opencollective.com/vale). Any donation—big, small, one-time, or recurring—is greatly appreciated!



### Organizations
























### Other



> Thanks to [Appwrite][4] for supporting Vale through their [Open Source Sponsorship program][3].





  

    

  




### Individuals






## :boom: Key Features



- [x] **Support for markup**: Vale has a rich understanding of many [markup formats](https://docs.errata.ai/vale/scoping#formats), allowing it to avoid syntax-related false positives and intelligently exclude code snippets from prose-related rules.



- [x] A **highly customizable** [extension system](https://vale.sh/docs/topics/styles/): Vale is capable of enforcing _your style_—be it a standard [editorial style guide](https://github.com/errata-ai/styles#available-styles) or a custom in-house set of rules (such as those created by [GitLab](https://docs.gitlab.com/ee/development/documentation/testing.html#vale), [Homebrew](https://github.com/Homebrew/brew/tree/master/docs/vale-styles/Homebrew), [Linode](https://www.linode.com/blog/linode/docs-as-code-at-linode/), [CockroachDB](https://github.com/cockroachdb/docs/tree/master/vale), and [Spotify](https://github.com/spotify/backstage)).



- [x] **Easy-to-install**, stand-alone binaries: Unlike other tools, Vale doesn't require you to install and configure a particular programming language and its related tooling (such as Python/pip or Node.js/npm).



See the [documentation](https://vale.sh) for more information.



## :mag: At a Glance: Vale vs. `<...>`



> **NOTE**: While all of the options listed below are open-source (CLI-based) linters for prose, their implementations and features vary significantly. And so, the "best" option will depends on your specific needs and preferences.



### Functionality



| Tool       | Extensible           | Checks          | Supports Markup                                                         | Built With | License      |

| ---------- | -------------------- | --------------- | ----------------------------------------------------------------------- | ---------- | ------------ |

| Vale       | Yes (via YAML)       | spelling, style | Yes (Markdown, AsciiDoc, reStructuredText, HTML, XML, Org)              | Go         | MIT          |

| textlint   | Yes (via JavaScript) | spelling, style | Yes (Markdown, AsciiDoc, reStructuredText, HTML, Re:VIEW)               | JavaScript | MIT          |

| RedPen     | Yes (via Java)       | spelling, style | Yes (Markdown, AsciiDoc, reStructuredText, Textile, Re:VIEW, and LaTeX) | Java       | Apache-2.0   |

| write-good | Yes (via JavaScript) | style           | No                                                                      | JavaScript | MIT          |

| proselint  | No                   | style           | No                                                                      | Python     | BSD 3-Clause |

| Joblint    | No                   | style           | No                                                                      | JavaScript | MIT          |

| alex       | No                   | style           | Yes (Markdown)                                                          | JavaScript | MIT          |



The exact definition of "Supports Markup" varies by tool but, in general, it means that the format is understood at a higher level than a regular plain-text file (for example, features like excluding code blocks from spell check).



Extensibility means that there's a built-in means of creating your own rules without modifying the original source code.



### Benchmarks



    

        

            

                

            

        

        

            

                

            

        

    

    

        

          This benchmark has all three tools configured to use their implementations of the write-good rule set and Unix-style output.

        

        This benchmark runs Vale's implementation of proselint's rule set against the original. Both tools are configured to use JSON output.

    

    

        

            

                

            

        

        

            

                

            

        

    

    

        

          This benchmark runs Vale's implementation of Joblint's rule set against the original. Both tools are configured to use JSON output.

        

        This benchmark has all three tools configured to perform only English spell checking using their default output styles.

    



All benchmarking was performed using the open-source [hyperfine](https://github.com/sharkdp/hyperfine) tool on a MacBook Pro (2.9 GHz Intel Core i7):



```

hyperfine --warmup 3 ''

```



The corpus IDs in the above plots—`gitlab` and `ydkjs`—correspond to the following files:



- A [snapshot](https://gitlab.com/gitlab-org/gitlab/-/tree/7d6a4025a0346f1f50d2825c85742e5a27b39a8b/doc) of GitLab's open-source documentation (1,500 Markdown files).



- A [chapter](https://raw.githubusercontent.com/getify/You-Dont-Know-JS/1st-ed/es6%20%26%20beyond/ch2.md) from the open-source book _You Don't Know JS_.



## :page_facing_up: License



[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B21090%2Fgithub.com%2Ferrata-ai%2Fvale.svg?type=large)](https://app.fossa.com/projects/custom%2B21090%2Fgithub.com%2Ferrata-ai%2Fvale?ref=badge_large)



[1]: https://www.digitalocean.com/open-source/credits-for-projects

[2]: https://studio.vale.sh/

[3]: https://appwrite.io/oss-fund

[4]: https://appwrite.io/

[5]: https://page.famewall.io/vale