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

rollup-plugin-conditional-exec

v2.8.0

Published

Execute a given command after a bundle has been written

Downloads

778

Readme

rollup-plugin-conditional-exec

⚙️🚀 Execute commands after writing a bundle with optionally provided conditions

build codecov npm

This package facilitates executing a given command after a bundle has been written by Rollup. The timing of the execution of the given command can be leveraged by providing a condition to satisfy before performing the command.

For example, if you are a Vite user and you generate bundled code for es & umd, you can write a condition function in your vite.config.ts that will only return true once both values have been observed, as Vite will run rollup twice to generate both of these.

I built this primarily so that after each successful bundle had been generated, yalc push would be called.

Usage

Create a rollup.config.js configuration file and import this plugin:

import conditionalExec from "rollup-plugin-conditional-exec";

export default {
  input: "src/index.js",
  output: {
    file: "dist/index.js",
    format: "cjs",
  },
  plugins: [
    conditionalExec({
      command: "yalc push",
    }),
  ],
};

Options

Typings for the options are available by importing RollupConditionalExecOptions.

command

Type: string Required: true

This is the command you want to be executed after a bundle has been written.

options

Type: object Default: { stdio: "inherit" }

See CommonExecOptions for available options.

If an options object is provided, it will override the default.

condition

Type: () => Promise<boolean> | boolean | (outputOpts: OutputOptions) => Promise<boolean> | boolean Default: () => true

Provide an optional condition to satisfy before a given command is executed. The condition command is passed in the OutputOptions that are give to writeBundle to allow you to leverage build time specific options. i.e. which bundle you are currently generating in a series of bundling operations.

afterExec

Type: () => Promise<void> | void Default: () => undefined

Provide an optional function to be executed after the command has been executed successfully. This can allow you to tidy up state, where you need to reset a state between bundles when running in a build watch mode or similar.

onError

Type: (error: Error) => Promise<void> | void Default:

(error: Error) => {
  console.error(`Exec has failed: ${error.message}`);
  console.debug(error.stack);
  throw error;
};

Provide an optional function to be executed should your provided command fail to execute successfully. By default, this will log your error and then rethrow the error to prevent a silent failure.

How it works

This plugin leverages the following hooks provided by Rollup

  • Build Hooks
    • buildStart
      • An assertion is completed here to validate that the command itself is both provided and not an empty string.
  • Output Generation Hooks
    • writeBundle
      • It is at this stage that commands are executed via Nodes exec function.

Simplified Flow of used hooks

┌──────────────── Rollup ────────────────┐
│                                        │
│                                        │
│   ┌──────────────┐                     │
│   │  buildStart  │                     │
│   └───────┬──────┘                     │
│           │                            │
│           │                            │
│           ▼                            │
│   ┌──────────────┐                     │
│   │  Assert cmd  │                     │
│   │              ├─── false ──┐        │
│   │  is defined  │            │        │
│   └───────┬──────┘            │        │
│           │                   │        │
│           │                   │        │
│         true                  │        │
│           │                   ▼        │
│           ▼              ┌─────────┐   │
│   ┌───────────────┐      │  Fail   │   │
│   │  writeBundle  │      │         │   │
│   └───────┬───────┘      │  Build  │   │
│           │              └─────────┘   │
│           │                   ▲        │
│           ▼                   │        │
│     ┌───────────┐             │        │
│     │  execute  │             │        │
│     │           ├──── error ──┘        │
│     │  command  │                      │
│     └─────┬─────┘                      │
│           │                            │
│           │                            │
│        success                         │
│           │                            │
│           │                            │
│           ▼                            │
│    ┌─────────────┐                     │
│    │  Completed  │                     │
│    └─────────────┘                     │
│                                        │
│                                        │
└────────────────────────────────────────┘