Socket
Socket
Sign inDemoInstall

@ms-cloudpack/bundler

Package Overview
Dependencies
9
Maintainers
0
Versions
276
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ms-cloudpack/bundler


Version published
Weekly downloads
1.4K
increased by25.02%
Maintainers
0
Created
Weekly downloads
 

Readme

Source

@ms-cloudpack/bundler

This library provides an abstraction on bundling a package, assuming that the package is conformant.

Rather than directly depending on Webpack, rollup, or esbuild with large amounts of custom configuration, having an abstraction around bundling provides constraints around having common inputs/outputs.

This enforces the code follow consistent constraints, while also ensuring the output can be consumed in the browser or in node depending on supported environments.

Abstraction also allows us to use the right tool for the job. The right tool depends on priorities and capabilities. For dev builds we want the fastest tool, while for production we want optimal output. For library mode builds on commonjs only packages, esbuild doesn't emit named exports while rollup does. Maybe later esbuild will address that issue, so we can adjust the regulation logic accordingly.

Usage

async function bundlePackage(options)

import { bundlePackage } from '@ms-cloudpack/bundler';

async function start() {
  const result = await bundlePackage({
    packagePath: process.cwd(),
    outputPath: path.join(process.cwd(), 'dist'),
    outputType: 'library',
  });

  console.log(result);
}

start();

bundlePackage options

NameTypeDescription
packagePathstringPath to the package root where package.json lives.
forcebooleanBypasses the cache to create bundles.
hashFrom"package-version" | "git"Determines how the cache key is computed for bundle results.
output"library" | "app"

Return object

NameTypeDescription
stats
outputMap

Details

The Cloudpack bundler abstraction is simple and constrained on purpose:

  1. Consume a standard package (app or library) with a minimum set of requirements.
  2. Emits standard ESM bundle.
  3. Leverages package.json and convention as much as possible:

This library has only 2 output modes:

  • library mode - produces a bundle of source which externalizes dependencies and is consumable by the target (browser or node) which can resolve the dependencies through an import maps in the browser or through module resolution in node. The source is unminified.
  • production mode - produces a bundle of source which includes dependencies and is also similarly consumed.

Package requirements

Discovering entry points

Entry points are discovered by analyzing the package.json. This ensures only explicit entries are bundled.

ESM output

Considerations

Leverage existing task runners

Under the hood, if we want to separate the process into multiple steps, we may consider using task helpers like just-scripts or heft to execute things in the right order. This might help

Splitting the "bundle" abstraction into pre/bundle/post steps

FAQs

Last updated on 12 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc