CreateBlockPlugin

A plugin for Magnolia CLI to create a block in a light module

Installation

Using add-plugin

1. Run the following command in the project's root directory:

   npm run mgnl -- add-plugin @magnolia/cli-create-block-plugin

   The command will install the plugin, and automatically register the plugin in mgnl.config.js file:

   import CreateBlockPlugin from "@magnolia/cli-create-block-plugin";
   
   export default {
     plugins: [
       new CreateBlockPlugin()
     ]
   };

2. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- create-block --help

Manually

1. Run the following command in the project's root directory:

   npm install @magnolia/cli-create-block-plugin

2. Manually add CreateBlockPlugin to mgnl.config.js file:

   import CreateBlockPlugin from "@magnolia/cli-create-block-plugin";
   
   export default {
     plugins: [
       new CreateBlockPlugin()
     ]
   };

3. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- create-block --help

Usage

Options

| Short | Long | Description | |--------------|--------------------------|---------------------------------------------------------------------------------------------------------------| | -lm [name] | --light-module [name] | set the light module for the block; defaults to the directory specified in mgnl.config.js file | | -pd <path> | --prototype-dir <path> | use the specified path to the custom prototype templates directory as the prototype source for block creation | | -p [name] | --prototype [name] | select a prototype for block creation | | -v | --version | output the version number | | -h | --help | display help for command |

Examples

Create block

npm run mgnl -- create-block "myFooBlock"

This commands creates a new block called "myFooBlock" based on "_default" prototype. If neither the lightModulesPath nor the lightModule property exists in mgnl.config.js, the plugin will prompt you to choose each.

Create block based on "empty" prototype

npm run mgnl -- create-block "myFooBlock" --prototype "empty"

This commands creates a new block called "myFooBlock" based on "empty" prototype. If neither the lightModulesPath nor the lightModule property exists in mgnl.config.js, the plugin will prompt you to choose each.

Plugin Documentation

For detailed documentation of the plugin, please refer to Plugin Documentation

Magnolia CMS

This plugin is created to work with Magnolia CMS. For more information, please refer to Magnolia CMS Documentation