Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introducing node.js to get all features demonstrated in the project. #24

Closed
wants to merge 7 commits into from
Closed

Introducing node.js to get all features demonstrated in the project. #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c4e3cbf
Introducing node.js to get all features demonstrated in the project.
AnselmHa Nov 5, 2019
114d0bc
Only keep renamed files for changed files. Unchanged files during gen…
AnselmHa Nov 6, 2019
3af2560
Only keep renamed files for changed files. Unchanged files during gen…
AnselmHa Nov 6, 2019
732277c
README and build adaption not focusing node.js.
AnselmHa Nov 8, 2019
aa3b5c2
Support custom sling:ResourceTypes e.g for richtext
AnselmHa Nov 9, 2019
43db9ba
Introducing templating functions in data-config.json
AnselmHa Nov 16, 2019
48e9260
Introducing templating functions in data-config.json
AnselmHa Nov 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,8 @@ buildNumber.properties
*.iml

### MacOS ###
.DS_Store
.DS_Store

# Dependency directories
node_modules/
jspm_packages/
127 changes: 49 additions & 78 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,93 +19,64 @@ Generated code includes:
- Includes the default WCM Core placeholder template for when the component is not yet configured
- Stubbed clientlib (JS/CSS) following component client library patterns of WCM Core

## How To Use

