youi-cli

youi-cli

About

A CLI package, normally installed globally to install and configure the YouI Engine SDK.

There are 2 entry points:

• main_cli.ts corresponds to the youi-tv command
• main_create_rn_app.ts corresponds to the create-youi-react-native-app command.

These entry points are, for the most part, just command & option parsing. Most of the work is done in the other files (current package_server.ts and sdk_manager.ts).

Development

Unit Tests

Run the JEST unit tests. So far fairly basic, and hard to write tests due to the global state nature of the cli, but more effort should be made!

• See the src/__tests__/ directory for all our current tests.
• Run yarn test to run the tests.

Linting

We use tslint to lint the code. The spec is based off tslint --init with some changes for various issues. Some of which could be fixed at some point.

Build & Run

• Compile with yarn build
• Run local builds with node dist/main_cli.js and node dist/main_create_rn_app.js. These correspond to youi-tv and create-youi-react-native-app.

Publishing

Publish to NPM needs to be authenticated.

• Run yarn publish, which prompts for a new version, and then publishes to npmjs.com.

A development test package can be created & installed:

• Run npm pack which creates a youi-cli-1.2.3.tgz
• Install this with npm -g install youi-cli-1.2.3.tgz
• Note: yarn doesn't work for this because yarn is broken for installing local file packages