Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.13 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.13 KB
Raw

Graasp SDK

Latest version published on NPM Latest version released on Github NPM package downloads per month example branch parameter typescript version

This repository contains all shared utils and types for the Graasp ecosystem.

Installation

Run yarn to install the packages.

yarn

Testing

This project uses vitest as the test runner. It is fast, supports ESM and has an API similar to Jest (which was used previously).

To start the tests run:

yarn test

The tests will run in watch mode, meaning that when you edit a file, the tests in that file (or any test file depending on that file) will be re-run. This allows for a fast feedback loop.

Building

This package exposes a ESM and a CommonJS build as well as type declarations for Typescript.

The structure is as follows:

  • esm contains the javascript files to use with ECMAScript Modules (ESM) it is built with the tsconfig.esm.json file.
  • cjs contains the javascript files to use with CommonJS it is built with the tsconfig.cjs.json file.
  • types contains the type declarations for Typescript it is built with the tsconfig.types.json file.

The last bit of the build process is to add a single line package.json file in esm and cjs with the correct value for the type key (commonjs for cjs and module for esm).

Contributors