@adminforth/rich-editor 1.0.2

package/dist/custom/node_modules/quill-delta/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist/",
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2015",
+    "module": "commonjs",
+    "strictNullChecks": true,
+    "noErrorTruncation": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/dist/custom/package-lock.json

@@ -0,0 +1,73 @@
+{
+  "name": "custom",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "custom",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "quill": "^2.0.2"
+      }
+    },
+    "node_modules/eventemitter3": {
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz",
+      "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA=="
+    },
+    "node_modules/fast-diff": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz",
+      "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw=="
+    },
+    "node_modules/lodash-es": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz",
+      "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw=="
+    },
+    "node_modules/lodash.clonedeep": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz",
+      "integrity": "sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ=="
+    },
+    "node_modules/lodash.isequal": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+      "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ=="
+    },
+    "node_modules/parchment": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/parchment/-/parchment-3.0.0.tgz",
+      "integrity": "sha512-HUrJFQ/StvgmXRcQ1ftY6VEZUq3jA2t9ncFN4F84J/vN0/FPpQF+8FKXb3l6fLces6q0uOHj6NJn+2xvZnxO6A=="
+    },
+    "node_modules/quill": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/quill/-/quill-2.0.2.tgz",
+      "integrity": "sha512-QfazNrhMakEdRG57IoYFwffUIr04LWJxbS/ZkidRFXYCQt63c1gK6Z7IHUXMx/Vh25WgPBU42oBaNzQ0K1R/xw==",
+      "dependencies": {
+        "eventemitter3": "^5.0.1",
+        "lodash-es": "^4.17.21",
+        "parchment": "^3.0.0",
+        "quill-delta": "^5.1.0"
+      },
+      "engines": {
+        "npm": ">=8.2.3"
+      }
+    },
+    "node_modules/quill-delta": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/quill-delta/-/quill-delta-5.1.0.tgz",
+      "integrity": "sha512-X74oCeRI4/p0ucjb5Ma8adTXd9Scumz367kkMK5V/IatcX6A0vlgLgKbzXWy5nZmCGeNJm2oQX0d2Eqj+ZIlCA==",
+      "dependencies": {
+        "fast-diff": "^1.3.0",
+        "lodash.clonedeep": "^4.5.0",
+        "lodash.isequal": "^4.5.0"
+      },
+      "engines": {
+        "node": ">= 12.0.0"
+      }
+    }
+  }
+}

package/dist/custom/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "custom",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "quill": "^2.0.2"
+  }
+}

package/dist/custom/quillEditor.vue

