GitHub - joaopalmeiro/template-ts-package: Opinionated TypeScript template for new packages. (original) (raw)

Skip to content

Navigation Menu

• • GitHub Copilot Write better code with AI
  • GitHub Advanced Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less
• Explore
  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights
• • GitHub Sponsors Fund open source developers
  • The ReadME Project GitHub community articles
• • Enterprise platform AI-powered developer platform
• Pricing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

template-ts-package

Opinionated TypeScript template for new packages.

• Source code
• npm package
• Licenses
• Package Phobia
• bundlejs
• npm trends
• Snyk Advisor
• Visualization of npm dependencies

Getting Started

1. Go to or create the package folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-ts-package

or

npx degit github:joaopalmeiro/template-ts-package --force

1. Search for template-ts-package and replace it with the package name. Ignore the template repository URL in the NOTES.md file.
2. Search for Opinionated TypeScript template for new packages. and replace it with the (short) package description.
3. Search for João Palmeiro and replace it with the author's name.
4. Search for joaopalmeiro@proton.me and replace it with the author's email address.
5. Change the author.url field in the package.json file to the author's website/social media profile.
6. Install fnm (if necessary).
7. Run the first two commands in the Development section to install Node.js and the development dependencies.
8. Open the NOTES.md file and install the package-specific dependencies according to the first command in the Commands section.
9. Update the Source code link at the top to the package repository link (if necessary).
10. Change GitHub in the Deployment section to GitLab or Codeberg and update the link to the corresponding Tags page (if necessary).
11. Update the homepage, bugs.url, and repository.url fields in the package.json file with their respective repository-related links (if necessary).
12. Delete the TEMPLATE.md file.
13. Delete the Getting Started section.

Development

Install fnm (if necessary).

fnm install && fnm use && node --version && npm --version

Deployment

echo "v$(npm pkg get version | tr -d ")" | pbcopy

• Commit and push changes.
• Create a tag on GitHub Desktop.
• Check GitHub.
• Check npm.