Laravel Prose Linter

Packages

July 23rd, 2021

laravel-prose-linter.png

Laravel Prose Linter is a package that provides syntax-aware proofreading for your Laravel application:

The Laravel Prose Linter helps you to polish the texts of your Laravel application. Let it check your translations and even your blade templates for typos, slang and get suggestions for a better writing style depending on which prose style you choose.

Prose Linter uses a Golang binary called Vale, a command-line tool that brings code-like linting to prose. Vale is a valuable package by itself, and Prose Linter leverages it to give you a clean CLI tool to check your Laravel Translations and Blade templates for prose linting:

Laravel Prose Linter CLI Output Example

Here are the available commands provided by Laravel Prose Linter:

1# Lint blade templates
2php artisan lint:blade
3 
4# Lint a single blade template
5php artisan lint:blade auth.login
6 
7# Lint translations
8php artisan lint:translation
9 
10# Lint specific translation namespace(s)
11php artisan lint:translation auth validation

This package also comes with customizable style configuration, which you can configure via the config/linter.php file:

1use Beyondcode\LaravelProseLinter\Styles\WriteGood;
2use Beyondcode\LaravelProseLinter\Styles\Vale;
3 
4/*
5 * Customize the Vale styles used by the linter.
6 */
7return [
8 'styles' => [
9 WriteGood::class,
10 Vale::class
11 ]
12];

Check out the Vale Styles documentation for details on configuring styles to work with Vale. As you can see in the snippet above, Laravel Prose Linter comes with two default styles: write-good and vale.

To get started with this package, check out the official documentation for installation and usage instructions. You can check out the source code on GitHub.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.