Blog Detail

26

Jul
Laravel Prose Linter - A Syntax-aware Proofreading Tool cover image

Laravel Prose Linter - A Syntax-aware Proofreading Tool

Laravel Prose Linter is a package that renders syntax-aware proofreading for your Laravel application. It assists you to polish the texts of your Laravel application. It will monitor your translations and even your blade templates for typos, slang and give suggestions for a more gratifying writing style depending on which prose style you choose.

Prose Linter utilizes 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 provide you a clean CLI tool to review your Laravel Translations and Blade templates for prose linting.

Installation

You can install this package via composer:

composer require beyondcode/laravel-prose-linter

If you wanted to customize the styles employed by the linter, You can publish the config and the style assets:

~ php artisan vendor:publish --tag=linting-config
~ php artisan vendor:publish --tag=linting-styles

Usage

These are the following commands provided by Laravel Prose Linter:

 // Lint blade templates
 php artisan lint:blade

 // Lint a single blade template
 php artisan lint:blade auth.login

 // Lint translations
 php artisan lint:translation

 //Lint specific translation namespace(s)
 php artisan lint:translation auth validation

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

use Beyondcode\LaravelProseLinter\Styles\WriteGood;
 use Beyondcode\LaravelProseLinter\Styles\Vale;

 /*
 * Customize the Vale styles used by the linter.
  */
 return [
 'styles' => [
     WriteGood::class,
    Vale::class
 ]
];

If you wanted to learn about this package, check out the Official Documentation for installation and usage instructions. You can check out the source code on GitHub.

Published at : 26-07-2021

Author : Rizwan Aslam
AUTHOR
Rizwan Aslam

I am a highly results-driven professional with 12+ years of collective experience in the grounds of web application development especially in laravel, native android application development in java, and desktop application development in the dot net framework. Now managing a team of expert developers at Codebrisk.

web application development client
web application development client
web application development client
web application development client
web application development client

Launch project