Getting Started

Prerequisites

• Bun 1.x or later
• Node.js 20+ (for compatibility)
• A GitHub account (for publishing)

Create Your Project

Option 1: Use GitHub Template (Recommended)

1. Go to npm-ts-template
2. Click "Use this template" → "Create a new repository"
3. Clone your new repository:

git clone https://github.com/YOUR_USERNAME/YOUR_REPO.git
cd YOUR_REPO

Option 2: Clone Directly

git clone https://github.com/pyyupsk/npm-ts-template.git my-library
cd my-library
rm -rf .git
git init

Setup

Install dependencies:

bun install

This will also set up git hooks via Lefthook.

Customize Your Package

1. Update package.json

{
  "name": "your-package-name",
  "description": "Your package description",
  "author": "Your Name",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/YOUR_USERNAME/YOUR_REPO.git"
  }
}

2. Update Documentation

• README.md - Update for your package
• LICENSE - Update copyright holder

3. Start Coding

Replace the sample code in src/index.ts:

/**
 * Your first function.
 *
 * @param input - Description of the input
 * @returns Description of what it returns
 */
export function myFunction(input: string): string {
  return `Result: ${input}`;
}

4. Update Tests

Update tests/index.test.ts to match your code:

import { describe, expect, it } from "vitest";
import { myFunction } from "../src";

describe("myFunction", () => {
  it("should return formatted result", () => {
    expect(myFunction("test")).toBe("Result: test");
  });
});

Verify Setup

Run the validation commands:

# Build the package
bun run build

# Run tests
bun run test

# Check linting
bun run lint

# Check types
bun run typecheck

All commands should pass without errors.

Next Steps

• Writing Code - Learn about JSDoc requirements
• Testing - Write effective tests
• Publishing - Release your first version