/typescript-library-template

🏗️📦 Template for creating typescript packages

Primary LanguageTypeScriptMIT LicenseMIT

typescript-library-template

Personal template for creating TypeScript libraries.

Quick start

  1. If it should be published to NPM, add the NPM_TOKEN secret (make sure not to leave a trailing newline in there!). Otherwise, add "private": true in package.json.
  2. Update the package name, description and repo URL in package.json
  3. Enable 'Allow GitHub Actions to create and approve pull requests' in Settings > Actions (General) > `Workflow permissions
  4. Set protection on the master branch: require a pull request before merging, require reivew from code owners, require status checks to pass (select both ci options)
  5. Add the repo to the file sync automation rules
  6. Update the README, using the template commented out below