generator-express-component
Generate various express components for Yeoman generated apps.
Getting Started
Install yo
$ npm install -g yo
Install generator-express-component
To install generator-express-component from npm, run:
$ npm install -g generator-express-component
Initialize the generator
In your application folder run the following:
$ yo express-component
You will be promted for the various configurations values needed to generate express components.
Configuration:
--skip-message # Suppress generator messages Default: false
--force-config # Force overwritting of previous config values Default: false
--use-defaults # Skip all prompts and use defaults
--route-use-defaults # Skip all route prompts and use defaults
--controller-use-defaults # Skip all controller prompts and use defaults
Also you can pass any sub-generator configuration option to use that value instead of being prompted.
Usage
generator-express-component can generate various express components for your application. It does this through composable sub-generators that can be swapped in and out to customize your components however you like.
Sub-Generators
Route
Generate an express route file, optionally have it registered in the main express app/router file.
Example:
yo express-component:route thing? What will the url of your endpoint be?
Produces:
server/api/thing/index.js
Configuration:
--route-path # Path to use for the route
--route-register # Whether or not to register the route
--route-haystack # Path to file that the route will be registered in
--route-needle # String in file to register the route below
--route-express # The variable name of express in the registered file
--route-url # Default url for routes
--route-template # Path to the route template
Controller
Generate an express route controller file, optionally have it required in a corresponding route file.
Example:
yo express-component:controller thing
Produces:
server/api/thing/thing.controller.js
Configuration:
--controller-path # Path to use for the controller
--controller-register # Whether or not to register the controller
--controller-haystack # Path to file that the controller will be registered in
--controller-needle # String in file to register the controller below
--controller-name # Default variable name for the controller in registered file
--controller-template # Path to the controller template
Endpoint
A hookFor
express-component:route
and express-component:controller
by default.
Example:
yo express-component:endpoint thing? What will the url of your endpoint be?
Produces:
server/api/thing/index.js
server/api/thing/thing.controller.js
Configuration:
--express-component:route # express-component:route to be invoked
--express-component:controller # express-component:controller to be invoked