generator-magetwo-code

Magento2 lightweight module skeleton creator

Usage no npm install needed!

<script type="module">
  import generatorMagetwoCode from 'https://cdn.skypack.dev/generator-magetwo-code';
</script>

README

generator-magetwo-code NPM version Build Status Dependency Status

What it does

This generator creates a simple, frontend oriented, barebone Magento2 module

Navigate into app/code/ and run yo magetwo-code or yo

:warning: If you add a remote URL when you are prompted, the generator will automatically init a new repo inside your module.

Headsup!

I made the generator with CodeKit in mind, so

  • .scss should be compiled to .css
  • example.source.js should be compiled/compressed to example.js (or whatever name you like)

CLI TREE

Installation

First, install Yeoman and generator-magetwo-code using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-magetwo-code

Then generate your new project:

yo magetwo-code

or simply write

yo

and select Magetwo Code

Updating

You can update by running yo and then selecting Update your generators

TODO

  • Add widget support
  • Add support for creating system config menus

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

License

Apache-2.0 © Alexandru (proatwork) Bangala