From 48c060e4be333838fc4dfbf541e0066fac85237c Mon Sep 17 00:00:00 2001
From: Aria Minaei <aria.minaei@gmail.com>
Date: Wed, 23 Feb 2022 18:58:32 +0100
Subject: [PATCH] Add remarks about the core bundle

---
 theatre/core/src/index.ts | 45 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/theatre/core/src/index.ts b/theatre/core/src/index.ts
index 6094b05..2faf3ca 100644
--- a/theatre/core/src/index.ts
+++ b/theatre/core/src/index.ts
@@ -18,9 +18,17 @@ import CoreBundle from './CoreBundle'
 
 registerCoreBundle()
 
+/**
+ * @remarks
+ * the studio and core need to communicate with each other somehow, and currently we do that
+ * by registering each of them as a global variable. This function does the work of registering
+ * the core bundle (everything exported from `@theatre/core`) to window.__TheatreJS_CoreBundle.
+ */
 function registerCoreBundle() {
+  // This only works in a browser environment
   if (typeof window == 'undefined') return
 
+  // another core bundle may already be registered
   // @ts-ignore ignore
   const existingBundle = window[globalVariableNames.coreBundle]
 
@@ -30,6 +38,43 @@ function registerCoreBundle() {
       existingBundle &&
       typeof existingBundle.version === 'string'
     ) {
+      /*
+      Another core bundle is registered. This usually means the bundler is not configured correctly and
+      is bundling `@theatre/core` multiple times, but, there are legitimate scenarios where a user may want
+      to include multiple instances of `@theatre/core` on the same page.
+
+      For example, an article might embed two separate interactive graphics that
+      are made by different teams (and even different tech stacks -- one in JS, the other in clojurescript).
+
+      If both of those graphics use Theatre.js, our current setup makes them conflict with one another.
+
+      ----------------------
+      --------------------
+      ----------------------
+      -------.
+
+      |   /\_/\   |
+      |  ( o.o )  |      --------> graphic1 made with JS+Theatre.js
+      |   > ^ <   |
+
+      ## ---
+      ----------------------
+      --------------------
+      ----------------------
+      -------.
+
+      |    __      _   |
+      |  o'')}____//   | --------> graphic2 made with clojurescript+Theatre.js
+      |  `_/      )    |
+      |  (_(_/-(_/     |
+      
+      ---------------------
+      -----♥.
+
+      @todo Make it possible to have multiple separate bundles on the same page, but still communicate
+      that there is more than one bundle so we can warn the user about bundler misconfiguration.
+      
+      */
       throw new Error(
         `It seems that the module '@theatre/core' is loaded more than once. This could have two possible causes:\n` +
           `1. You might have two separate versions of theatre in node_modules.\n` +