A template to quickly 📦 any typescript library/project using high industry standards!
NPM_TOKEN
, for auto-publishing via github workflowshttps://github.com/<owner/repo>/settings/secrets/actions
.github/workflows/publish.yml
Squash: Default to pull request title
https://github.com/<owner/repo>/settings#merge-button-settings
https://github.com/<owner/repo>/settings/branch_protection_rules/new
and enable:
test
to the list of required status checkshttps://github.com/<owner/repo>/settings/actions
Let's set a good first example, and create a branch for configurating our project.
We will push changes one by one into our new branch.
Create a branch following Semantic Changes: chore-configurating-initial-project
<repo>
with your repository
<repo>
-> x-classes
<owner/repo>
with your owner/repository
<owner/repo>
-> refzlund/x-classes
packages/template
to <repo>
, ex. -> packages/x-classes
packages/<repo>/package.json
Great! We've configured our project. Let's create our first patch release using changeset.
pnpm i
npx changeset
chore: configurating initial project
chore-configurating-initial-project
chore: configurating initial project
When you're ready to publish a new release, merge the incoming "Version Packages"-pull request by changesets.
Congratsulations! You're a natural🚀🎉
See Development
[!NOTE] Pull requests and issues to this repository are more than welcome🦒
tsconfig.json
allows you to import aliases
vitest run ...
with vitest watch ...
, and it will run the tests when the files change.Here are some repositories that follow similar structure: