generator-alfresco-common

Getting Started

What is generator-alfresco?

generator-alfresco is a yeoman generator for creating Alfresco SDK projects and subsequently for scaffolding a growing number of common extension points.

What is this project for?

In this project, we have broken out a bunch of common helper modules that were originally embedded in the generator-alfresco project. By breaking these out, we make them easier to consume for other projects. We also simplify testing for the main project. Following is a summary of the modules included here:

alfresco-module-registry

Helpers for managing a list of modules that have been applied to one of our projects in the .yo-rc.json file. We use this to keep track of if modules are amps or jars, if they are local or remote, etc.

constants

Constants used by our generators.

dependency-versions

Code that allows us to detect the version of Maven and Java on a machine. We use this to block folks from creating an SDK project if said project will not run in the current environment.

general-utils

General utilities not provided by lodash.

generator-output

Some simple methods for logging consistently.

java-properties

Provides methods for reading, modifying and writing Java properties files. This is by no means a complete impelemntation of the properties file spect, but it's enough for our generators at this time.

maven-archetype-file-filtering

Given a file and an object with key/values, this goes through the file and replaces velocity style references to the given keys with the provided values.

maven-archetype-generate

Emulates mvn archetype:generate to the extent that we can create Alfresco All In One archetype projects from an exploded archetype jar file.

maven-archetype-metadata

Helps us read archetype-metadata.xml files used to describe how maven archetype jar files should be generated into real projects.

maven-archetype-path-filtering

Given a path and an object with key/values, this goes through the path and replaces __placeholder__ references to the given keys with the provided values.

maven-pom

Helpers for reading, modifying and writing Maven POM files.

mem-fs-utils

A few utilities that add to the mem-fs tool used by yeoman.

prompt-filters

Common filters for prompting.

prompt-validators

Common validators for prompting.

spring-context

Provides methods for reading, modifying and writing Springframework context files.

tomcat-context

Provides methods for reading, modifying and writing Tomcat context files.

xml-dom-utils

A few utilities that add to the xmldom module we use for XML handling.

Getting Help

If you find a bug or something is confusing, you can review existing or create a new issue. If you'd like to chat, you can reach out on our Gitter channel.

License

Apache 2.0