TS reboot (#13)

* reworked ts, building esm, cjs, and browser

* refinement and docs

* github worflow for CI

Co-authored-by: Phillip Clark <[email protected]>

Author: cerebralkungfu

.eslintignore

@@ -0,0 +1,3 @@
+dist/
+node_modules/
+coverage/

.eslintrc.json

@@ -1,23 +1,22 @@
 {
+  "root": true,
   "env": {
     "browser": false,
-    "es6": true,
-    "node": true
+    "es2020": true,
+    "node": true,
+    "jest": true
   },
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "project": "./tsconfig.json",
     "sourceType": "module"
   },
-  "plugins": [
-    "@typescript-eslint"
-  ],
+  "plugins": ["@typescript-eslint", "jest"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
-    "prettier",
-    "prettier/@typescript-eslint"
+    "plugin:prettier/recommended"
   ],
   "rules": {}
 }

.github/workflows/ci.yaml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - main
+
+  # Allows triggering workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v2
+
+      - name: use node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: install dependencies
+        run: npm ci
+
+      - name: build and test
+        run: npm run ci

.mocharc.json

@@ -1,7 +1,8 @@
 # cleanup-util · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/flitbit/cleanup-util/blob/master/LICENSE)
+
 > Utility for cleaning up event handlers
 
-**cleanup-util** is a small, utility for tracking and cleaning up event handlers. I find this utility useful when I have classes derived from EventHandler that are used throughout the life of my applications and those EventHandlers frequently have event handlers added and removed. It helps me catch memory leaks from dangling event listeners early in the development process.  I hope you find it useful.
+**cleanup-util** is a small, utility for tracking and cleaning up event handlers. I find this utility useful when I have classes derived from EventHandler that are used throughout the life of my applications and those EventHandlers frequently have event handlers added and removed. It helps me catch memory leaks from dangling event listeners early in the development process. I hope you find it useful.
 
 ## Installing / Getting started
 
@@ -23,8 +24,8 @@ function cleanupPropagationEvent<T extends EventEmitter>(
   event: string,
   listener: Listener,
   target: EventEmitter,
-  reciprocal?: string
-): void
+  reciprocal?: string,
+): void;
 ```
 
 Attaches the specified `listener` to the specified `sender`, wrapping the `listener` to track it's cleanup.
@@ -34,7 +35,11 @@ If `reciprocal` is specified, it is the name of an event on `target`, **cleanup-
 ### addCleanupTask
 
 ```ts
-function addCleanupTask<S extends EventEmitter, T>(sender: S, target: T, task: Task): void
+function addCleanupTask<S extends EventEmitter, T>(
+  sender: S,
+  target: T,
+  task: Task,
+): void;
 ```
 
 Adds a task to be run when the cleanup propagation event occurs.
@@ -53,7 +58,7 @@ Clears the instance Id associated with an object.
 
 ## Tests
 
-Tests are built using [Mocha](https://mochajs.org/) and chai.
+Tests are built using [Jest](https://jestjs.io/); we're near 100%!
 
 ```shell
 npm test

.npmignore

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.