view-launcher

ViewLauncher

A tiny lib for inspecting and opening view files in your code editor from browsers directly.

Why

When you're working on a rather large project, you may have lots of views, whenever you want to make a change to a specific view, you have to figure out where it locates first.

Even if you just want to change a single letter of the view, you have to first find out the view, to me, this is super tedious and unproductive‼ Especially when collaborating with other people, chances are that you'll have a hard time finding the view file…

This package provides you a simple way to locate to the view file. Just click the HTML element from the browser, it'll jump to the view file in your code editor automagically.

Kind of like a "sourcemap of markup", helps you inspect your view at light speed ⚡⚡️️

Installation 📦

<script src="https://unpkg.com/view-launcher@latest/dist/index.js" defer></script>

For framework specific installation see:

• Laravel Blade
• Vue

Supported Editors

• sublime
• textmate
• emacs
• macvim
• phpstorm
• idea
• vscode
• vscode-insiders
• atom

How does it work?

This lib is going to retrieve the config object from window.viewLauncher immediately as soon as the script is loaded.

The interface of viewLauncher looks like this:

{
  "theme": "light",
  "editor": "phpstorm",
  "shortcuts": {
    "inspect": "a a",
    "open": "d"
  }
}

It'll find all the elements which has the data-tag-location attribute, make them inspectable via the viewLauncher.shortcuts.

The value of data-tag-location attribute looks like:

{
  "view": "/path/to/the/view/file",
  "line": 100,
  "column": 23
}

So the lib can use the information taken from data-tag-location to open the view file.