my-bun-module

A Bun module

A Bun module created from the bun-module template

Features

• 🏗️ TypeScript-based module architecture
• 🔧 Mise task runner integration
• 📦 Bun/npm build tooling
• ✨ ESLint + Prettier formatting
• 🧪 Vitest testing setup
• 🚀 GitHub Actions CI/CD
• 📝 Release automation with release-please

Getting Started

1. Clone this template:

   cp -r bun-module your-module-name
   cd your-module-name

2. Update package.json:

   • Change name to your module name
   • Update description
   • Update repository.url

3. Install dependencies:

   bun install

4. Implement your module in src/index.ts:

   export function hello(name: string): string {
     return `Hello, ${name}!`;
   }

5. Test your module:

   mise run test

Development

• mise run build - Build the module
• mise run test - Run tests
• mise run lint - Lint code
• mise run lint:fix - Fix linting issues
• mise run format - Format code with Prettier

Author

Your Name you@example.com

Repository

https://github.com/zenobi-us/pi-sidebar.git

Contributing

Contributions are welcome! Please file issues or submit pull requests on the GitHub repository.

License

MIT License. See the LICENSE file for details.