@rushstack/heft-web-rig

A rig package for web browser projects that build using Heft

  • Types
  • ESM
  • CJS
License
MIT
Install Size
467 kB(182.3 MB)
Vulns
2
Published

Get started

$npm install @rushstack/heft-web-rig
$pnpm add @rushstack/heft-web-rig
$yarn add @rushstack/heft-web-rig
$bun add @rushstack/heft-web-rig
$deno add npm:@rushstack/heft-web-rig
$vlt install @rushstack/heft-web-rig
$vp add @rushstack/heft-web-rig

Readme

@rushstack/heft-web-rig

A rig package for web projects that build using Heft build system. To learn more about rig packages, consult the @rushstack/rig-package documentation.

This rig provides the following profiles:

  • app: For applications that get bundled using Webpack.
  • library: For creating library packages to be consumed by other web projects. Also use this profile for a library meant to be used by both Node.js and web apps.

To enable it, add a rig.json file to your project, as shown below:

config/rig.json

{
  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",

  "rigPackageName": "@rushstack/heft-web-rig",
  "rigProfile": "library"
}

The config files provided by this rig profile can be found in the heft-web-rig/profiles/library source folder.

@rushstack/heft-web-rig is part of the Rush Stack family of projects.