Skip to content

Add Cursor IDE rule: enforce Bun over Node/npm/pnpm/Vite #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add Cursor IDE rule: enforce Bun over Node/npm/pnpm/Vite #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15ae2e1
Initial plan
Copilot Feb 26, 2026
a948ea8
feat: add Cursor IDE rule for Bun tooling (no Node/Vite/npm/pnpm)
Copilot Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
description: Use Bun as the runtime, bundler, and package manager for all JavaScript/TypeScript projects in this ecosystem (especially Nexus AI Gateway). Do NOT use Node.js, Vite, npm, or pnpm.
globs: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx", "package.json", "*.config.*"]
alwaysApply: true
---

# Use Bun Instead of Node / Vite / npm / pnpm

This ecosystem's backend (Nexus AI Gateway) is built with **Bun**. Always prefer Bun for all runtime, bundling, and package-management tasks.

## Rules

### ✅ DO — Use Bun
- Run scripts with `bun run <script>`
- Install packages with `bun add <package>` / `bun remove <package>`
- Execute TypeScript files directly with `bun <file.ts>`
- Use `bun build` for bundling (where needed)
- Use `bun test` for running tests
- Reference the lockfile `bun.lockb` (commit it to git)

### ❌ DON'T — Avoid These Tools
| Tool | Replacement |
|------|-------------|
| `node <file>` | `bun <file>` |
| `npm install` | `bun install` |
| `npm run <script>` | `bun run <script>` |
| `npx <cmd>` | `bunx <cmd>` |
| `pnpm install` | `bun install` |
| `pnpm run <script>` | `bun run <script>` |
| `vite` / `vite build` | `bun build` (or keep Vite only if a framework requires it) |
| `ts-node <file>` | `bun <file>` |

### Configuration Files
- Use `bunfig.toml` for Bun-specific configuration (e.g. registry, test settings).
- `package.json` is still valid — Bun reads it natively.
- Do **not** generate `package-lock.json` or `pnpm-lock.yaml`; use `bun.lockb` only.

## Why Bun?
- **Performance:** Bun starts and executes TypeScript significantly faster than Node.js.
- **All-in-one:** Runtime + bundler + test runner + package manager in a single binary.
- **Native TypeScript:** No transpilation step needed; Bun runs `.ts` files directly.
- **Nixpacks compatible:** Coolify/Railway deployments detect `bun.lockb` and use Bun automatically.