Tinkerun for Visual Studio Code

The missing way of running tinker in Visual Studio Code, inspired by Tinkerwell.

🗒 Looking for the 👉 Tinkerun Desktop App?

Features

• 🪶 write with typescript only
• 🖖 never leave VSCode
• 🚀 speed in docker, ssh
• 🥶 deadly simple, you are just creating the PHP files
• 📄 Form Mode

If you are creating awesome Laravel project with VSCode, you will never miss it.

Quick Start

👋 Welcome! Let's start running tinker in Visual Studio Code.

Step 1

Install the extension

Step 2

Press CMD+Shift+p then select Tinkerun: install to active the extension to your Laravel project.

The Tinkerun: install command will create a .tinkerun folder in your project.

├── .tinkerun
│   ├── inspiring.php // the example code to run
│   ├── tinkerun.json  // the tinkerun config file

Step 3

Open the file .tinkerun/inspiring.php, you will see a green ▶️ play button in the upper right corner. Press it.

The play button read the config from .tinkerun/tinkerun.json, and open a tinker process with the config, then simulate to input the code from .tinkerun/inspiring.php.

You are ready to Go :-) 🎉 🎉 🎉

Create PHP files in the .tinkerun folder, and run it via green play button or shortcut CTRL+r

tinkerun.json

You can create lots of connections

{
  "connections": [
	// default connection config
    {
      "name": "dev",
      "command": "php artisan tinker"
    },
	// you can also connect docker
	{
      "name": "docker",
      "command": "sail tinker"
    },
	// and connect your ssh server
	{
	  "name": "tinke.run",
      "command": "ssh deloyer@tinke.run -t 'cd /var/www/tinke.run/current && php artisan tinker;bash --login'"
	}
  ]
}

then when you are running the PHP file under .tinkerun folder. You will Pick a connection to run at first time.

Troubleshooting

How to change the default shortcut to run code

The default shortcut is CTRL+r, also you can bind yours:

1. open Code -> Preferences -> Keyboard Shortcuts
2. search tinkerun.run command
3. bind your favorite shortcut

How to hand back to Tinker after running code

Press Enter in the Tinkerun result panel, and your missing Tinker back.

Support for WSL

Add support for WSL, please add export TERM=xterm to commands in .tinkerun/tinkerun.json.

For example :

{
  "connections": [
    {
      "name": "dev",
      "command": "export TERM=xterm && php artisan tinker"
    }
  ]
}

Ask for help

If the troubleshooting guides did not resolve the issue, please reach out to me by filing an issue, starting a GitHub discussion

License

MIT