cybercog / laravel-whoops-editor

Laravel Whoops Editor helps to open your code editor from exception stack trace.

Laravel Whoops Editor

Introduction

Laravel Whoops Editor helps to open your code editor from exception stack trace. Go to code editor in a blink of an eye!

This feature was introduced in Laravel 5.5.25, but unfortunately has issues on Linux machines. Laravel Whoops Editor fixes PHPStorm, IDEA and SublimeText Linux support.

Additionally allows you to open editor when using Homestead.

For Atom support you can use Mike Bronner's laravel-whoops-atom package or publish config and specify launch path in editors config section.

Contents

• Features
• Requirements
• Installation
• Configuration
• Usage
  • Protocol Handlers
• Change log
• Contributing
• Testing
• Security
• Contributors
• Alternatives
• License
• About CyberCog

Features

• PHPStorm cross-platform support.
• IDEA cross-platform support.
• Sublime cross-platform support.
• Allow opening code editor when using Homestead.
• Following PHP Standard Recommendations:
  • PSR-1 (Basic Coding Standard).
  • PSR-2 (Coding Style Guide).
  • PSR-4 (Autoloading Standard).
• Covered with unit tests.

Requirements

• PHP >= 7.0.0
• Laravel >= 5.5.25

Installation

First, pull in the package through Composer:

$ composer require cybercog/laravel-whoops-editor --dev

Configuration

Package designed to work right out of the box, but you could publish configuration file to tweak settings:

$ php artisan vendor:publish --provider="Cog\Laravel\WhoopsEditor\Providers\WhoopsEditorServiceProvider" --tag="config"

Usage

Specify your editor by adding APP_EDITOR=phpstorm in .env file.

Optionally you can specify editor by adding editor key to the ./config/app.php configuration file.

'editor' => 'phpstorm',

This package provides extended Linux support for editors: phpstorm, idea, sublime.

Complete list of supported editors could be found in Whoops documentation.

Protocol Handlers

If your OS trying to open file in web browser instead of code editor you should install Protocol Handler.

Editor	Protocol	Linux	MacOS	Windows
SublimeText	subl://	thecotne/subl-protocol	-	-
Atom	atm://	eclemens/atom-url-handler	WizardOfOgz/atom-handler	-

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Testing

Run the tests with:

$ vendor/bin/phpunit

Security

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

Contributors

Anton Komarev

Laravel Whoops Editor contributors list

Alternatives

• GeneaLabs/laravel-whoops-atom

License

• Laravel Whoops Editor package is open-sourced software licensed under the MIT License by Anton Komarev.
• Error In Document image licensed under Creative Commons 3.0 by Kid A.

About CyberCog

CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.

• Follow us on Twitter
• Read our articles on Medium

laravel-whoops-editor's Issues

typo `vargant` -> `vagrant`

[Request] Atom Support

Any idea if we can support Atom, I took a look but didn't find any atom:// helper available

can add vsc support

Any idea if we can support visual studio code,

[Request] Variable project path

Thanks for setting up the Linux support, I appreciate it.

I am having trouble however, opening phpstorm since the filename it tries to open doesnt exist on my machine. I use a Docker container for my development environment and the "open" url refers to the virtual filesystem, not to the one on my host machine.

Is there a way of setting the project path so I can map it to my host machine?

Thanks!

can't cache config

This is related to using a closure in this function

$this->overwriteAppEditor(function ($filePath, $line) use ($editorConfig) {
            $filePath = $this->resolveFilePath($filePath);

            if (is_string($editorConfig)) {
                return $this->buildUri($editorConfig, $filePath, $line);
            }

            $editorConfig['url'] = $this->buildUri($editorConfig['url'], $filePath, $line);

            return $editorConfig;
        });