Laravel Junie is a package that allows you to easily install pre-configured guideline documents for Jetbrains Junie
Laravel Junie is a package that allows you to easily install pre-configured guideline documents for Jetbrains Junie in your Laravel application. These guidelines can help your team maintain consistent coding standards and best practices.
The package provides a simple command-line interface to install various guideline documents, such as general coding standards, API development guidelines, Livewire best practices, and more.
You can install the package via composer:
composer require dcblogdev/laravel-junie
The package will automatically register its service provider.
To publish the configuration file, run:
php artisan vendor:publish --tag=config
This will create a junie.php
configuration file in your config
directory. You can customize the following options:
documents
: An array of available guideline documents, each with a name, enabled flag, and path.output_path
: The directory where the guideline documents will be installed (default: .junie
).Example configuration:
return [
'documents' => [
'general' => [
'name' => 'General guidelines',
'enabled' => true,
'path' => 'general.md',
],
// More documents...
],
'output_path' => '.junie',
];
You can enable or disable specific documents by setting the enabled
flag to true
or false
.
After installing the package, you can:
Install all guideline documents:
php artisan junie:install --all
Install specific guideline documents:
# Install specific guidelines
php artisan junie:install --general --testing
Use the interactive installation:
php artisan junie:install
This will prompt you to select which guidelines you want to install.
The package includes the following guideline documents:
There is a Discord community. https://discord.gg/VYau8hgwrm For quick help, ask questions in the appropriate channel.
Contributions are welcome! Please feel free to submit a Pull Request.
readme.md
and any other relevant documentation are kept up-to-date.