Data

Tools

Indexes

Applications

Experiments

Awesome

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

https://github.com/itspriddle/vim-laravel-projections

Laravel + projectionist.vim 🤝
https://github.com/itspriddle/vim-laravel-projections

laravel php vim

Last synced: about 1 year ago
JSON representation

Laravel + projectionist.vim 🤝

Awesome Lists containing this project

README 

          
# vim-laravel-projections



This plugin provides a set of commands and basic templates for working with

Laravel projects in Vim using [projectionist.vim][].



[projectionist.vim]: https://github.com/tpope/vim-projectionist



## Example Workflow



- Open `vim` in your Laravel project with no arguments.

- Open your `App\Models\User` model with `:Emodel U` (tab completing to `User`). Add a great new feature.

- Open the corresponding test file in a vertical split with `:AV`. Add a test for your new feature.

- Run the test file with `pest` using `:Make` (or better yet, `m`).

- Press `` to move back to the User model window.

- Open your `App\Http\Controllers\UserController` controller with `:Tcontroller`.

- Open the corresponding test file in a horizontal split with `:AS`.

- Run the test again with `m`.

- Start a Tinker console to diagnose some issues with `:Console`.

- Open your web routes file with `:Eroute`.

- Etc...



## Pre-requisites



- [projectionist.vim][] is required to use this plugin.

- [dispatch.vim][] is optional if you want to can be used to leverage

  `:Start`, `:Console`, `:Make` and `:Dispatch`.



Recommended, but not required:



- [composer.vim][] is recommended to use its built in support for `gf` and

  friends. It's not all all required to use the projections in this plugin.



[composer.vim]: https://github.com/noahfrederick/vim-composer

[dispatch.vim]: https://github.com/tpope/vim-dispatch



## Installation



Right now, I'm trying to avoid having this plugin do anything fancy. If you

want, you can just copy [laravel-projections.json][] to your

project at `.projections.json`.



If you are using [plug.vim][] or a similar plugin manager you can add this to

your `vimrc`:



```vim

Plug 'tpope/vim-projectionist'

Plug 'tpope/vim-dispatch' " optional, but recommended

Plug 'noahfrederick/vim-composer' " optional, but recommended

Plug 'itspriddle/vim-laravel-projections'

```



[laravel-projections.json]: https://raw.githubusercontent.com/itspriddle/vim-laravel-projections/refs/heads/main/plugin/laravel-projections.json

[plug.vim]: https://github.com/junegunn/vim-plug



## Commands



### Base Commands



- `:Console` - Open the tinker console. Requires dispatch.vim.

- `:Start` - Open the tinker console. Requires dispatch.vim. _This isn't

  locked in. I might use it for `composer dev`._



### Entity Commands



"Entities" are basically anything under `app/` and a few others. Pretty much

everything that there's a `php artisan make:*` command is here.



If you're unfamiliar with projectionist, it sets up Vim commands based on the

file path. This means that we can run things like `:Emodel User` to open

`app/Models/User.php`. It works with tab completion, so you can type

`:Emodel U` to complete to `:Emodel User`. And when you're in other

related files, like `app/Models/UserFactory.php`, you can run `:Emodel` to

jump to `app/Models/User.php`.



In addition to `:Emodel User` to `:edit app/Models/User.php`, we can also do:



- `:Smodel User` will `:split app/Models/User.php` in a vertical split

- `:Vmodel User` will `:vsplit app/Models/User.php` in a vertical split

- `:Tmodel User` will `:tabedit app/Models/User.php` in a new tab

- `:Dmodel User` will `:read app/Models/User.php` the template for the model

  (defined by this plugin) and replace the current buffer's contents with it

- `:Omodel User` will `:drop app/Models/User.php`, which opens the file in any

  window it's already opened in



These commands all have the following variants:



- `:E*` - `:edit` the destination file

- `:S*` - `:split` the destination file

- `:V*` - `:vsplit` the destination file

- `:T*` - `:tabedit` the destination file

- `:D*` - `:read` the destination file

- `:O*` - `:drop` the destination file



The list of commands is as follows:



- `:Eaction ` - Open the given action.

- `:Ebroadcast ` - Open the given broadcast.

- `:Ecast ` - Open the given cast.

- `:Ecommand ` - Open the given console command.

- `:Ecomposer` - Open `composer.json`.

    - Call `:Make` while editing `composer.json` or `composer.lock` to run

      `composer install` via Dispatch.

- `:Econfig [arg]` - Open the given configuration file. With no argument

  provided, opens `config/app.php`.

- `:Econtroller ` - Open the given controller.

- `:Ecss [arg]` - Open the given CSS file. With no argument provided, opens

  `resources/css/app.css`.

- `:Edoc [arg]` - Open the documentation file. With no argument provided,

  opens `README.md`.

