Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 4.51 KB

README.md

File metadata and controls

79 lines (61 loc) · 4.51 KB
Raw

Fingerprint logo

Build status coverage Release status MIT license Discord server Documentation

This is template repository for creating TypeScript libraries by FingerprintJS team.

Features

Quick start

  1. Clone this repository, remove .git folder and call git init / Use Use this template GitHub button
  2. Setup project specific fields in package.json
  3. Setup artifactName and other build properties in rollup.config.js
  4. If your project emits .d.ts typings, set correct path in package.json for test:dts command or remove it
  5. Use src folder to organize your code and put tests in __test__ folder
  6. If you want isolated run you can use Docker
  7. Push your repo, check that GitHub actions works
  8. Add badges
  9. You are awesome!

Best practice

Choosing name for repository

Check FingerprintJS naming conventions

Team best practise

Described in Integrations and repositories best practices

Tests

For unit tests, we use jest, because of the good infrastructure, flexible instruments for mocks and big community.

This repository contains example of how to configure code coverage reporting without SaaS solutions like codecov (such solutions require token with full access to the repository). In PR#13 you can find what you need to configure:

  • workflow to update the coverage badge in the readme and publish a full report for the main branch
  • workflow to add a comment to pr with coverage of the current branch and diff with main

Documentation

For API reference we use typedoc package and publish documentation in GitHub Pages.

Publish to npm

Publishing to NPM is automated thanks to semantic-release. On every push to main branch it will analyze commits and release new version accordingly to changes.

To set it up:

  1. Add NPM_AUTH_TOKEN to the repository secrets area
  2. Add GH_RELEASE_TOKEN to the repository secrets area, it should have following permissions: public_repo, or repo if your repository is private. Thanks to that, you will get automatic releases on GitHub, comments on issues and more!
  3. Package will publish automatically to NPM when there are relevant changes
  4. You are awesome!

Preparing product for release

Just follow checklist for publishing new integration