nuxeo/generator repository overview

⁠About

Yeoman Generator for Nuxeo Platform

The generator-nuxeo provides Nuxeo components scaffolding. It lets you easily scaffold common Nuxeo components like empty projects, Nuxeo Packages, Automation Operations, Nuxeo Services... This saves you time writing boilerplate code to focus on your code instead of the structure.

The generated components all come with unit tested sample code; for instance the Operation generator adds an Operation with some sample code that highlights how to inject context objects, how to specify a parameter and how to unit test that operation.

That tool is based on Yeoman⁠ (a scaffolding tool for the web).

⁠Features

• Discover some sample Nuxeo Projects.
• Bootstrap an empty Nuxeo Project with multi modules support.
• Bootstrap a single empty Nuxeo Project.
• Add a Nuxeo Package module to distribute your Project (Marketplace⁠)
• Add a ready-to-use empty Polymer⁠ Application.
• Create your own business rules or logic as an Automation Operation⁠.
• Enrich REST API responses using a content-enricher⁠.
• Manipulate Business Object using a Document Adapter
• Declare your new Nuxeo Service⁠
• Plug your logic to the event bus using an Event Listener⁠

⁠Incoming Features

• Functional Testing module
• Angular2 Empty Application
• REST endpoint
• Scheduler / Worker
• Blob Provider
• ...

⁠Supported Nuxeo Platform Versions

• Nuxeo Platform 7.10 and newer
• If you are using Nuxeo Platform 5.8 or 6.0, code templates are available in Nuxeo IDE⁠ using the Nuxeo wizard⁠.

⁠Docker

Check the nuxeo/generator Docker Hub page⁠.

⁠Usage

Docker equivalent of yo nuxeo

docker run -ti --rm -v "`pwd`:/workdir" nuxeo/generator nuxeo

Docker equivalent of yo nuxeo:sample

docker run -ti --rm -v "`pwd`:/workdir" nuxeo/generator nuxeo:sample

Those commands could be embedded in a local script to ease them.

⁠Quickstart

⁠Discover Sample projects

Using the generator let you have access to some ready to use Nuxeo Code Sample:

yo nuxeo:sample

⁠Bootstrap an Empty Nuxeo Project with Multi Modules Support

To bootstrap an empty Nuxeo Project (based on a Maven multi-module project), execute the following lines:

mkdir my-project
cd my-project
yo nuxeo

Default values are fine for a quick start. You will have to specify at least your project group ID (for instance org.company.)

⁠Usage

You can generate several features at once like:

yo nuxeo [options] [<generator>..]

⁠Options

-h,   --help          # Print the generator's options and usage
      --skip-cache    # Do not remember prompt answers                         Default: false
      --skip-install  # Do not automatically install dependencies              Default: false
-n,   --meta          # Branch of `nuxeo/generator-nuxeo-meta`                 Default: stable
-l,   --localPath     # Path to a local clone of `nuxeo/generator-nuxeo-meta`
-n,   --nologo        # Disable welcome logo                                   Default: false
-t,   --type          # Set module target's type                               Default: core

⁠Available Generators

The main Generator can render templates defined in https://github.com/nuxeo/generator-nuxeo-meta/⁠.

⁠Discover Sample Projects

To select a sample project that lets you know how a feature is built.

yo nuxeo:sample

⁠Bootstrap an Empty Nuxeo Project with Multi Modules

Set up an empty Nuxeo Bundle using Maven multi module support.

yo nuxeo multi-module

multi-module is the default generator when none is given as a parameter to yo nuxeo

⁠Parameters:

• Use a parent artifact: Parent artifact makes your project inherit dependencies, properties and other fields from another project. We recommend to keep the default value and use org.nuxeo.ecm.distribution:nuxeo-distribution.
• Nuxeo Version: Asked only if no parent specified, it specify which Nuxeo version of the dependency management will be imported.

⁠Important Notes

Using a Maven multi module architecture is the recommended way to bootstrap a new project: it allows to generate a Nuxeo Package afterwards to easily deploy your code on a Nuxeo Platform instance. On the other hand, when a project has been generated using a single module architecture, the Nuxeo Package needs to be created manually.

⁠Bootstrap a Single Empty Nuxeo Project

Sets up an empty Nuxeo project.

yo nuxeo single-module

⁠Parameters:

• Parent Group / Artifact: Like in multi-module, having a parent artifact make project inheritance. If you are in a multi-module, you must set your parent module. If not, you can use org.nuxeo.ecm.distribution:nuxeo-distribution or org.nuxeo:nuxeo-addons-parent
• Nuxeo Version: Asked only if needed, it specify which Nuxeo version of the dependency management will be imported.

⁠Important Notes

This option should not be called directly to bootstrap a new project; use the multi-module option instead so that you can generate a Nuxeo Package later on.

⁠Create Your Own Business Rules or Logic - Automation Operation

Adds an empty Automation Operation⁠ along with a corresponding unit test.

yo nuxeo operation

⁠Create an Event Bus Listener

Adds a listener⁠ with its test class, the events will be asked during the generation process. Both existing and custom events can be declared. You can create any listener type: pre-commit, post-commit, synchronous and asynchronous.

yo nuxeo listener

⁠Parameters:

• Trigger on events: List of some common events to bind to your listener.
• Custom Events: In case you select 'custom events' in the previous list; comma separate list of other events.
• Asynchronous Listener: if you need to run after the transaction has committed, in a new transaction and a separate thread. This is useful for any long-running operations whose result doesn't have to be seen immediately in the user interface.
• Post-commit Listener: if you need to run after the transaction has committed, in a new transaction but in the same thread, this is useful for logging.

⁠Create a Service

Adds a Nuxeo component⁠ exposed as a Nuxeo service.

yo nuxeo service

⁠Create a REST API Response Enricher

Creates a Content Enricher⁠ that enriches with more information a REST response.

yo nuxeo enricher

⁠Create a Business Object - Document Adapter

Creates a Document Adapter that turn DocumentModel object into business objects.

yo nuxeo adapter

⁠Add an Empty Polymer Application

Creates an application based on Polymer Starter Kit⁠ bundled as a Nuxeo Project.

yo nuxeo polymer
cd *-web && npm install && bower install

# To run the application in dev mode; with file hot reload:
cd *-web && gulp serve

⁠Add a Nuxeo Package Module

Creates a module to handle a Nuxeo Package⁠ generation of your project. Can only be called in a Maven multi-module architecture, hence make sure to bootstrap your project using yo nuxeo or yo nuxeo multi-module. If you used yo nuxeo single-module to bootstrap your project, you won't be able to call that option afterwards.

yo nuxeo package

⁠Test locally the generator

To test the generator; you should clone the repository and link it to your local NPM registry:

git clone https://github.com/nuxeo/generator-nuxeo
cd generator-nuxeo
npm link

It will install dependencies and symlink the module to your local registry. After that, you can use the generator as described below.

⁠Licensing

Apache License, Version 2.0⁠

⁠About Nuxeo

Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com⁠.