confetti

---

Show confetti when build success.

📝 Table of Contents

• 📝 Table of Contents
• 🧐 About
• 🏁 Getting Started
  • Prerequisites
  • Installing
• 🎈 Usage
  • Vite
  • Rollup
  • Webpack
  • Esbuild
• 🚀 Deployment
• ⛏️ Built Using
• ✍️ Authors
• 🎉 Acknowledgements

🧐 About

(Only support MacOS)

Show confetti when build success.

🏁 Getting Started

You can use it standalone as a function, or you can interactive it with build tools like webpack/vite/esbuild/rollup.

Prerequisites

You need to install Raycast.

Installing

# If you only want to use it standalone.
pnpm add @akrc/confetti

# If you want to use it with build tools.
pnpm add unplugin-confetti

🎈 Usage

If you want to use it standalone:

import { confetti } from '@akrc/confetti';

confetti();

If you want to use it with build tools, see below:

Vite

// vite.config.ts
import { vite } from 'unplugin-confetti';

export default {
    plugins: [vite()],
};

Rollup

// rollup.config.js
import { rollup } from 'rollup';

export default {
    plugins: [rollup()],
};

Webpack

// webpack.config.js
import { webpack } from 'unplugin-confetti';

module.exports = {
    plugins: [webpack()],
};

Esbuild

// esbuild.config.js
import { esbuild } from 'unplugin-confetti';

build({
    plugins: [esbuild()],
});

Or you can take a look at tests in this repo.

🚀 Deployment

This repo use pnpm to manage monorepo.

git clone https://github.com/akarachen/confitte
cd confitte
pnpm install

⛏️ Built Using

• NodeJs - JavaScript runtime
• Unplugin - Plugin system

✍️ Authors

• @akarachen - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

Inspired by Umijs