[feature] Improve readme to show use of property "related"

Hettomei commented 5 years ago

Hi,

I want to thank you @tpope because I use your plugins everyday for the last 5 years.

I just discovered that I can use some kind of rails quick jump (link being inside a view, and type Econtroller to open it s related controller) but on any project.

Can I open a pull request to improve the doc and explain what this config does with examples :

   \   "angular.json": {
   \     "src/app/*.component.html": {
   \       "type": "view",
   \       "alternate": "src/app/{}.component.spec.ts",
   \       "related": "src/app/{}.component.ts"
   \     },
   \     "src/app/*.component.ts": {
   \       "type": "component",
   \       "related": "src/app/{}.component.html"
   \     },
   \     "src/app/*.module.ts": {
   \       "type": "module",
   \       "related": "src/app/{}.component.ts"
   \     },
   \     "src/app/*.ts": {
   \       "alternate": "src/app/{}.spec.ts"
   \     },
   \     "src/app/*.spec.ts": {
   \       "alternate": "src/app/{}.ts",
   \       "type": "test"
   \     }
   \   }

What did you prefere :

add doc inside the readme
add doc inside the :help projectionnist
add doc inside the wiki (which is empty)
no pull request, every thing as been said somewhere

Thank you.

tpope commented 5 years ago

It's a bit longer than I'd like but I'm tempted to swap the Maven example out for yours. Is there something we could use for the "make" key? Or for "dispatch"?

lekemula commented 1 year ago

Would be great to see improvement in this part.

As a Vim newbie, I found it hard to understand its usage, and a bit confusing with the :R command from vim-rails plugin which is used to navigate related files.

Some other older issues that helped me understand it better were:

It would be nice to have more examples about it in README or :help and also explain the difference with "alternate" option.

Otherwise, loving this plugin. One of the main reasons to switch fully to Vim :)

tpope / vim-projectionist

[feature] Improve readme to show use of property "related" #133