Giter VIP home page Giter VIP logo

plugin-dev-tools's Introduction

plugin-dev-tools

Description

This tools provide fast ways to solve common plugin development issues.

Adding plugin-dev-tools to your plugin

  1. Add this repository to your composer file and run $ composer install
  2. Create a symlink $ ln -s vendor/shopware/plugin-dev-tools/psh.phar psh
  3. Go to vendor/shopware/plugin-dev-tools and run $ ./install.sh
  4. Go to your plugin-root and run $ ./psh

Warning

Add the psh symlink to your .sw-zip-blacklist to prevent releasing a dead symlink which would break shopware updates.

Commands

    docker:cleanup - Cleansup the shopware installation
    docker:destroy - Destorys all docker containers
    docker:init - Similar to local:init, builds shopware
    docker:ssh - Connect to your app docker container via ssh
    docker:start - Start docker containers
    docker:stop - Stops all docker containers
    docker:unit - Runs unit tests
    
    local:init - Prepares your shopware installation
    local:cleanup - Cleans up your shopware installation
    local:reinstall - Reinstalls the current plugin
    local:unit - Runs unit tests
    local:unit-coverage - Generates coverage to ~/plugin-coverage/{plugin-name}

Add custom plugin setups

Add a script to add a custom installation routine which will be executed by the plugin-dev-tools.

  • add a before_install_plugin.sh in your plugin root directory
  • chmod +x before_plugin_install.sh

Coverall support on travis

coveralls.io

  1. Create a build/logs/ directory in your plugin
  2. Execute your tests ./psh travis:unit-coveralls
  3. Add to the travis after_success this line ./psh travis:send-coverall-report to send the coverage report

Example

You can find an example here: https://github.com/shopwareLabs/SwagBackendOrder

plugin-dev-tools's People

Contributors

dennisgarding avatar hoelshare avatar janpietrzyk avatar mitelg avatar simonbaeumer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

plugin-dev-tools's Issues

docker:destroy removes all images on docker-host

In the docker:destroy script you are using following docker commands:
docker rm $(docker ps -a -q)
docker rmi --force $(docker images -q)

These commands remove all images on the docker host.

Development on Docker

At the moment there is only support for running tests inside a docker container. It should be also possibly to develop with these containers.

Support plugin compatibilities

A command is missing which can install another plugin a specific environment, i.e. if the plugin has compatibility tests.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.