unitejs-cli v1.8.1

UniteJS CLI - Zero Configuration Web App Creation

How many times have you started a new web project and thought maybe I should try using the latest and greatest tech stack to see what I am missing?

Then the reality check happens and you probably think:

• I don't have time to learn a new technology
• The getting started guides are great but I just want to dive in and code
• I don't want to have to learn all the new tasks/commands/scripts just to give it a try
• How long is it going to take me to configure the different technologies to work together

The aim of UniteJS is to provide a CLI tool which you can use to create a ready to roll application with code, styling, unit tests and e2e tests, platform packaging, resource generation all with zero configuration. All combinations of the chosen technologies provide the same set of tasks to run and produce the same output.

We try not to be too opinionated with what our CLI produces, but sometimes that can't be helped :wink:

Create your app with any combination of the options below, all guaranteed to work with no additional configuration.

• Application Frameworks: Angular, Aurelia, Polymer, Preact, React, Vanilla, Vue.
• Languages: JavaScript, TypeScript
• Module Types: AMD, CommonJS, SystemJS
• Bundlers: Browserify, RequireJS, SystemJS, Webpack
• Linter: ESLint, TSLint
• Unit Test Runners: Jest, Karma
• Unit Test Frameworks: Jasmine, Mocha
• Unit Test Engines: Chrome Headless, JSDOM, PhantomJS
• E2E Test Runners: Protractor, WebDriverIO
• E2E Test Frameworks: Jasmine, Mocha
• CSS Pro Processors: Css, Less, Sass, Stylus
• CSS Post Processors: PostCss
• CSS Linter: LessHint, SassLint, Stylint, StyleLint
• Documenters: ESDoc, JSDoc, TypeDoc
• Task Runners: Gulp
• Package Managers: Npm, Yarn
• Platforms: Cordova, Docker, Electron, Web

As we add new features to UniteJS you will be able to update your project without losing any changes you have made.

Documentation

In depth CLI documentation with examples can be found on our web site at http://unitejs.com/#/cli

Information on the facilities available in the generated app can be found at http://unitejs.com/#/generatedapp

If you don't want to type in all the command line options we have provided an online generator on our web site at http://unitejs.com/#/generator or if you are using VSCode you can install our extension UniteJS VSCode Extension with shortcuts to many of the tasks.

Install

UniteJS is a node module and is best installed as a global package.

npm install -g unitejs-cli / yarn global add unitejs-cli

Usage

unite command --argName<0>=argValue<0> ... --argName<n>=argValue<n>

where command is one of:

• help
• version
• configure
• buildConfiguration
• generate
• clientPackage
• platform
• package

Argument names are case sensitive but values are case insensitive, argument values with spaces should be enclosed in quotes, apostrophes or backticks.

Commands

unite help

Displays the help on the command line.

unite version

Displays the version of the app and the engine on the command line.

unite configure

This command will generate your skeleton application with the options you specify.

Command buildConfiguration

--operation=add

This will either add a new configuration or update any existing configurations with the same name.

--operation=remove

This will remove an existing configuration.

unite generate

Creates components for use in your application, your application framework, sourceLanguage, css preprocessor and other variables will be used to create code specific to your configuration. Additionally simple unit tests will be created.

Generate Types

• Angular - class, component, directive, enum, guard, interface, module, pipe, service
• Aurelia - attribute, binding-behavior, class, component, element, enum, interface, pipeline-step, value-converter
• Polymer - class, component, enum, interface
• Preact - class, component, enum, interface
• React - class, component, enum, interface
• Vanilla - class, enum, interface
• Vue - class, component, enum, interface

unite clientPackage

Perform operations to add or remove client packages. In addition these operations will handle the npm/yarn tasks.

operation add

This will add a new clientPackage and modify all the necessary configuration files to include it in your app.

--operation=remove

This will remove an existing clientPackage and modify all the necessary configuration files to remove it from your app.

unite platform

Perform operations to add or remove platforms. This provides tasks that allow you to wrap your web application for different platforms.

--operation=add

This will add a new platform and modify all the necessary configuration files to include it in your app.

--operation=remove

This will remove an existing platform and modify all the necessary configuration files to remove it from your app.

unite package

Add a pre-configured package to your application.

Configuration Profiles

The following configuration profiles are currently available, they provide a set of defaults recommended by the application framework providers.

• AngularJavaScript
• AngularTypeScript
• AureliaJavaScript
• AureliaTypeScript
• PolymerJavaScript
• PolymerTypeScript
• PreactJavaScript
• PreactTypeScript
• ReactJavaScript
• ReactTypeScript
• VanillaJavaScript
• VanillaTypeScript
• VueJavaScript
• VueTypeScript

Client Package Profiles

The following clientPackage profiles are currently available, they provide a set of defaults for the libraries.

• bluebird
• bootstrap4
• font-awesome
• moment
• lodash
• primsjs
• rxjs
• underscore

Packages

Packages for use with the UniteJS JavaScript framework management tool.

Each package includes the npm modules and example code for a specific library.

When installed the package will also endeavour to create a router entry to link to the new example page.

• moment
• lodash
• rxjs
• underscore

See the UniteJS Packages repo for more details.

Disclaimer

UniteJS currently has about 200 dependencies on the libraries it uses to generate the app, while we endeavour to make sure that every combination works it goes without saying that from time to time something will break.

Our web site Status page shows the current state of our test matrix which tries to test as many combinations as possible using the latest version of each library.

If you are still having issues just let us know in the Issues and we will get it fixed ASAP.

Feature Requests

You can see the planned features in the roadmap if there is any other technologies you would like to see added just drop us a message.