@sumor-cloud/builder

Sumor Builder Tool

A Sumor Cloud Tool, used to quickly build Node.JS libraries.

Introduction

Sumor Builder Tool is a tool used to quickly build Node.JS libraries, providing functions such as fast testing, packaging, and publishing private NPM package.
More Documentation

Installation

npm install -D @sumor-cloud/builder

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

Usage

Initialization

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

scb init

Code Checking

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

scb lint

Automatically fix code style and code format issues

scb 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.

scb test

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.

```shell
scb build

packaging for debugging

output folder is output/development.

scb build --mode=development

License Report

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

scb license

Publish

Publish the library to the public repository

scb publish <version>

Publish the beta version

scb publish <version> -b

Publish the library to the private repository

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

Clean

Clean the dependencies, in case of some dependencies expired.

scb clean

--scope

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

scb clean --scope @sumor-cloud

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.