fed-config

Contents

• Why
• Prerequisites
• How to execute
• Scripts
• Development

Why

This repo is intended to shorten the amount of effort needed to create multiple configuration files.

Prerequisites

You will need npx to run the scripts in this repository. This comes prepackaged with npm as standard from npm version 5.2.0. If you are using an early version of npm you can run npm i -g npx.

You'll also need to have already setup github ssh.

How to execute

Scripts in this repo are supposed to be quite easy to execute with no auth or other setup beyond what you will need for pushing/pulling/cloning.

The general pattern for executing scripts is

npx -p ClearScore/fed-config <script name>

Scripts

.npmrc script

When the script is executed it will ask for your email, full name, jFrog username, and jFrog password. Upon entering this information, a file called .npmrc will be created in your home directory and populated with the correct contents. If the file already exists an error message will be displayed, and the file will have to be deleted to use this script.

npx -p ClearScore/fed-config npmrc

.npmsyncrc script

This scripts needs to find the location of your npm-components folder, it will first check whether it has been executed in that folder. If it has not it will then traverse the directory tree, breadth-first, starting from your home directory. Therefore in order for this script to run as quickly as possible, execute it in your npm-components directory.

npx -p ClearScore/fed-config npmsyncrc

Yarn v2+ (Berry)

Do not run this within a project, but instead one level higher i.e. Run this within the 'dev' root for all projects

npx -p ClearScore/fed-config berry

Development

Executing branches

npx -p ClearScore/fed-config#<branch name> <script name>

Documentation

If you add any additional scripts please add an explanation of how to execute them and what they expect and do under the "Scripts" section.