Boom Scripts

Goals

Automate and normalize project configuration across the Boomsourcing organization.

Installation

npm install --save-dev boom-scripts

Features

boom-scripts automates your setup of useful tools such as prettier and eslint. Configuration is decided at the package level to create consistentcy across the organization's projects.

Usage

After installing boom-scripts you'll want to run

npx boom-scripts init

This will run the initialization code that will configure and install prettier and eslint for your project.

At this time boom-scripts does not support overriding the configuration locally. This means you'll be locked into the configuration options defined by boom-scripts. Local configuration support could be added and pull-requests are welcome.

Other Scripts

As part of the init process boom-scripts adds two useful scripts to your package.json file, format and lint.

npm run format

Will format all of your supported project files with prettier according to the boom-scripts configuration.

npm run lint

Will run eslint, with the boom-scripts configuration, on all of your javascript files and print out any errors, warnings or information.