Template for my Node Packages

Template Setup

To create and initialize a new package using npx:

npx @rebeccastevens/create-ts-pkg my-new-package

For advanced configuration (license selection, test suite, JSR, Renovate, and Commitizen toggles) via npx:

npx @rebeccastevens/create-ts-pkg my-new-package --advanced

Or run directly inside a cloned repository:

pnpm run init

For advanced configuration inside a cloned repository:

pnpm run init -- --advanced

This section will be automatically removed once template initialization completes.

Donate

Any donations would be much appreciated. 😄

Enterprise Users

package_name is available as part of the Tidelift Subscription.

Tidelift is working with the maintainers of package_name and a growing network of open source maintainers to ensure your open source software supply chain meets enterprise standards now and into the future. Learn more.

Installation

npm

# Install with npm
npm install package_name

# Install with pnpm
pnpm add package_name

# Install with yarn
yarn add package_name

# Install with bun
bun add package_name

jsr

# Install in a node project
npx jsr add package_name

# Install in a deno project
deno add jsr:package_name

# Install in a bun project
bunx jsr add package_name

Publishing (Post-Initialization)

When you are ready to publish your package:

1. Update package.json to set "private": false.
2. Configure npm Trusted Publishing (OIDC) at npmjs.com to allow GitHub Actions to publish securely without an NPM_TOKEN.
3. If your repository is private, add a CODECOV_TOKEN repository secret for the coverage step to succeed.