@hrwg/swag

Shopware Advanced Generator

Shopware Advanced Generator (swag) is a scaffolding CLI that helps you to created plugins, themes and other pieces of code, such as CMS blocks and elements.

It is designed to work with Shopware 6.

Disclaimer

This is a community project and not officially supported by Shopware.

Table of Contents

• Requirements
• Installation
• Available Commands
  • Plugins
    • Create
• Testing
• Contributing
• Changelog
• License

Requirements

• NodeJS >= 10

Installation

Install the CLI by executing the following command in a root environment:

$ npm -g @hrwg/swag

Available Commands

To get a list of all available commands, use the following command:

$ swag --help

Plugins

The following commands are used to work with Shopware 6 plugins.

Create

In order to create a new plugin, execute the following command from your projects root directory (the directory that contains the custom/plugins):

$ swag plugin:create

This will guide you through an inquiry that will query all the required details for creating a plugin.

After the command finishes, your new plugin will be created in the custom/plugins directory and is ready for installation/activation.

CMS Blocks

The following commands are used to work with Shopware 6 CMS blocks.

Create

In order to create a new CMS block, execute the following command from your plugin's root directory.

$ swag cms:block:create

This will guide you through an inquiry that will query all the required details for creating a CMS block.

After the command finishes, your new block will be created within your plugin's directory.

Important

To make the CMS element work, you have to include it in your src/Resources/app/administration/src/main.js file and execute an administration build. This is not done automatically at the moment.

Testing

Unit tests are powered by Jest and can be run after cloning the repository:

$ npm ci
$ npm t

Contributing

Feel free to contribute to this project by submitting a document pull-requests that passes existing tests.

Changelog

For a detailed changelog, refer to the CHANGELOG.md.

License

MIT