@bechtel/eframe-package-discovery4 v1.2.2

eframe Components

Folder to store packages related to eframe core components

Requirements

Node

• MacOS: brew install node@10
• Windows: Download and install from here.

Yarn

• MacOS: brew install yarn
• Windows: Download and install from here

For either system, we recommend using nvm to manage node versions on your system. If you have nvm installed on your machine you can simply run nvm use in the project root directory to switch to the correct version of node.

Lerna

Let's start by installing Lerna globally with npm:

$ npm install --global lerna

Setup

Create a new package

Set path to the desired folder and follow the below commands to get a boilerplate sample.

$ npm init ts-lerna-child-pkg folder-name

Set the name key in package.json to your desired package name.

// package.json
{
 "name":"@bechtel/awesome-package" 
}

@bechtel/ is recommended scope name for all packages This command will install with all defaults that include entry file, test files, eslint...etc.

Commands

Commands for @bechtel/awesome-package

# install
$ yarn install

# yarn workspace standard command
$ yarn workspace <workspace_name> <command>

# add new dependencies
$ yarn workspace @bechtel/awesome-package add jest --dev

# remove dependencies
$ yarn workspace @bechtel/awesome-package remove jest

# yarn commands for individual packages
$ yarn workspace @bechtel/awesome-package run build # transpile ts file to js
$ yarn workspace @bechtel/awesome-package run test # execute tests
$ yarn workspace @bechtel/awesome-package run lint # check lint prompts