Repository files navigation

Opinionated TypeScript template for new packages.

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

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

3. Search fortemplate-ts-package and replace it with the package name. Ignore the template repository URL in theNOTES.md file.
4. Search forOpinionated TypeScript template for new packages. and replace it with the (short) package description.
5. Search forJoão Palmeiro and replace it with the author's name.
6. Search forjoaopalmeiro@proton.me and replace it with the author's email address.
7. Change theauthor.url field in thepackage.json file to the author's website/social media profile.
8. Installfnm (if necessary).
9. Run the first two commands in theDevelopment section to installNode.js and the development dependencies.
10. Open theNOTES.md file and install the package-specific dependencies according to the first command in theCommands section.
11. Update theSource code link at the top to the package repository link (if necessary).
12. ChangeGitHub in theDeployment section toGitLab orCodeberg and update the link to the corresponding Tags page (if necessary).
13. Update thehomepage,bugs.url, andrepository.url fields in thepackage.json file with their respective repository-related links (if necessary).
14. Delete theTEMPLATE.md file.
15. Delete theGetting Started section.

Installfnm (if necessary).

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

npm install

npm run lint

npm run format

npm run build

npm pack --dry-run

npm version patch

npm version minor

npm version major

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

• Commit and push changes.
• Create a tag onGitHub Desktop.
• CheckGitHub.

npm login

npm publish

• Checknpm.