wileespaghetti / intellij-warden

IntelliJ integration for the Warden orchestration tool

intellij-warden

This plugin provides support for the Warden orchestration tool in PhpStorm and IntelliJ

Getting Started

Once stable, a public release will be made to the JetBrains Plugin Repository. For now you must install from one of the Jar files that are on the Releases page.

Installing

To install:

• Download the latest jar file
• Open the Settings/Preferences dialog
• Select Plugins
• On the Plugins page, click The Settings button and then click Install Plugin from Disk.
• Select the plugin archive file and click OK.
• Click OK to apply the changes and restart the IDE

Features

This project is still in the very early stages

Current

• Adds the "Warden" module type that can be selected when you create a new project
• Runs warden env-init to bootstrap the project
  • currently hard codes environment settings

Planned

• Allow selecting the magento1, magento2, and laraval project types
• Allow Warden environment to be customized as part of the project creation process
• Integrate with the run configuration

Building

intellij-warden uses the standard Gradle build process.

Reporting issues

Please report any issues on https://github.com/WileESpaghetti/intellij-warden/issues

intellij-warden's Issues

add syntax highlighting for `.env`

Technically speaking, Warden's .env file is a shell script, but it would probably make more sense to highlight it more like Docker env files.

Since .env is not unique to Warden, so we should validate the file by verifying that it contains

WARDEN_ENV_NAME=
WARDEN_ENV_TYPE=

Configure remote PHP interpreter

The warden PHP container should be set up as a remote PHP interpreter.

setup remote interpreters

Project should set up to use the php interpreter from the docker container

Manage Warden services vai the services tools window

Should have a section in the services tools menu to manage things done with warden svc

detect warden updates

check for new warden releases and prompt for download

Show environment type in status bar

Show the Warden environment type in the status bar.

We probably want to just show an icon for the environment type with the proper name showing up on hover

Prompt for Blackfire settings

When creating a new project
I want to configure the settings for Blackfire

The new project wizard should display a checkbox for enabling Blackfire.
If selected then the wizard will add another step that shows the Warden Blackfire settings which will get filled in after the project's .env file is generated

If possible it would be nice to automatically fill in as many settings as possible if there is oauth or something similar

Configure xdebug

checkbox to prompt to setup xdebug
https://docs.warden.dev/configuration/xdebug.html#phpstorm

Environment name field should default to project name

When creating a project the Environment name field should default to being in sync with the project name field. If the user modifies the field then that synchronization will be broken. If the user clears the field or sets it to the same as the project name, then the synchronization will be restored

add Warden to `Tools` menu

Add a menu item under Tools for Warden

Acceptance Criteria

• Warden added as a menu item in the Tools menu
• Traefik sub menu opens https://traefik.warden.test/ in the user's default browser
• Portainer sub menu opens https://portainer.warden.test/ in the user's default browser
• dnsmasq sub menu opens https://dnsmasq.warden.test/ in the user's default browser
• mailhog sub menu opens https://mailhog..warden.test/ in the user's default browser
• Start global service runs warden svc up
• Start environment runs warden env start
• Stop environment runs warden env stop
• Destroy environment runs warden env down

Info Needed

Can URL for these can be hard-coded or if they are dependent on an .env file setting?

Should env start and env stop share a single menu entry that automatically detects state?

What is the difference between warden env up -d and warden env start?

Should we add a menu option for warden sync start?

• this is automatic on MacOS when using Warden versions later than 0.3.0

Create Run Configurations

run configurations for all of the warden up/warden start type stuff

https://docs.warden.dev/usage.html

Settings should respond to changes to `.env`

When a user updates Warden's .env file
Then related settings should update to reflect those changes.

Example: If you update TRAEFIK_DOMAIN then the web deployment's domain should update to the new domain.

We need to figure out a list of related items that would change

Download or install warden as a part of project initialization

The trend with intellij is to be able to download and install missing executables if they are not found

https://docs.warden.dev/installing.html

Service ToolWindow integration

Integration with the services tool window

• start/stop warden global services
• destroy/create environment
• link to containers in the docker service window
• links to open web pages in browser (phpmyadmin, portainer, etc.)

add description text about empty enivornment

if the environment field is empty then some text should show up below to inform the user that they will be prompted on create.

maybe have an environment for "prompt me..."?

need screenshot examples of how other plugins show this type of information

Prompt to create data source

The main project window should have a checkbox to enable automatically creating a new data source using the Warden database settings. If selected a new project level data source will be created.

I'm not sure if it would be beneficial to prompt for the data source name or other data source settings that are not a part of Warden

https://docs.warden.dev/configuration/database.html

Prompt to create database settings

The main project wizard page should show a checkbox to customize database settings. This will be displayed only if the environment type supports having a database.

If enabled a new wizard page will show up with the Warden Database Settings. These will be automatically filled in with the Warden defaults.

Go through Warden documentation and issues to find missing features

Search Warden documentation for missing features or ways to integrate PhpStorm and Warden.
https://docs.warden.dev/installing.html

Issues can also provide a good resource for places where integration would be beneficial

Detect projects using warden

When loading a project we should automatically detect if Warden is used

Possible detection methods

• .env file
• .warden/env file

prompt to pull docker images

might be beneficial to automatically pull the required docker images after creating the project to speed up the first start. needs to be done in the background to allow development

migrate old `.env` files

If I have an old .env file I should be able to migrate it to the .warden version.

When I open a project with an old environment file I should be prompted to update the environment file.

This might depend on a projects having a default warden version. There are probably other steps to add new features that got introduced in later version (new server containers, etc)

Command line tool support

Automatically add command line tool support to run various warden commands

• register warden with command line tool support (if command line tool plugin is installed)

https://www.jetbrains.com/help/idea/command-line-tool-support.html

Use Warden to create new project

Use Warden to initialize a new project

• Warden is a selectable type in the new project wizard
• Warden environment type is selectable
• WARDEN_ENV_NAME can be specified
• projects are initialized using warden env-init using the selected environment type and name

Initialize project using composer

some projects require you to run composer to initialize. It might be nice if this was done automatically after initializing warden

https://docs.warden.dev/environments/initializing.html

Initialize project using templates

There are some github project templates that are set up to use warden. We may want to give the option to select one of those to base our new project on.

https://docs.warden.dev/environments/types.html#environment-templates

Prompt for additional environment settings

Add other warden settings that you might want to customize

https://docs.warden.dev/environments/customizing.html

Add warden docker files to project scope

the warden docker-compose files should probably be added to the project scope so that warden can better integrate with the phpstorm docker plugin and services window and allow auto complete and navigation for custom docker-compose files (example: multiple domains - https://docs.warden.dev/configuration/multipledomains.html)