@@ -0,0 +1,402 @@
+<template>
+
+  <div 
+    class="bg-gray-50 border border-gray-300 text-gray-900 text-sm rounded-lg focus:ring-blue-500 
+      focus:border-blue-500 block w-full p-2.5 dark:bg-gray-700 dark:border-gray-600 dark:placeholder-gray-400
+      dark:text-white dark:focus:ring-blue-500 dark:focus:border-blue-500 whitespace-normal af-quill-editor"
+  >
+    <div  
+      ref="editor"
+      @keydown.tab.prevent.stop="approveCompletion('all')"
+      @keydown.ctrl.right.prevent.stop="approveCompletion('word')"
+      @keydown.ctrl.down.prevent.stop="startCompletion()"
+    >
+      
+    </div>
+  </div>
+
+
+</template>
+
+<script setup lang="ts">
+import { onMounted, ref, onUnmounted, watch, type Ref } from "vue";
+import { callAdminForthApi } from '@/utils';
+import { AdminForthColumn } from '@/types/AdminForthConfig';
+import AsyncQueue from './async-queue';
+import Quill from "quill";
+import "quill/dist/quill.snow.css";
+
+
+function dbg(title: string,...args: any[]) {
+  // return; // comment for debug
+  console.log(title, ...args.map(a =>JSON.stringify(a, null, 1))); 
+}
+
+const BlockEmbed = Quill.import('blots/block/embed');
+
+// @ts-ignore
+class CompleteBlot extends BlockEmbed {
+  static blotName = 'complete';
+  static tagName = 'span';
+
+  static create(value: { text: string }) {
+    let node = super.create();
+    node.setAttribute('contenteditable', 'false');
+    node.setAttribute('completer', '');
+    node.innerText = value.text;
+    return node;
+  }
+  
+  static value(node: HTMLElement) {
+    return {
+      text: node.innerText,
+    };
+  }
+}
+// @ts-ignore
+Quill.register(CompleteBlot);
+
+const updaterQueue = new AsyncQueue();
+
+const props = defineProps<{
+  column: AdminForthColumn,
+  record: any,
+  meta: any,
+}>();
+
+const emit = defineEmits([
+  'update:value',
+]);
+
+const currentValue: Ref<string> = ref('');
+
+const editor = ref<HTMLElement>();
+const completion = ref<string[] | null>(null);
+let quill: any = null;
+const editorFocused = ref(false);
+
+let lastText: string | null = null;
+
+onMounted(() => {
+  currentValue.value = props.record[props.column.name] || '';
+  editor.value.innerHTML = currentValue.value;
+
+  quill = new Quill(editor.value as HTMLElement, {
+    theme: "snow",
+    placeholder: 'Type here...',
+    // formats : ['complete'],
+    modules: {
+      keyboard: {
+        bindings: {
+          tab: {
+            key: 9,
+            handler: function (range: any, context: any) {
+              if (completion.value !== null) {
+                return true;
+              }
+            },
+          },
+        },
+      }
+    },
+  });
+
+  lastText = quill.getText();
+
+  quill.on(Quill.events.TEXT_CHANGE, async (delta: any, oldDelta: any, source: string) => {
+    dbg('🪽 TEXT_CHANGE fired ', delta, oldDelta, source);
+    updaterQueue.add(emitTextUpdate);
+    startCompletion();
+  });
+  
+  quill.on('selection-change', (range: any, oldRange: any, source: string) => {
+    dbg('🪽 selection changed', range, oldRange, source);
+    if (range === null) {
+      // blur event
+      removeCompletionOnBlur();
+      editorFocused.value = false;
+      return;
+    } else {
+      editorFocused.value = true;
+      startCompletion();
+    }
+    const text = quill.getText();
+    // don't allow to select after completion
+    if (range?.index === text.length) {
+      dbg('✋ prevent selection after completion');
+      quill.setSelection(text.length - 1, 0, 'silent');
+    }
+  });
+
+
+  // handle right swipe on mobile uding document/window, and console log if swiped in right direction
+  if ('ontouchstart' in window) {
+    document.addEventListener('touchstart', handleTouchStart, false);
+    document.addEventListener('touchmove', handleTouchMove, false);
+  }
+
+});
+
+
+async function emitTextUpdate() {
+  const html = quill.root.innerHTML;
+  
+  if (lastText === html) {
+    return;
+  }
+
+  lastText = html;
+
+  await (new Promise((resolve) => setTimeout(resolve, 0)));
+
+  dbg('⬆️ emit value suggestion-input', html);
+  emit('update:value', html);
+}
+
+// Auto-Completion functions
+let tmt: null | ReturnType<typeof setTimeout> = null;
+
+let xDown: null | number = null;
+let yDown: null | number = null;
+
+function handleTouchStart(evt: TouchEvent) {
+  xDown = evt.touches[0].clientX;
+  yDown = evt.touches[0].clientY;
+}
+
+function handleTouchMove(evt: TouchEvent) {
+  if (!xDown || !yDown) {
+    return;
+  }
+
+  let xUp = evt.touches[0].clientX;
+  let yUp = evt.touches[0].clientY;
+
+  let xDiff = xDown - xUp;
+  let yDiff = yDown - yUp;
+
+  if (Math.abs(xDiff) > Math.abs(yDiff)) {
+    if (xDiff < 0) {
+      // complete word if completion and input is focused
+      dbg('👇 swipe right', completion.value, editorFocused.value);
+      if (completion.value !== null && editorFocused.value) {
+        approveCompletion('word');
+        // [Intervention] Unable to preventDefault inside passive event listener due to target being treated as passive. See https://www.chromestatus.com/feature/5093566007214080
+        // evt.preventDefault();
+        evt.stopPropagation();
+      }
+    }
+  }
+
+  xDown = null;
+  yDown = null;
+}
+
+onUnmounted(() => {
+  quill.off(Quill.events.TEXT_CHANGE);
+  quill.off('selection-change');
+
+  if ('ontouchstart' in window) {
+    document.removeEventListener('touchstart', handleTouchStart);
+    document.removeEventListener('touchmove', handleTouchMove);
+  }
+});
+
+
+async function complete(textBeforeCursor: string) {
+  const res = await callAdminForthApi({
+      path: `/plugin/${props.meta.pluginInstanceId}/doComplete`,
+      method: 'POST',
+      body: {
+        record: {...props.record, [props.column.name]: textBeforeCursor},
+      },
+  });
+
+  return res.completion;
+}
+
+function updateCompleteEmbed(text: string) {
+  const curCursorPos = quill.getSelection();
+  const d = quill.getContents();
+  const c = d.ops.find((op: any) => op.insert.complete);
+  if (!c) {
+    return;
+  }
+  c.insert.complete.text = text;
+  quill.setContents(d.ops, 'silent');
+  quill.setSelection(curCursorPos.index, curCursorPos.length, 'silent');
+}
+
+function deleteCompleteEmbed() {
+  const completeNode = quill.root.querySelector('[completer]');
+  const completeBlot = Quill.find(completeNode);
+  const blotIdx: number | null = completeBlot ? quill.getIndex(completeBlot) : null;
+
+  dbg('👇 complete blot idx', blotIdx);
+
+  if (blotIdx !== null) {
+    quill.deleteText(blotIdx, 1, 'silent');
+  }
+}
+
+function approveCompletion(type: 'all' | 'word') { 
+  if (!props.meta.shouldComplete) {
+    return;
+  }
+
+  dbg('💨 approveCompletion')
+
+  if (completion.value === null) {
+    return;
+  }
+
+  const cursorPosition = quill.getSelection();
+
+  let shouldComplete = false;
+  if (type === 'all') {
+    quill.insertText(cursorPosition.index, completion.value.join(''), 'silent');
+    shouldComplete = true;
+  } else {
+    const word = completion.value[0];
+    quill.insertText(cursorPosition.index, word, 'silent');
+    completion.value = completion.value.slice(1);
+    if (completion.value.length === 0) {
+      shouldComplete = true;
+    } else {
+      // update completion
+      // TODO probably better way to update Embed?
+      updateCompleteEmbed(completion.value.join(''));
+    }
+  }
+
+  updaterQueue.add(emitTextUpdate);
+
+  if (shouldComplete) {
+    startCompletion();
+  }
+
+}
+
+async function startCompletion() {
+  if (!props.meta.shouldComplete) {
+    return;
+  }
+  completion.value = null;
+  // return;
+  deleteCompleteEmbed();
+
+  if (tmt) {
+    clearTimeout(tmt);
+  }
+  tmt = setTimeout(async () => {
+    const currentTmt = tmt;
+    const cursorPosition = quill.getSelection();
+    dbg('👇 get pos', cursorPosition.index, cursorPosition.length)
+    if (cursorPosition.length !== 0) {
+      // we will not complete if text selected
+      return;
+    }
+
+    const charAfterCursor = quill.getText(cursorPosition.index, 1);
+    dbg('👇 charAfterCursor', charAfterCursor);
+    if (charAfterCursor !== '\n') {
+      // we will not complete if not at the end of the line
+      return;
+    }
+
+    const textBeforeCursor = quill.getText(0, cursorPosition.index);
+
+    const completionAnswer = await complete(textBeforeCursor);
+    if (currentTmt !== tmt) {
+      // while we were waiting for completion, new completion was started
+      return;
+    }
+
+    // deleteCompleteEmbed();
+    // insert on +1 to insert after \n
+    quill.insertEmbed(cursorPosition.index + 1, 'complete', { text: completionAnswer.join('') }, 'silent');
+
+    dbg('👇 set pos', cursorPosition.index, cursorPosition.length)
+    quill.setSelection(cursorPosition.index, cursorPosition.length, 'silent');
+
+    completion.value = completionAnswer;
+
+    dbg('👇 completion finished', quill.getContents());
+
+  }, props.meta.debounceTime || 300);
+}
+
+function removeCompletionOnBlur() {
+  if (lastText?.trim().length === 0) {
+    completion.value = null;
+    const d = quill.getContents();
+    const i = d.ops.findIndex((op: any) => op.insert.complete);
+    if (i !== -1) {
+      d.ops.splice(i, 1);
+      quill.setContents(d, 'silent');
+      dbg('🧹 Cleaned completion from ops to make ph visible');
+    }
+  }
+}
+
+</script>
+
+<style lang="scss">
+
+.af-quill-editor {
+
+  .ql-toolbar.ql-snow[class] {
+    border: none;
+    padding: 0 0 1rem 0;
+
+    .ql-picker-label{
+      padding-left: 0;
+    }
+  }
+
+  .ql-container {
+    border: 0;
+
+    .ql-editor {
+      position: relative;
+      padding: 0;
+      min-height: 100px;
+
+      &.ql-blank::before {
+        left: 0px;
+        font-style: normal;
+      }
+    }
+  }
+
+  p:has(+ [completer]) br {
+    display: none;
+  }
+  p:has(+ [completer]) {
+    // background: rgb(255 227 227);  // debug
+    display: inline;
+  }
+
+  .ql-editor:not(:focus) [completer] {
+    display: none;
+  }
+
+  .ql-editor [completer] {
+    // important to keep pointer-events non none for cursor position on completer click
+
+    // text is not selectable
+    user-select: none;
+    color: gray;
+
+    // if inline or inline used then user-select: none brakes triple click
+    display: contents;
+
+    font-style: italic;
+  }
+
+}
+
+
+
+
+</style>

