sumor

sumor

Sumor Command Line Tool.

A Sumor Cloud Tool.
More Documentation

Installation

npm install -D sumor

Now, you can use the sumor command to use the builder tool.

Usage

Initialization

Quickly initialize the project, generate sample programs and test cases, as well as build configuration files.

sumor init

Code Checking

It will check the code style and code format. and it will generate a report into output/lint folder.

sumor lint

Automatically fix code style and code format issues

sumor lint --fix

Unit Testing

It will run the unit test cases which are under test folder and suffix with .test.js.
Then generate an unit test report into output/unit folder. A coverage report into output/coverage folder.

sumor test

--scenario

You can add --scenario=< case > to specify the test case which locate in this folder.

Packaging

Aim to package the library into a single file, and prepare files for publishing to NPM.
It will copy static folder into output folder.
It will package the library into output folder. By default, package entry is src/index.js.
output folder is output/production.

sumor build

packaging for debugging

output folder is output/development.

sumor build --mode=development

README Generation

As NPM library should have name and description in package.json. And README file should have the same content as package.json. It will automatically generate full README.md file into output folder.

You need to specify the name and description in package.json. Then specify the document into README.md. And License info into LICENSE.md, if no license file, it will load from package.json.

License Report

It will generate a license report into output/license.md.

sumor license

Publish

Publish the library to the public repository

sumor publish <version>

Publish the beta version

sumor publish <version> -b

Publish the library to the private repository

sumor publish <version> -r <registry> -u <username> -p <password>

Clean

Clean the dependencies, in case of some dependencies expired.

sumor clean

--scope

Specify scope which will be cleaned, example: @sumor-cloud

sumor clean --scope @sumor-cloud

One-time Deployment

It will deploy the application to the cloud.

scd deploy

Continuous Deployment

It will deploy the application to the cloud, and then listen to the changes of the local files, and automatically deploy the application to the cloud when the files are changed.

scd deploy --watch

Specify Type

It specifies the configuration file type. If there has different type available, it will automatically convert to the desired target type.

scd deploy --type=yaml

Display Logs

It will display the logs of the deployment.

scd logs

Deploy Configuration

scope

It defines the scope of the deployment.

source

• < source name >
  • url: git repository url
  • username: git username
  • password: git password

server

• < server name >
  • host: external host
  • iHost: internal host
  • port: default 22
  • username: server username
  • password: server password

env

• < environment name >
  • < app name >
    • domain: expose domain, like example.com
    • entry: should be server name

scale

It defines the scale of the deployment. Include env, instance size and instance count.

• < environment name >
  • < app name >
    • < version >
      • live: if true, it will be available to the public
      • instance
        • < server name >: instance count

Contributing & Issues

You can use this tool for free.
But we are a commercial company, to ensure stability, we currently don't offer a joint contribution mechanism.
You can report issues through Report Library Issue Ticket, and we will fix them as soon as possible.

License

In consideration of the chaotic situation in the open source community, we provide obfuscated code for use and security analysis.
However, we do not provide the source code in its original form in order to protect the ongoing maintenance and creative interests and motivations.
The released code in NPMJS is based on MIT. The source code is closed-source.

Our tools are free to use in order to help build cloud applications more efficiently. Our commercial purpose is to improve the ecosystem of business websites.
If there are any innovations that greatly benefit the open source community, it will be separated and contributed to the open source community.