Skip to content
/ ts-module Public template

TypeScript NPM package template

License

Notifications You must be signed in to change notification settings

johngeorgewright/ts-module

Repository files navigation

@johngeorgewright/ts-module

This is a template repository for creating a NPM package with TypeScript.

Setting up

  1. Change all references of @johngeorgewright/ts-module to your new package name
  2. Also search for references to @johngeorgewright & ts-module individually
  3. Remove the private property from package.json (if you want to publically publish your module)
  4. Search for all references of secrets. in the .github diectory and make sure you have the appropriate secrets registered in GitHub (Your Repo > Settings > Secrets)
  5. Delete the .github/dependabot.yml file (unless you wish to use that instead of renovate)
  6. Ammend the LICENSE with your name
  7. If your packages are to be published publically, change the publish command in release.config.js to yarn npm publish --access public

Dependency management

By default, this project's dependencies is kept up-to-date with renovate. This project may also be set-up for dependabot too. To do so:

  1. Remove the renovate.json file
  2. mv .github/.dependabot.yml .github/dependabot.yml