Yeoman Generator for Nuxeo Platform
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).
# Global NPM registry installnpm install -g yo generator-nuxeo
# Install from masternpm install -g yo nuxeo/generator-nuxeo
Using the generator let you have access to some ready to use Nuxeo Code Sample:
Using the generator let you trigger a Hot Reload on your Server which allows you to update the deployed bundles without restarting the Nuxeo Server. To be done, it requires to enable the
sdk template in your
First step is to associate a Nuxeo Server with your project root. It will ask you the distribution path and if you want to let the
generator-nuxeo configure the file for you. Reexecute it to change the distribution path.
yo nuxeo:hotreload configure
Then, you will be able to trigger it using:
To bootstrap an empty Nuxeo Project (based on a Maven multi-module project), execute the following lines:
mkdir my-projectcd my-projectyo nuxeo
Default values are fine for a quick start. You will have to specify at least your project group ID (for instance
You can generate several features at once like:
yo nuxeo [options] [<generator>..]
-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-m, --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-s, --skipInstall # Skip external commands installation Default: false-f, --force # Force conflict when generate an existing file Default: false-d, --dirname # Set parent folder prefix name Default: <PWD>
The main Generator can render templates defined in https://github.com/nuxeo/generator-nuxeo-meta/.
- ADD: Add a dedicated module to your project. For instance, in a
myappproject, a Polymer Application will add a
- CREATE: Create the files needed for the feature, without specifying a
--typeoption, the generation will occurs in the
myapp-coresubmodule. When using the
--typeoption, files will be generated to a (new) module named
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
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.
Sets up an empty Nuxeo project.
yo nuxeo single-module
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
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.
Adds an empty Automation Operation along with a corresponding unit test.
yo nuxeo operation
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
Adds a Nuxeo component exposed as a Nuxeo service.
yo nuxeo service
Creates a Content Enricher that enriches with more information a REST response.
yo nuxeo enricher
Creates a Document Adapter that turn
DocumentModel object into business objects.
yo nuxeo adapter
Add an application based on Polymer Starter Kit bundled as a Nuxeo Project.
yo nuxeo polymer# npm and bower install must be executed automatically, otherwise:# cd *-web && npm install && bower install# To run the application in dev mode; with file changes watch:cd *-web && npm run serve
Common bundle's files like
OSGI-INF/* are stored inside a
Add an application using Angular2 bundled as a Nuxeo Project.
yo nuxeo angular2# npm and bower install must be executed automatically, otherwise:# cd *-web && npm install && bower install# To run the application in dev mode; with file changes watch:cd *-web && npm run dev
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
To test the generator; you should clone the repository and link it to your local NPM registry:
git clonecd generator-nuxeonpm link
It will install dependencies and symlink the module to your local registry. After that, you can use the generator as described below.
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.