analytics/webcontent/bi/js/cahome/lib/@waca/core-client

*** Glass is no longer supporting new features or minor fixes for ba-core-client. Moving to ba-ui-toolkit is the recommended path going forward ***

BA Core Client

Description

• Shared Utilities and UI
• Consumers should embed and reference local copy
• All modules must reference each other using relative paths!

Tools

• Must install ChromeDriver
• Node.js: 8.9.1+

• NPM: 5.7.1+

• Grunt CLI:

  npm install -g grunt-cli
  

Pipeline

The badge up top is for Jenkins, which will build only when a push is made to the master branch. The Jenkins job is responsible for publishing to artifactory. Travis only builds and runs tests every time a push is made to any branch and whenever a pull request is made.

How to

# Start
git clone git@github.ibm.com:BusinessAnalytics/ba-core-client.git

# Dependencies
npm install

# Lint
grunt eslint

# Build
grunt build

# The Selenium chromedriver must be installed in order to run tests. Install on a Mac:
brew tap homebrew/cask
brew cask install chromedriver

Test

Intern and Selenium are used for unit testing.

Run the following commands to run the tests and generate an istanbul coverage report of the code under html-report:

# Test
grunt unit-test-chrome

Run the following to test and generate an Intern Test Report which shows the test results in terms of the number of tests, skips, failures, success rate, etc.

# Test & Debug
grunt unit-test-debug

Configure npm to fetch @waca modules from the Artfactory NPM repository.

Instructions

Translations

We are currently taking advantage of the new globalization pipeline to do our translations pipeline-wiki

In order to run translations locally, you will need the following credentials:

# ~/gpCred.json

this file in your home directory will need a pipeline credential

one can be provided by team members or from the ca-glob-support slack channel

The following in your bash profile:

export GIT_TOKEN="your git token"
export W3_USERNAME="your.email@ibm.com"
export W3_PASSWORD="yourW3Password"

To run translations you will need to execute the following commands:

npm run translate-files

This will download machine translated files and request human translations. When human translations are ready, they can be downloaded by running:

npm run download-human-translations

In the case you receive a warning that the translation bundles are missing (they shouldn't be), you can run the following:

npm run create-translation-bundle