UdeS CLI

Introduction

This package contains Command Line Interface tools for automated certain development tasks. Once installed the included scripts can be added to your package.json.

Prerequisites

• Node 6.10.1 or above (it is recommended to install it via NVM)

Getting started

Installation

If you want to test or develop on the library simply run these commands

git clone git@github.com:UdeS-STI/udes-cli.git
cd udes-cli
npm install

Add to project

If you want to add the library to your project simply run

npm install udes-cli -g --save

Then, in the script section of your package.json you can add the commands from the library

{
  "scripts": {
    "build": "udes polymer-build -u /dir/ --buildNames bundled -ac",
    "format": "udes format .",
    "install": "udes bower install",
    "lint": "udes lint .",
    "lock": "udes bower lock",
    "status": "udes bower status",
    "unlock": "udes bower unlock",
    "validate": "udes bower validate"
  }
}

Usage

Command Line

npm run udes bower install bower-package --save
npm run udes format .
npm run udes lint .
npm run udes polymer-build --baseURI /path/to/project/

Documentation

TODO

Contributing

Style

You must use the following guides:

• UdeS JavaScript Style Guide
• StandardJS
• JSdoc

This project contains a linting config, you should setup eslint into your editors with .eslintrc.js.