beyondcode/laravel-prose-linter

Syntax-aware proofreading for your Laravel application.

Laravel Prose Linter

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.

Documentation

For installation instructions and usage and examples, please take a look at the official documentation.

System Requirements

This package requires PHP 8.0 or higher and Laravel 8 or higher.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Diana Scharf
• Marcel Pociot
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

laravel-prose-linter's Issues

Flatten translation arrays

At the moment the translations only can be linted in this form

return [
    'failed' => 'These credentials do not match our records.',
// etc.
];

If the array is deeper nested, as for example in the validation.php file, the texts get skipped at the moment.
ToDo: Integrate this in TranslationLinter::readTranslationArray() and add a proper error message for Vale::lintString().

Support Laravel 9

Describe the bug

Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires beyondcode/laravel-prose-linter ^2.0 -> satisfiable by beyondcode/laravel-prose-linter[v2.0.0].
    - beyondcode/laravel-prose-linter v2.0.0 requires illuminate/support ^8.0 -> found illuminate/support[v8.0.0, ..., 8.x-dev] but these were not loaded, likely because it conflicts with another require.

You can also try re-running composer require with an explicit version constraint, e.g. "composer require beyondcode/laravel-prose-linter:*" to figure out if any version is installable, or "composer require beyondcode/laravel-prose-linter:^2.1" if you know which you need.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

Executed command

• composer require beyondcode/laravel-prose-linter

System

• OS or Server Version: Mac OS Monterey
• PHP Version: 8.1
• Laravel Version: 9.3
• Package version: Latest

Unexpected error - blade views

Describe the bug
When running php artisan lint:blade I see an "Unexpected error" next to each blade file.

Executed command
php artisan lint:blade

CLI output

[a whole lot of views with the same error]

Invalid vale output.
(teamwork.index) Unexpected error.
Invalid vale output.
(teamwork.emails.invite) Unexpected error.
Invalid vale output.
(teamwork.edit) Unexpected error.
Invalid vale output.
367/367 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100% 1 sec(teamwork.create) Unexpected error.
Invalid vale output.

✅ No errors, warnings or suggestions found.
Applied styles: WriteGood, Vale
🏁 Finished linting in 1 seconds.

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots and further data
View are found a resources/views//.blade.php

System

• OS or Server Version MacOS
• PHP Version 7.4.21
• Laravel Version v8.51.0
• Package version dev-review

Additional context
The error doesn't arise when using lint:translation

Add Php requirements to documentation

If you install the package you will get:
composer require beyondcode/laravel-prose-linter

  Package beyondcode/laravel-prose-linter has a PHP requirement incompatible with your PHP version, PHP extensions and Composer version  

Php 8 is required to install this package.