To see the AEM Component Generator in action,
[watch this video](https://s3.amazonaws.com/HS2Presentations/AEMPublic/2019-Adobe-AEM-Component-Code-Generator-Demo-Bounteous.mp4).
## AEM Component Generator in action,
[Watch this video](https://s3.amazonaws.com/HS2Presentations/AEMPublic/2019-Adobe-AEM-Component-Code-Generator-Demo-Bounteous.mp4).
Detailed steps for using the generator are found below.

Step 1: Clone the project from github.
### How to install and run

- First of all clone the project from github.
- Running `mvn clean install` from the main project folder.
- This generates `component-generator-N.N.jar`

> Experience AEM Component Generator with npm and node.js
- [Integration with node](doc/Integration-with-node.md)

Step 2: Update the demo config file (`data-config.json`) to your company defaults, removing references to `NewCo`/`newco`
in the `project-settings` and `group` values.
### How to customize generation

Step 3: Build the project by running `mvn clean install` from the main project folder.
[Explaining data-config.json](doc/Explaining-data-config.md)

Step 4: Copy the generated `component-generator-N.N.jar` file (under the `target` folder) to a location
### How to use in your AEM project

##### Step 1: Update the data-config file
- Copy data-config `src/main/resources/component-generator/data-config.json` to your project
- Adapt data-config to your company defaults, removing references to `NewCo`/`newco` in the `project-settings` and `group` values.

##### Step 2: Copy the component generator JAR
- Copy `target/component-generator-N.N.jar` file (under the `target` folder) to a location
from which you wish to generate AEM component code. Note that code will be generated at a relative path from which
the generator is executed, which can be different from where the jar file is located.

Step 5: Copy the `data-config.json` file from this project to the same location and update with relevant configs for
your component.

- `project-settings`: contains configuration options related to your AEM project
- `project-settings.code-owner`: the name of the company/user this code belongs to - will replace `${CODEOWNER}` in the template files with this configured value
- `project-settings.bundle-path`: path to the java code of your main bundle
- `project-settings.apps-path`: path to the `/apps` root
- `project-settings.component-path`: path to the project's components directory, relative to the `/apps` folder
- `project-settings.model-interface-pkg`: Java package for the interface model objects
- `project-settings.model-impl-pkg`: Java package for the implementation model objects
- `name`: folder name for the component
- `title`: human readable component name, also used as the title for dialogs
- `group`: component group
- `type`: component folder type - content, form, structure
- `options.js`: whether to create an empty JS lib for the component (shared with CSS lib)
- `options.jstxt`: whether to create the js.txt mapping file within the clientlib. Set to `false` when this file is not needed within your clientlib
- `options.css`: whether to create an empty CSS lib for the component (shared with JS lib)
- `options.csstxt`: whether to create the css.txt mapping file within the clientlib. Set to `false` when this file is not needed within your clientlib
- `options.html`: whether to create a default HTML file for the component
- `options.slingmodel`: whether to create a sling model for the component
- Class name is derived from converting "name" prop above to camel case (e.g. "google-maps" -> `GoogleMaps`/`GoogleMapsImpl`)
- Fields are derived from dialog properties (see below)
- `options.content-exporter`: whether to configure sling model for content export
- `options.model-adaptables`: array of adaptables to include in the Sling Model ('request' and/or 'resource')
- `options.generic-javadoc`: whether to create generic javadoc for the getters in the model interface
- `options.properties`: properties to create in standard dialog for this component. If empty, no standard dialog will be created. This sample includes one of every possible sling:resourceType
- `options.properties[].field`: the property "name" and java variable name.
- `options.properties[].javadoc`: the javadoc associated with the property
- `options.properties[].type`: the property field type
- `options.properties[].label`: the `fieldLabel` associated with the property
- `options.properties[].description`: the `fieldDescription` associated with the property
- `options.properties[].items`: any child items needed for the specified property type
- `options.properties[].attributes`: any additional attributes to be associated with property in `cq:dialog`
- `options.properties[].model-name`: **(Multifield type Only)** the name of the sling model class generated for a multifield property
- `options.properties[].use-existing-model`: **(Multifield type Only)** whether or not to generate a new sling model for the multifield property
- `options.properties[].json-expose`: by default, the content exporter will ignore all properties unless `json-expose` is set to `true`
- `options.properties[].json-property`: the json key for the property to be used when content export is configured
- `options.properties-shared`: properties to create in shared dialog for this component. If empty, no shared dialog will be created
- `options.properties-global`: properties to create in global dialog for this component. If empty, no global dialog will be created

Step 6: To generate a component, navigate to the main folder of your AEM project and execute the following command.
##### Step 3: To generate a component, navigate to the main folder of your AEM project and execute the following command.
Note that paths specified in `project-settings` configs (above) will be relative to this location.

```sh
$ java -jar <jarfile> <configfile>
```

- `jarfile`: path to `component-generator-N.N.jar` file (replacing `N.N` with the applicable numbers)
- `configfile`: path to `data-config.json` file

Example:
```sh
$ java -jar scripts/compgen/component-generator-1.0.jar scripts/compgen/data-config.json
```

Successful component generation should result in output similar to the following:
```
[17:57:50.427 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/.content.xml
[17:57:50.441 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/_cq_dialog/.content.xml
[17:57:50.443 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/dialogglobal/.content.xml
[17:57:50.446 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/dialogshared/.content.xml
[17:57:50.447 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/clientlibs/.content.xml
[17:57:50.453 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/clientlibs/site/css/demo-comp.less
[17:57:50.454 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/clientlibs/site/js/demo-comp.js
[17:57:50.456 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/demo-comp.html
[17:57:50.456 [INFO ] ComponentUtils @85] - --------------* Component 'demo-comp' successfully generated *--------------
[17:57:50.476 [INFO ] CommonUtils @93] - Created: core/src/main/java/com/newco/aem/base/core/models/DemoComp.java
[17:57:50.488 [INFO ] CommonUtils @93] - Created: core/src/main/java/com/newco/aem/base/core/models/impl/DemoCompImpl.java
[17:57:50.488 [INFO ] JavaCodeModel @103] - --------------* Sling Model successfully generated *--------------
```
```sh
$ java -jar <jarfile> <configfile>
```
- `jarfile`: pat```h to `component-generator-N.N.jar` file (replacing `N.N` with the applicable numbers)
- `configfile`: path to `data-config.json` file
Example:
```sh
$ java -jar target/component-generator-1.0.jar src/main/resources/component-generator/data-config.json
```
- Generates
- target/generated-sources/src/main/java
- target/generated-sources/ui.apps

Successful component generation should result in output similar to the following:
```
[17:57:50.427 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/.content.xml
[17:57:50.441 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/_cq_dialog/.content.xml
[17:57:50.443 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/dialogglobal/.content.xml
[17:57:50.446 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/dialogshared/.content.xml
[17:57:50.447 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/clientlibs/.content.xml
[17:57:50.453 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/clientlibs/site/css/demo-comp.less
[17:57:50.454 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/clientlibs/site/js/demo-comp.js
[17:57:50.456 [INFO ] CommonUtils @93] - Created: ui.apps/src/main/content/jcr_root/apps/newco/components/content/demo-comp/demo-comp.html
[17:57:50.456 [INFO ] ComponentUtils @85] - --------------* Component 'demo-comp' successfully generated *--------------
[17:57:50.476 [INFO ] CommonUtils @93] - Created: core/src/main/java/com/newco/aem/base/core/models/DemoComp.java
[17:57:50.488 [INFO ] CommonUtils @93] - Created: core/src/main/java/com/newco/aem/base/core/models/impl/DemoCompImpl.java
[17:57:50.488 [INFO ] JavaCodeModel @103] - --------------* Sling Model successfully generated *--------------
```

## Contributing

Expand Down
206 changes: 0 additions & 206 deletions data-config.json
View file
Open in desktop

This file was deleted.

Loading