https://github.com/vovayatsyuk/MagentoWorkflow

Blazing fast Magento 2 development in SublimeText 3/4
https://github.com/vovayatsyuk/MagentoWorkflow

magento2 magento2-development sublime-text-3 sublime-text-4

Last synced: about 2 months ago
JSON representation

Blazing fast Magento 2 development in SublimeText 3/4

• Host: GitHub
• URL: https://github.com/vovayatsyuk/MagentoWorkflow
• Owner: vovayatsyuk
• License: mit
• Created: 2014-10-17T09:22:35.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-06-11T09:24:13.000Z (4 months ago)
• Last Synced: 2024-06-11T10:53:34.084Z (4 months ago)
• Topics: magento2, magento2-development, sublime-text-3, sublime-text-4
• Language: Python
• Homepage:
• Size: 192 KB
• Stars: 16
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - MagentoWorkflow - Blazing fast Magento 2 development in SublimeText 3/4 (Python)

README

        
# MagentoWorkflow

**MagentoWorkflow** — is a SublimeText 3 plugin that allows to work on Magento

module or theme with enabled cache and forget about cache clean and outdated

generated code. Additionally, it takes care about file sync into docker

environment. This approach results in drastically improved Magento performance,

which means faster and enjoyable development.

## Installation

> Windows is not supported. PR are welcome.

 1. Run “Package Control: Install Package” command

 2. Type `MagentoWorkflow` and press Enter

## How it Works

When you save some file, MagentoWorkflow plugin automatically cleanup appropriate

generated files, and triggers cache invalidation. Plugin knows when, where, and

what to clear.

You will always see when the plugin do something. It reports about its processes

in Sublime's status bar.

## Commands

Pulled a lot of changes from remote repository? We've got your back!

Press ⌘⇧P and use MagentoWorkflow commands:

 -  Wipe All - Cleanup all resources and flush cache storage

 -  Clear Cache - Cleanup selected magento cache

 -  Flush Cache - Flush cache storage

 -  Theme Clear - Cleanup theme resources (js, css)

 -  Module Clear - Cleanup module resources (js, css, php)

## Docker

Module automatically discovers if you are using docker and run

commands in appropriate container. Additionally, when docker is detected,

module will sync changes from `vendor` folder into the docker.

Tested with:

 -  [markshust/docker-magento](https://github.com/markshust/docker-magento)

 -  [mage2click/docker-magento-mutagen](https://github.com/mage2click/docker-magento-mutagen)

## Configuration

**No configuration is required.** Just install the module and it's ready!

While you don't need to change anything to work with MagentoWorkflow, sometimes

to may need to tune some option.

Option Name         | Default Value                     | Description

--------------------|-----------------------------------|-------------------------------------------

bin_magento_command | `bin/magento`                     | Command to run bin/magento.

resources           | `["css_module", "css_theme", "requirejs", "translation", "generated"]` | The list of resources to clean when needed.

service             | `EMPTY`                           | Docker service name. Autodetected.

cmd_prefix          | `docker-compose exec -T {service}`| Prefix to add to every terminal command. Service is taken from service option.

sync_command        | `docker cp {filepath} $(docker-compose ps -q {service}\|awk '{print $1}'):/var/www/html/{filepath}` | A command that copies files from the host to docker container.

sync_folders        | `["/vendor/"]`                    | Sync files from host to docker from these folders.

## Snippets

Previous version of this plugin had some useful snippets. Now, they've been

moved to [MagicTemplates](https://github.com/vovayatsyuk/sublime-magic-templates)

plugin.