@kumori/generator-workspace NPM

Kumori Platform Yeoman Generators

This is a yeoman generator for the Kumori Platform.

Description

The generators included in this module can be directly used from yeoman or called as templates from Kumori CLI.

Installation

npm install -g @kumori/generator-workspace

Usage

The generators included in this module can be directly called using yo or installed in a Kumori's workspace using Kumori's CLI kumori.

For example, to creare a brand new workspace using yo:

$ yo @kumori/workspace

And using kumori:

$ kumori init -t @kumori/workspace

Or simply

$ kumori init

If init command uses the @kumori/workspace generator by default (see kumoriConfig.json file in your workspace).

As another example, to add a new basic nodejs component to your newly created workspace using yo:

$ mkdir -p component/kumori.systems/hello
$ cd component/kumori.systems/hello
$ yo @kumori/workspace:component-javascript
? Component name hello
? Company domain kumori.systems
    create package.json
    create Manifest.json
    create README.rst
    create jest.config.js
    create taskfile.js
    create lib/index.js
    create test/sample.jest.js

Or, much more simple, you can use the kumori CLI:

$ kumori component add hello -t @kumori/workspace:component-javascript
Adding component hello in kumori.systems using template @kumori/workspace:component-javascript
    create components/kumori.systems/hello/package.json
    create components/kumori.systems/hello/Manifest.json
    create components/kumori.systems/hello/README.rst
    create components/kumori.systems/hello/jest.config.js
    create components/kumori.systems/hello/taskfile.js
    create components/kumori.systems/hello/lib/index.js
    create components/kumori.systems/hello/test/sample.jest.js
Component eslap://kumori.systems/components/hello/0_0_1 created in ./components/kumori.systems/hello

Or, even more simply

$ kumori component add hello
Adding component hello in kumori.systems using template @kumori/workspace:component-javascript
    create components/kumori.systems/hello/package.json
    create components/kumori.systems/hello/Manifest.json
    create components/kumori.systems/hello/README.rst
    create components/kumori.systems/hello/jest.config.js
    create components/kumori.systems/hello/taskfile.js
    create components/kumori.systems/hello/lib/index.js
    create components/kumori.systems/hello/test/sample.jest.js
Component eslap://kumori.systems/components/hello/0_0_1 created in ./components/kumori.systems/hello

If component add command uses @kumori/workspace:component-javascript by default (see kumoriConfig.json file in your workspace).

This module includes the following generators:

@kumori/workspace: generates an empty workspace with a pre-filled kumoriConfig.json configuration file.
@kumori/workspace:component-express: generates a component with an express application.
@kumori/workspace:component-hello-world: generates a component with a simple hello world application. This component is used in @kumori/workspace:project-hello-world generator.
@kumori/workspace:component-hello-world-v2-ascii: generates a component with a simple image to ascii converter.
@kumori/workspace:component-hello-world-fe: generates a frontend component to access the ascii converter using a REST API and a Single Page Application (SPA).
@kumori/workspace:component-hello-world-v3: generates a frontend component to access the hello world Java component of example hello-world-v3.
@kumori/workspace:component-java: generates a basic Java component.
@kumori/workspace:component-java-web: generates a basic Java web application.
@kumori/workspace:component-javascript: generates a basic node.js component.
@kumori/workspace:component-typescript: generates a basic node.js component authored in TypeScript.
@kumori/workspace:deployment-basic: generates an empty deployment manifest to deploy an instance of a service.
@kumori/workspace:project-hello-world: fills the workspace with all the necessary elements to register a simple Hello World service. Internally uses @kumori/workspace:component-hello-world and @kumori/workspace:service-hello-world generators.
@kumori/workspace:project-hello-world-v2: fills the workspace with all the necessary elements to register a simple image to ascii converter application. Internally uses @kumori/workspace:component-hello-world-v2-ascii, @kumori/workspace:component-hello-world-v2-fe and @kumori/workspace:service-hello-world-v2 generators.
@kumori/workspace:project-hello-world-v3: fills the workspace with all the necessary elements to register a simple hello world application using a NodeJS frontend and a Java Hello World component. Internally uses @kumori/workspace:component-hello-world-v3, @kumori/workspace:component-java and @kumori/workspace:service-hello-world-v3 generators.
@kumori/workspace:project-hello-world-v4-java-web: fills the workspace with all the necessary elements to register a simple Java Hello World application as a service. Internally uses @kumori/workspace:component-java-web and @kumori/workspace:service-hello-world-v4-java-web generators.
@kumori/workspace:resource-vhost: generates a declaration manifest to register a new domain.
@kumori/workspace:runtime-basic: generates an empty Dockerfile and manifest to create a new runtime for Kumori components.
@kumori/workspace:service-basic: generates an empty service topology declaration file.
@kumori/workspace:service-hello-world: generates a service topology declaration file for the Hello World sample project.
@kumori/workspace:service-hello-world-v2: generates a service topology declaration file for the Hello World V2 sample project.
@kumori/workspace:service-hello-world-v3: generates a service topology declaration file for the Hello World V3 sample project.
@kumori/workspace:service-hello-world-v4-java-web: generates a service topology declaration file for the Hello World V4 sample java web.