unifier-cli

unifier-cli is a front-end tool, that created for unifying all configs, structure, and share base codebase within different Requestum projects

Usage no npm install needed!

<script type="module">
  import unifierCli from 'https://cdn.skypack.dev/unifier-cli';
</script>

README

Unifier CLI

unifier-cli is a front-end tool, that created for unifying all configs, structure, and share base codebase within different Requestum projects.

With this tool you can create three types of project:

  • Angular
  • Plain JS
  • Email Template

Getting Started

Built with

Node JS, Typescript

Prerequisites

For use this package you need to pre-install the NodeJS and npm to your computer.

Installing

You can use it with npm:

npm i -g unifier-cli

Or use it with npx without installing:

npx unifier-cli

Using

For creating a new project:

unifier-cli

Then the command line prompt should ask some questions about your project, and generate it in the current directory after you answer on questions.

You also can use command line arguments, like:

unifier-cli <project name>

Also you can use additional arguments:

  • --type - tells to CLI that it should create project with that type. Get angular, plain-js or email value.

Development

For development purposes you must clone this repo and run npm i or npm install command.

Dev mode

Rebuild code on every .ts file change

npm run dev

Build

Compile .ts files into .js and copy all git submodules

npm run build

Tests

Explain how to run the automated tests for this system

Unit tests

For running tests

npm run test

For checking tests coverage

npm run coverage

Linter

Lint your .ts files

npm run lint

Team

  • Alex Tykhonenko - Master
  • Kate Shcherbak - PM