porcupine-md/jonggrang/scaffold-library

Context

You will create a library "{{input.name}}" targeting {{input.runtime}}. Output format: {{input.format}}.

Instructions

1. Setup package.json

• name, version, description, license
• main (CJS), module (ESM), types
• exports field for dual package
• scripts: build, test, lint, prepublishOnly
• peerDependencies (not dependencies) for shared libs

1. Setup TypeScript config

• tsconfig.json for source
• tsconfig.build.json for build output
• Strict mode enabled
• Declaration files enabled

1. Setup build tool

• tsup or unbuild (simple, near-zero-config)
• Config for ESM + CJS output
• Source maps
• DTS generation

1. Create source structure

`` src/ ├── index.ts # Public API exports ├── types.ts # Shared types └── [modules]/ # Feature modules ``

1. Setup testing

• Vitest config
• Example test file
• Coverage config

1. Setup linting

• ESLint config (if not already present)
• Prettier config (if not already present)

1. Create README stub

• Installation
• Quick start
• API reference placeholder

1. Setup CI (if jonggrang.json ci.provider != none)

• Build + test on PR
• Publish on tag/release

Script

#!/bin/bash
# Initialize if no package.json
if [ ! -f "package.json" ]; then
  npm init -y
fi
 
# Install dev dependencies
npm install -D typescript tsup vitest @types/node

Validation

• [ ] npm run build succeeds
• [ ] npm run test passes
• [ ] Output files generated (dist/)
• [ ] Types generated (.d.ts)
• [ ] ESM import works
• [ ] CJS require works (if format includes cjs)
• [ ] Exports field correct in package.json