npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pirxpilot/metalsmith-esbuild

v1.0.1

Published

A metalsmith plugin that bundles your JS using esbuild

Downloads

25

Readme

NPM version Build Status Dependency Status license: MIT

@pirxpilot/metalsmith-esbuild

Fork of @metalsmith/js-bundle without ES5 support.

A metalsmith plugin that bundles your JS using esbuild with sensible defaults.

Features

  • Supports most ESbuild options including custom loaders and plugins

Installation

NPM:

npm install @pirxpilot/metalsmith-esbuild

Yarn:

yarn add @pirxpilot/metalsmith-esbuild

Usage

Pass @pirxpilot/metalsmith-esbuild to metalsmith.use :

const jsBundle = require('@pirxpilot/metalsmith-esbuild')

metalsmith.use(
  jsBundle({
    // defaults
    entries: {
      index: 'lib/index.js'
    }
  })
)

const isProd = metalsmith.env('NODE_ENV') !== 'development'
metalsmith.use(
  jsBundle({
    // explicit defaults
    bundle: true,
    minify: isProd,
    sourcemap: !isProd,
    platform: 'browser',
    target: 'es6',
    assetNames: '[dir]/[name]',
    // accessible as process.env.<NAME> in your JS files
    define: metalsmith.env(),
    // removes console & debugger statements
    drop: isProd ? ['console', 'debugger'] : [],
    entries: {
      index: 'lib/index.js'
    }
  })
)

The paths in the entries option should be relative to metalsmith.directory().

Options

@pirxpilot/metalsmith-esbuild provides access to most underlying esbuild options, with a few notable differences:

The options absWorkingDir (=metalsmith.directory()), outdir (=metalsmith.destination()), write (=false), and metafile (=true) can not be set, they are determined by the plugin.

The option entryPoints is renamed to entries. Specify entries as a {'target': 'path/to/source.js' }} object, and mind that the target should not have an extension.

The option define is automatically filled with with metalsmith.env(), but can be overwritten if desired. metalsmith.env('DEBUG') would be accessible in the bundle as process.env.DEBUG.

Loading assets

You can load assets with any of the ESbuild loaders by specifying a loader map. By default there is support for .js,.ts,.css,.json,.jsx,.tsx, and .txt loading. It's important to note 2 things:

  • assets loaded with any loader but the file loader will be "embedded" in the resulting JS bundle and removed from the build (=not available for other plugins), increasing bundle size.
  • if you would like to process assets loaded with the file loader with other metalsmith plugins (eg metalsmith-imagemin) @pirxpilot/metalsmith-esbuild needs to be run first and you should not overwrite the default assetNames option [dir]/[name].

The file loader is the loader you need for most large asset types you wouldn't want to bloat your JS bundle with. If you want to use inline SVG's, you would set its loader to text, while if you prefer loading them in image tags, you could set them to dataurl (embedded) or file (external).

The publicPath option will prepend a path to each asset loaded with the file loader. This can be useful if you are serving the metalsmith build from a non-root URI.

metalsmith.use(
  jsbundle({
    entries: { index: 'src/index.js' },
    loader: {
      '.png': 'file',
      '.svg': 'dataurl',
      '.jpg': 'file', // this will be a relative URI
      '.yaml': 'text' // this will be a parseable string
    },
    publicPath: metalsmith.env('NODE_ENV') === 'development' ? '' : 'https://johndoe.com'
  })
)

Debug

To enable debug logs, set metalsmith.env('DEBUG', '@pirxpilot/metalsmith-esbuild*') or in metalsmith.json: "env": { "DEBUG": "@pirxpilot/metalsmith-esbuild*" }. You can also pass the live environment variable by running metalsmith.env('DEBUG', process.env.DEBUG) or in metalsmith.json: "env": { "DEBUG": "$DEBUG" }

Alternatively you can set DEBUG to @metalsmith/* to debug all Metalsmith core plugins.

CLI usage

To use this plugin with the Metalsmith CLI, add @pirxpilot/metalsmith-esbuild to the plugins key in your metalsmith.json file:

{
  "plugins": [
    {
      "@pirxpilot/metalsmith-esbuild": {
        "entries": {
          "app": "lib/main.js"
        }
      }
    }
  ]
}

License

MIT