generator-ruvu

Ruvu Weaver

At this point, Ruvu Weaver is a boilerplate generator for JavaScript projects.

How does it work

First, you should create the templates that you want to have as a new feature. Then Ruvu will ask you for an API definition which is a JSON file (static file or URL response) of OpenAPI 3.1.0 standard. After that it will generate data layer codes according to the templates you have defined.

Instructions to run

Install the package using npm or yarn.

npm install generator-ruvu or yarn add generator-ruvu

Install yo globally

npm install -g yo

Now you can run the generator using the following command:

yo ruvu:feature /path/to/templates "your feature name" https://doc.url.docmain/

If yo did not detect the ruvu generator, use the npm link command.

HandleBars

You can use handlebars syntax for inserting variable names in file names or file contents.

For example, use {{ featureName }} for the feature name.

To get more familiar with HandleBars check the link below:

https://handlebarsjs.com/

Ruvu handlebars variables and helpers

featureName is the name of the feature that you have inserted in initial command.

forEachApi

forEachApi is an iterative helper that copies its inside block per each api call of your API definition.

forEachApi variables

route is the route of your API endpoint. method is the HTTP method of the endpoint. version is the version of API endpoint. name is the name that you can use for functions, action types, etc. parameters is an object including path for path parameters, query for query parmeters, all for both of these two, and allWithBody which also contains body variable for apiHandlers. requestBody is the object of request body. description is a text which describes your API endpoint.

String helpers

pascal for pascal case. capitalized to convert to uppercase and _ separated. kebab for kebabcase (Yum Yum!). camel for camelcase. urlFix gets route and query paramters and creates the url containing variables and query string parameters. noDot removes dots and end zeros from a version tag.