Skip to content

This template helps you make a quick TS project with the same config and toolchain I use.

License

Notifications You must be signed in to change notification settings

santi100a/npm-library-template

Repository files navigation

Template for my NPM libraries

Hello, everyone! This is a template repo for my libraries. You'll find a readme template inside this file.

In order for the CI workflow's publishing jobs to execute successfully, you must have two Actions secrets set up -- NPM_AUTH_TOKEN and GPR_AUTH_TOKEN.

You might want to check the YAML Actions workflow for hints and information you may want or need to know.

Template features

  • License (both template contents and code built from it): MIT.

  • Code of conduct: adapted from the Contributor Covenant.

  • Package manager: Yarn 1.22.19.

  • Automatic testing: Jest.

  • TypeScript 4.9.5 for built-in type definitions and support for compiling to ES3.

  • ESLint and Prettier.

  • Security policy and contribution guidelines.

  • Self-made scripts for verification of package.json and creation of an ESM wrapper around TypeScript's CommonJS output to allow for usage within both CJS and ESM projects.

Your todos as a user of this template

  • Change all placeholders all over different files.
  • Fill this README template.

About

This template helps you make a quick TS project with the same config and toolchain I use.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published