package/dist/node_modules/.package-lock.json

@@ -0,0 +1,65 @@
+{
+  "name": "custom",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "node_modules/eventemitter3": {
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz",
+      "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA=="
+    },
+    "node_modules/fast-diff": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz",
+      "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw=="
+    },
+    "node_modules/lodash-es": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz",
+      "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw=="
+    },
+    "node_modules/lodash.clonedeep": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz",
+      "integrity": "sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ=="
+    },
+    "node_modules/lodash.isequal": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+      "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ=="
+    },
+    "node_modules/parchment": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/parchment/-/parchment-3.0.0.tgz",
+      "integrity": "sha512-HUrJFQ/StvgmXRcQ1ftY6VEZUq3jA2t9ncFN4F84J/vN0/FPpQF+8FKXb3l6fLces6q0uOHj6NJn+2xvZnxO6A=="
+    },
+    "node_modules/quill": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/quill/-/quill-2.0.2.tgz",
+      "integrity": "sha512-QfazNrhMakEdRG57IoYFwffUIr04LWJxbS/ZkidRFXYCQt63c1gK6Z7IHUXMx/Vh25WgPBU42oBaNzQ0K1R/xw==",
+      "dependencies": {
+        "eventemitter3": "^5.0.1",
+        "lodash-es": "^4.17.21",
+        "parchment": "^3.0.0",
+        "quill-delta": "^5.1.0"
+      },
+      "engines": {
+        "npm": ">=8.2.3"
+      }
+    },
+    "node_modules/quill-delta": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/quill-delta/-/quill-delta-5.1.0.tgz",
+      "integrity": "sha512-X74oCeRI4/p0ucjb5Ma8adTXd9Scumz367kkMK5V/IatcX6A0vlgLgKbzXWy5nZmCGeNJm2oQX0d2Eqj+ZIlCA==",
+      "dependencies": {
+        "fast-diff": "^1.3.0",
+        "lodash.clonedeep": "^4.5.0",
+        "lodash.isequal": "^4.5.0"
+      },
+      "engines": {
+        "node": ">= 12.0.0"
+      }
+    }
+  }
+}

