OUTDATED

This template contains a setup that we no longer recommend using.

project-template

This is a template repository to quickly set up new projects for releasing npm packages

Manage dependencies in a pnpm monorepo
Preconfigured GitHub workflows for ci and release
Build dual cjs and esm packages from typescript source with tsup
Test with uvu
Release including generated changelogs with atlassian/changesets
Additional tooling like prettier, eslint, lint-staged already set up
Issue templates for feature requests and bug reports

Initial setup

You can use this either as a GitHub template or with degit as explained below.

GitHub template

Create a new GitHub repo based on this template. Use a simple name like someorg/foo-bar, where someorg is the same on npm and GitHub
Clone your new repo
Run pnpm run setup in the clone
On first run, a setup-script updates the template with urls and names of your new repo, and install dependencies
Commit the changes done by the setup-script
Review project setup
Add an NPM_TOKEN secret in your GitHub repo settings that allows to publish the npm package

degit

Create a new empty repo on GitHub
Run npx degit svitejs/project-template my-project to copy repo locally
In the local repo, run git init and git remote add origin https://github.com/someorg/foo-bar.git (Change remote git URL accordingly)
Run pnpm run setup
On first run, a setup-script updates the template with urls and names of your new repo, and install dependencies
Commit the changes done by the setup-script
Review project setup
Add an NPM_TOKEN secret in your GitHub repo settings that allows to publish the npm package

Development

Use branches for development
Add commits
Add changeset with pnpx changeset
Push branch and open a PR
Check CI results and merge PR into main
Release workflow creates a PR "Version Packages (next)" to collect changes to be released

Release

When you're ready to release, remove "private": true in the main workspace's package.json and push up the change to auto publish. If there are existing changesets, it will create a "Version Packages (next)" PR instead.

Merge "Version Packages (next)" PR into main
Release workflow automatically publishes npm package, creates GitHub release info, and tags the release

NOTE: New workspaces should always have "private": true or it will try to publish them.

Support for commonjs

This template creates esm-only output by default. If you need to support commonjs, follow these steps:

update tsup config to include 'cjs' output and enable shims if needed
update package.json exports map to add "require": "./dist/index.cjs" next to the import mapping

Uh oh!

License

svitejs/project-template

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Contributors 4

Uh oh!

Languages

Error
Looks like something went wrong!

Packages