Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r4ai/bun-banner-plugin
Insert an arbitrary string at the beginning of generated content. Inspired by esbuild banner option.
https://github.com/r4ai/bun-banner-plugin
Last synced: about 2 months ago
JSON representation
Insert an arbitrary string at the beginning of generated content. Inspired by esbuild banner option.
- Host: GitHub
- URL: https://github.com/r4ai/bun-banner-plugin
- Owner: r4ai
- License: mit
- Created: 2023-11-18T08:04:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-17T21:33:28.000Z (3 months ago)
- Last Synced: 2024-10-20T08:25:01.384Z (3 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/bun-banner-plugin
- Size: 134 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bun-banner-plugin
A small plugin to insert an arbitrary string at the beginning of generated content. Inspired by [esbuild banner option](https://esbuild.github.io/api/#banner).
## Installation
```sh
bun add -D bun-banner-plugin
```
## Usage
`build.ts`:
```ts
import { bannerPlugin } from "bun-banner-plugin";
await Bun.build({
entrypoints: ["src/index.ts"],
outdir: "dist",
target: "node",
minify: true,
plugins: [
bannerPlugin({
// Add banners to json files
jsonc: ["// This is a jsonc file", "// Hello, jsonc!"],
// Add a shebang to the top of `.ts`, `.tsx`, `.js`, `.jsx` files
"ts|tsx|js|jsx": "#!/usr/bin/env node",
}),
],
});
```
## Example
Suppose you have the following `src/index.ts`.
```ts
console.log("Hello, world!");
```
Now, using the `build.ts` I wrote in [Usage](#usage), run `bun run build.ts`, the following will be output:
```js
#!/usr/bin/env node
console.log("Hello, world!");
```
## Options
- The key is a regular expression that matches the file extension.
- The given key is interpreted as a regular expression, so you need to escape special characters.
- For example:
- If the key is `json`, it will interpreted as `/.(json)$/`. It will match `.json` files.
- If the key is `ts|tsx|js|jsx`, it will iterpreted as `/.(ts|tsx|js|jsx)$/`. It will match `.ts`, `.tsx`, `.js`, `.jsx` files.
- The value is the string to be inserted at the beginning of the file.
- If the value is an array, the strings in the array will be joined with a newline character.
- If the value is a string, it will be inserted as is.
- For example, If the value is `["// This is a jsonc file", "// Hello, jsonc!"]`, it will be inserted as follows:
```jsonc
// This is a jsonc file
// Hello, jsonc!
{
"foo": "bar",
}
```
## Development
### Commands
| Command | Description |
| ----------------------------- | ------------------------------------------------- |
| `bun install` | Install dependencies |
| `bun run build` | Build the project |
| `bun run test` | Run tests with watch mode |
| `bun run check` | Lint and format |
| `npm publish --dry-run` | Check locally for products to be published to npm |
| `npm publish --access public` | Publish to npm |
### Publish
1. Update version in `package.json`
2. commit with tag `vX.X.X`
3. push to GitHub