@gilbarbara/package-starter

Scaffold a new NPM package.

Highlights

• 🏖 Easy to use: Just run the command.
• 💫 Customizable: Create a Typescript-only package or a TypeScript + React one.
• 🛠 Compatible: Uses tsup to generate esm and commonjs bundles.
• 🚧 Ready for tests: Uses vitest (with @testing-library/react in the TypeScript + React option) for testing.
• 🚀 CI/CD: Includes a workflow for GitHub Actions.

Usage

With NPM:

npx @gilbarbara/package-starter

With Yarn:

yarn dlx @gilbarbara/package-starter

With PNPM:

pnpx @gilbarbara/package-starter

With Bun:

bunx @gilbarbara/package-starter

Then follow the prompts!

You can also specify the package name you want to use:

# npm 7+, extra double-dash is needed:
npx @gilbarbara/package-starter my-package

# yarn
yarn dlx @gilbarbara/package-starter my-package

# pnpm
pnpx @gilbarbara/package-starter my-package

# Bun
bunx @gilbarbara/package-starter my-package

Currently supported templates are:

• typescript
• typescript-react

You can use . for the project name to scaffold in the current directory.

License

MIT