npm package: @ogs-gmbh/rolldown-plugin-assets
Description: A Rolldown plugin that emits static assets (files and directories) to the output directory during the build process.
Author: OGS GmbH
Latest version: 1.0.1

> _We're OGS, check out our work on [github.com/ogs-gmbh](https://github.com/ogs-gmbh)_

# Assets Plugin for Rolldown

_A Rolldown plugin that emits static assets (files and directories) to the output directory during the build process._

![Preview](./docs/preview.avif)

<a href="./LICENSE" target="_blank"><img alt="license badge" src="https://img.shields.io/github/license/OGS-GmbH/rolldown-plugin-assets?color=0f434e&logo=hackthebox&logoColor=000000&labelColor=ffffff" /></a>
<a href="https://github.com/OGS-GmbH/rolldown-plugin-assets/actions/workflows/main-trusted-deploy.yml" target="_blank"><img alt="workflow badge" src="https://img.shields.io/github/actions/workflow/status/OGS-GmbH/rolldown-plugin-assets/main-trusted-deploy.yml?color=0f434e&logo=rocket&logoColor=000000&labelColor=ffffff" /></a>
<a href="https://www.npmjs.com/package/@ogs-gmbh/rolldown-plugin-assets" target="_blank"><img alt="npm badge" src="https://img.shields.io/npm/v/%40ogs-gmbh%2Frolldown-plugin-assets?color=0f434e&logo=npm&logoColor=000000&labelColor=ffffff" /></a>

- **File Emitting**\
  Emit individual static files directly into Rolldown's output directory during the build process.

- **Directory Support**\
  Recursively emit entire directories, preserving the original folder structure in the output.

- **Custom Output Paths**\
  Map source assets to different destination paths using simple [from, to] tuples for full control over your output.

- **Zero Configuration**\
  Pass a plain string path to emit an asset as-is — no extra setup required for the simple case.

## Getting Started

> [!IMPORTANT]
> We're offering an extensive API-Reference covered with in-depth usage examples of this project.

To get a starting point, simply refer to our documentation at [ogs-gmbh.github.io/rolldown-plugin-assets](https://ogs-gmbh.github.io/rolldown-plugin-assets).

### Prerequisites

- Node.js version 18 or higher
- A package manager: e.g. npm, pnpm, ...

### Installation

Using npm:

```sh
$ npm add -D @ogs-gmbh/rolldown-plugin-assets
```

<details>
  <summary>Using a different package manager?</summary>
  <br/>

Using yarn:

```sh
$ pnpm add -D @ogs-gmbh/rolldown-plugin-assets
```

Using pnpm:

```sh
$ pnpm add -D @ogs-gmbh/rolldown-plugin-assets
```

Using bun:

```sh
$ bun add -D @ogs-gmbh/rolldown-plugin-assets
```

</details>

### Usage

`rolldown-plugin-assets` can be integrated with either [`tsdown`](https://tsdown.dev/) or [`Rolldown`](https://rolldown.rs/). Here's an example showing the usage of this plugin with `tsdown`. You can get a deeper understanding about this plugin by taking a look into the [reference](https://ogs-gmbh.github.io/rolldown-plugin-assets/reference).

```ts [tsdown.config.ts]
import { defineConfig } from "tsdown";
import { assetsPlugin } from "@ogs-gmbh/rolldown-plugin-assets";

export default defineConfig({
  entry: "src/**/*.ts",
  dts: true,
  outDir: "dist/main",
  unbundle: true,
  plugins: [assetsPlugin(["README.md", ["public/asset.png", "asset.png"]])]
});
```

## License

The MIT License (MIT) - Please have a look at the [LICENSE file](./LICENSE) for more details.

## Contributing

Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.

Feel free to submit a pull request, issue or feature request.

### Issues and Feature Requests

Reporting an issue or creating a feature request is made by creating a new issue on this repository.

You can create a [new issue or feature request here](../../issues/new/choose).

### Pull Requests

GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.

You can find the [guidelines here](https://docs.github.com/get-started/exploring-projects-on-github/contributing-to-a-project).

### Code Of Conduct

We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).

## Disclaimer

All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.

This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.

---

<a href="https://www.ogs.de/en/">
  <picture>
    <source
      srcset="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/light.svg"
      media="(prefers-color-scheme: dark)"
    />
    <img height="64" alt="OGS Logo" src="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/dark.svg"
  </picture>
</a>

Gesellschaft für Datenverarbeitung und Systemberatung mbH

[Imprint](https://www.ogs.de/en/imprint/) | [Contact](https://www.ogs.de/en/contact/) | [Careers](https://www.ogs.de/en/about-ogs/#Careers)