@essex/scripts

This package provides scripts for common build tooling for the essex team. The philosophy of these scripts are to provide a recommended configuration while allowing for escape-hatching.

Setup

Add the following configuration to your package.json. If you're in a monorepo, this should be defined at the top level:

{
	"devDependencies": {
		"@essex/scripts": "<latest version>"
	},
	"prettier": "@essex/prettier-config"
}

The prettier section allows for pretty-quick (used by our build system) and Visual Studio Code to detect the active prettier configuration.

Additional build tooling is wired in via invoking essex. Check out the available scripts and recipes below.

Scripts

Scripts are invoked via the essex CLI tool. Commands are in the form essex <commmand> <options>.
To view detailed options, run essex <command> --help or essex --help

• audit
• build
• bundle
• clean
• init
• lint
• precommit
• prettify
• serve
• test
• watch

Recipes

{
	"name": "monorepo-root",
	"private": true,
	"scripts": {
		/* orchestrate child packages */
		"clean": "yarn workspaces foreach -piv run clean",
		"build": "yarn workspaces foreach -pivt run build",
		"bundle": "yarn workspaces foreach -piv run bundle",

		/* use @essex/scripts for top-level checks */
		"check": "essex check",
		"unit_test": "jest --coverage",

		/* hook for CI builds */
		"ci": "run-s lint build bundle unit_test"
	}
}

{
	"name": "library-package",
	"version": "1.0",
	"main": "dist/cjs/index.js",
	"module": "dist/esm/index.js",
	"types": "dist/types/index.d.ts",
	"scripts": {
		"build": "essex build",
		"clean": "essex clean",
		"start": "essex watch"
	}
}

{
	"name": "webpack-app",
	"private": true,
	"scripts": {
		"bundle": "webpack",
		"clean": "essex clean build",
		"start": "webpack serve"
	}
}