ink8bit / ts-lib-template

TypeScript library template for creating npm packages

TS Library template

TypeScript library template for creating npm packages.

Getting started

1. Ensure that you have the right version of node

nvm use

2. Install packages

npm i

Build

npm run build

Testing

npm t

How to contribute

Please refer to CONTRIBUTING.md.

Semantic Versioning

This project follows semantic versioning. I release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.

Built with

• TypeScript
• ESLint
• Prettier
• Babel
• Jest
• husky
• lint-staged

Before publishing

1. Change package name.
2. Fill out keywords section in your package.json.
3. Change private property in package.json to false.
4. Change author's name.
5. Check the license.
6. Fill out the following sections:
   • repository
   • bugs
   • homepage
7. Don't forget to set a version.
8. Check your package content:

npm pack --dry-run

ts-lib-template's Issues

Change build command for CI

Build command

ts-lib-template/.github/workflows/nodejs.yml

Line 26 in b87ae7e

- run: npm run build --if-present

Need to change this to:

- run: npm run types:check
- run: npm run format:check
- run: npm run lint
- run: npm run test:ci

Update labeler workflow

Change test command for CI

Test command

ts-lib-template/.github/workflows/nodejs.yml

Line 27 in b87ae7e

- run: npm test

have to change this command to npm run test:ci for more verbose output.

Use node 16.x

Use node 16.x in workflow file

tsc command for js

Add tsc to lint-staged script

Add CI badges to README

Code owners file

Add code owners file to .github folder.

Update node version

ts-lib-template/babel.config.js

Line 16 in 978fb01

node: '12',

Update TypeScript to v4.x

Remove it from dependabot config

ts-lib-template/.github/dependabot.yml

Line 13 in fea1a30

- dependency-name: "typescript"