0.1.0 • Published 2 years ago

gamif v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

gamif

A library for processing achievements for Read:Advent's gamification.

**Please note this library was created with a very specific use-case; see below for an explanation.

Install

$ yarn add gamif

Usage

API

But Why Tho?

Read:Advent's reader code base uses Unified to process Bible source files. Unified is strictly an ESM package, so consequently, Read:Advent also became ESM. However, Read:Advent is also in TypeScript, and inorder to write unit tests around this specific functionality, ts-node needed to be employed.

But when I tried the steps they describe, it just broke. So instead of spending a ton of time futzing with a build and test system, I spun this out to its own package. For that reason, this is very unlikely to be helpful or useable by anyone else. You're more than welcome to mine the codebase to see if there are any ideas you'd like to emulate.