@aem-kit/generators

Code generators for AEM projects — the engine behind aem component, aem model, aem servlet, and aem service. Each generator writes idiomatic HTL / Java / dialog XML plus a JUnit5 + AEM-Mock test, and is non-destructive (existing files are skipped unless --force).

Part of the AEM Enterprise Engineering Kit.

Usage

Normally invoked through aem-kit (aem component HeroBanner). Programmatic use:

import { generators, listGenerators } from "@aem-kit/generators";

await generators.component.run({
  name: "Hero Banner",
  projectRoot: "/path/to/project",
  config: { appId: "acmesite", package: "com.acme.site" },
  force: false,
});

Generators

| Command | Output | |---------|--------| | component | HTL + Sling Model + _cq_dialog + test | | model | Sling Model (adaptable from Resource) + test | | servlet | SlingSafeMethodsServlet (path-based) + test | | service | interface + impl + @ObjectClassDefinition config + test |

scheduler, workflow, listener, filter, clientlib, template, dialog, and policy are registered as planned stubs.

Related packages

| Package | Purpose | |---------|---------| | @aem-kit/create-project | Scaffold a new AEM project | | aem-kit | The aem CLI (drives these generators) | | @aem-kit/generators | Code generators (this package) | | @aem-kit/templates | AEM project templates (Monolith, Multi-repo, React, Angular, Spring Boot) | | @aem-kit/shared | Shared utilities |

License

MIT