@sugoi/cli
v4.1.0
Published
CLI utils for Handle and manage SugoiJS project
Downloads
14
Maintainers
Readme
@Sugoi/cli
Introduction
SugoiJS is a minimal modular framework.
SugoiJS gives you the ability to use only what you need and do it fast.
This package provides you the needed util for sugoi development.
Installation
$ npm i -g @sugoi/cli
Bootstrapping
To bootstrap use the 'init' command:
$ sgi init
This will display a wizard for project creation.
Generate
SugoiJS provides easy generation tool by the g or generate argument
$ sgi g <type> <name>
Available types
module (m) - Generate a module with one service and one controller which contains the module name
After generating new module you will have to inject it to bootstrap module.
controller (c) - Generate a controller under 'controllers' directory.
After generating new controller you will have to inject it to the related module.
service (s) - Generate a service under 'services' directory.
After generating new service you will have to inject it to the related module.
model - Generate a model class.
mongo-model - Generate a mongo model class.
Commands example
$ sgi g m myModule
// Will create a module under the current path
// with controller and a service
$ sgi g model myModel
// Will create a model under the current path
$ sgi g mongo-model myMongoModel
// Will create a mongo-model under the current path
$ sgi g c newController
// Will create a controller under the current path
// will create controllers directory
// if no such directory found under the path
$ sgi g s newService
// Will create a service under the current path
// will create service directory
// if no such directory found under the path
Documentation
You can find further information on Sugoi official website