Aem-component-scaffolding NPM

aem-component-scaffolding

Node CLI for scaffolding AEM Components

IMPORTANT The package is under development

The below arguments are available when creating a new component:

Argument	Required	Example
--type	Yes	content
--title	Yes	My Component
--superType	No	core/components/content/title/v1/title
--componentGroup	No	My Project Components
--category	No	my.clientlibs

Getting Started: 1. Requires: Node ~v10.15.1 | NPM ~6.4.1

2. Add aem-component-scaffolder as dependency to your package.json file:

"devDependencies": {
    "aem-component-scaffolding": "^1.0.18"
}

3. Run Install: npm install --save-dev

4. Generate config file: scaffold init

Follow the prompts to generate config file or create your own and place it in the root of your project.

{
	"project": "AEM Rockstars",
	"directory": "aem-rockstars",
	"host": "localhost",
	"port": "4502",
	"username": "admin",
	"password": "admin"
}

Configuration Properties: Project - The human readable name of your project Directory - The name of the project folder within the /apps directory Host - The url to your local AEM instance Port - The port to your local AEM instance Username - The admin username to your local AEM instance Password - The admin password to your local AEM instance

Options: The sync argument will watch the filesystem for changes during the component scaffolding process and import changes into CRX. scaffold --type content --title my-component