- `:Edotenv [arg]` - Open the dotenv file for the given environment. With no

  argument provided, opens `.env`.

- `:Eenum ` - Open the given enum.

- `:Eevent ` - Open the given event.

- `:Eexception ` - Open the given exception.

- `:Efacade ` - Open the given facade.

- `:Efactory ` - Open the given factory.

- `:Ejob ` - Open the given job.

- `:Ejs [arg]` - Open the given JavaScript file. With no argument provided,

  opens `resources/js/app.js`.

- `:Elang ` - Open the given language file.

- `:Elistener ` - Open the given listener.

- `:Elivewire ` - Open the given Livewire component.

- `:Elog ` - Open the given log file.

- `:Email ` - Open the given mail.

- `:Emiddleware ` - Open the given middleware.

- `:Emigration ` - Open the given DB migration.

    - Call `:Make` while editing a migration file to run `php artisan migrate`

      via Dispatch for that specific migration.

    - Call `:Dispatch` while editing a migration file to run `php artisan

      migrate` via Dispatch for all migrations.

- `:Emodel [arg]` - Open the given model.

    - Call `:Emodel` without arguments from inside a factory, seeder,

      observer, policy, or Unit test to open the model for the current file.

- `:Enotification ` - Open the given notification.

- `:Enpm ` - Open NPM `package.json` file.

    - Call `:Make` while editing `package.json` or `package-lock.json` to run

      `npm install` via Dispatch.

- `:Eobserver ` - Open the given observer.

- `:Epolicy ` - Open the given policy.

- `:Eprovider [arg]` - Open the given provider. With no argument provided,

  opens `AppServiceProvider`.

- `:Erepository ` - Open the given repository.

- `:Erequest ` - Open the given form request.

- `:Eresource ` - Open the given API resource.

- `:Eresponse ` - Open the given HTTP response.

- `:Eroute [arg]` - Open the given route file. With no argument provided,

  opens `web`.

- `:Erule ` - Open the given rule.

- `:Escope ` - Open the given scope.

- `:Escript ` - Open the given script.

- `:Eseeder [arg]` - Open the given seeder. With no argument provided, opens

  `DatabaseSeeder`.

    - Call `:Make` while editing a seeder file to run `php artisan db:seed`

      via Dispatch for that specific seeder.

    - Call `:Dispatch` while editing a seeder file to run `php artisan seed`

      via Dispatch for the default `DatabaseSeeder`.

- `:Eservice ` - Open the given service.

- `:Etailwind` - Open the Tailwind CSS configuration file.

- `:Etest ` - Open the given test.

    - Call `:Dispatch` or `:Make` while editing a test file to run the test

      with `php artisan test {file}` via Dispatch.

- `:Etrait ` - Open the given trait.

- `:Eview ` - Open the given view.

- `:Evite` - Open the Vite configuration file.

    - Run `:Make` while editing `vite.config.js` to run `npm run build` via

      Dispatch.

    - Run `:Start` while editing `vite.config.js` to run `npx run dev` via

      Dispatch.

- `:Eworkflow [arg]` - Open the given GitHub workflow. With no argument

  provided, opens `.github/workflows/ci.yml`.



## Alternate Files



Alternate files allow you to use `:A` to switch between the main file and an

alternate. A common use case is to switch between a class and its test file.



- `app/*.php` - Open the corresponding test file under `tests/Feature/` or

  `tests/Unit/`.

- `tests/{Feature,Unit}/*Test.php` - Open the corresponding class file under

  `app/`.

- `routes/web.php` - Open the API route file (`routes/api.php`).

- `.env` - Open the `.env.example` file.

    - `.env.example` - Open the `.env` file.

- `composer.json` - Open `composer.lock`.

    - `composer.lock` - Open `composer.json`.

- `package.json` - Open `package-lock.json`.

    - `package-lock.json` - Open `package.json`.



This also lets you access `:E*` projection commands for the alternate file.



For example, if you are editing `app/Models/User.php`, you can use `:Etest` to

switch to `tests/Feature/Models/UserTest.php`; from in `UserTest.php`, you can

use `:Emodel` to switch back to `app/Models/User.php`.



- `app/*.php`:

    - `:Etest`

- `app/Models/`:

    - `:Efactory`

    - `:Eseeder`

    - `:Eobserver`

    - `:Epolicy`



## Templates



A few templates are provided for creating new files through Projectionist.

That happens when you use an `:E*` command for a file that doesn't exist yet,

or use `:A` to switch to a non-existent alternate file. If you manually create

a file, you can run `:AD` to replace the buffer contents with the new file

template.



By default, `*.php` files will just contain a `declare(strict_types=1);`

statement at the top.



Files under `app/*.php` will also include a namespace declaration based on the

file path. For example, creating a new file `app/Models/User.php` will include

the line `namespace App\Models;`.



## License



MIT License - see [`LICENSE`](./LICENSE) in this repo.