Dashwebapps UTILS

This repository will include reusable "utility" packages for use within other DASH web apps.

Contents:

Each feature will likely have its own dependencis, so make sure to run npm install in root & for each project.

• LoginAs: Handles local-development login functionality

Tech details:

• Jest/React-Testing-Libary for testing
• Rollup for bundling the modules to ES5.

Compiling for export as NPM package:

• This will use Rollup to handle bringing all the features together into a single bundle. This will allow for importing modules like: import { LoginAs, AccountSelector } from "utils";

• To bundle as ES5: npm run build

Testing:

We will assume all tests will use Jest & VSCode as IDE. If this is the case, it is recommended to install the Jest extension for VSCode. Notes:

• At the root of this repo is a file: .vscode/launch.json. This contains some scripts to allow for debugging with the extension above. It did not seem to work putting this in the root of the sub project. You can edit the cwd to run tests that are applicable.
  • You can verify this is working by seeing Jest:✓ in the bottom of VSCode.

Formatting:

• We are using ESLint and Prettier with the @typescript-eslint/parser. You can verify this is working by seeing ESLint Prettier:✓ in the bottom right corner of VSCode.
• Husky & LintStaged are used to verify there are no formatting & linting issues being committed.

NPM Versions:

• DO NOT run npm version patch directly on master. This will interfere with the automated build process & webhooks. If you want to create an updated version, PLEASE include this change as part of your-branch-with-changes so that the version is updated when it's merged to master.

Jenkins:

• A new build in jenkins happens automatically through a webhook after a merge to master. This will generate a new version of the NPM package.
• CI Pipeline Project: https://jenkinsci.gogoair.com/job/a_dashwebapps_utils_ci/
• NPM Master Build Project: https://jenkinsci.gogoair.com/job/a_dashwebapps_utils/