obsidianmd / obsidianmd/obsidian-sample-plugin

Feature Request: Add Bun runtime support as alternative to Node.js

Open
#174 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4.5k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Feature Request: Add Bun runtime support as an alternative to Node.js

Summary

Add official support for Bun as an alternative JavaScript runtime for building Obsidian plugins.

Motivation
  • I already have Bun installed, but not Node
Proposed Changes

Minimal modifications to enable Bun support:

  1. package.json: Update scripts (dev, build) to enable the possibility to use Bun instead of Node
  2. .gitignore: Include bun.lockb.
  3. README.md / AGENTS.md: Document Bun as an alternative option
Implementation

I'm going to prepare a PR with these changes: #172

I'm also building a real plugin using this Bun-enabled template. Will report results here.

Notes
  • This should not replace Node.js - it's purely additive
  • All existing documentation and workflows remain valid, although the idea is to document the possibility of using Bun instead of node
  • Developers can choose whichever runtime they prefer
  • The Obsidian API is unaffected since it runs in Electron, not Node/Bun

I would like to hear the team's thoughts on this! Happy to adjust the approach based on feedback.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review package.json, .gitignore, README.md, and AGENTS.md first. Check how the dev and build scripts and lockfile handling should support Bun without replacing Node.js. Done means Bun is documented and usable as an alternative while existing Node.js documentation and workflows remain valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
bun, typescript
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.