package/dist/node_modules/eventemitter3/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Arnout Kazemier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/node_modules/eventemitter3/README.md

@@ -0,0 +1,94 @@
+# EventEmitter3
+
+[![Version npm](https://img.shields.io/npm/v/eventemitter3.svg?style=flat-square)](https://www.npmjs.com/package/eventemitter3)[![CI](https://img.shields.io/github/actions/workflow/status/primus/eventemitter3/ci.yml?branch=master&label=CI&style=flat-square)](https://github.com/primus/eventemitter3/actions?query=workflow%3ACI+branch%3Amaster)[![Coverage Status](https://img.shields.io/coveralls/primus/eventemitter3/master.svg?style=flat-square)](https://coveralls.io/r/primus/eventemitter3?branch=master)
+
+[![Sauce Test Status](https://saucelabs.com/browser-matrix/eventemitter3.svg)](https://saucelabs.com/u/eventemitter3)
+
+EventEmitter3 is a high performance EventEmitter. It has been micro-optimized
+for various of code paths making this, one of, if not the fastest EventEmitter
+available for Node.js and browsers. The module is API compatible with the
+EventEmitter that ships by default with Node.js but there are some slight
+differences:
+
+- Domain support has been removed.
+- We do not `throw` an error when you emit an `error` event and nobody is
+  listening.
+- The `newListener` and `removeListener` events have been removed as they
+  are useful only in some uncommon use-cases.
+- The `setMaxListeners`, `getMaxListeners`, `prependListener` and
+  `prependOnceListener` methods are not available.
+- Support for custom context for events so there is no need to use `fn.bind`.
+- The `removeListener` method removes all matching listeners, not only the
+  first.
+
+It's a drop in replacement for existing EventEmitters, but just faster. Free
+performance, who wouldn't want that? The EventEmitter is written in EcmaScript 3
+so it will work in the oldest browsers and node versions that you need to
+support.
+
+## Installation
+
+```bash
+$ npm install --save eventemitter3
+```
+
+## CDN
+
+Recommended CDN:
+
+```text
+https://unpkg.com/eventemitter3@latest/dist/eventemitter3.umd.min.js
+```
+
+## Usage
+
+After installation the only thing you need to do is require the module:
+
+```js
+var EventEmitter = require('eventemitter3');
+```
+
+And you're ready to create your own EventEmitter instances. For the API
+documentation, please follow the official Node.js documentation:
+
+http://nodejs.org/api/events.html
+
+### Contextual emits
+
+We've upgraded the API of the `EventEmitter.on`, `EventEmitter.once` and
+`EventEmitter.removeListener` to accept an extra argument which is the `context`
+or `this` value that should be set for the emitted events. This means you no
+longer have the overhead of an event that required `fn.bind` in order to get a
+custom `this` value.
+
+```js
+var EE = new EventEmitter()
+  , context = { foo: 'bar' };
+
+function emitted() {
+  console.log(this === context); // true
+}
+
+EE.once('event-name', emitted, context);
+EE.on('another-event', emitted, context);
+EE.removeListener('another-event', emitted, context);
+```
+
+### Tests and benchmarks
+
+This module is well tested. You can run:
+
+- `npm test` to run the tests under Node.js.
+- `npm run test-browser` to run the tests in real browsers via Sauce Labs.
+
+We also have a set of benchmarks to compare EventEmitter3 with some available
+alternatives. To run the benchmarks run `npm run benchmark`.
+
+Tests and benchmarks are not included in the npm package. If you want to play
+with them you have to clone the GitHub repository.
+Note that you will have to run an additional `npm i` in the benchmarks folder
+before `npm run benchmark`.
+
+## License
+
+[MIT](LICENSE)