Merge pull request #68 from ibmtjbot/dev

new packaging as a hybrid ES6 / CommonJS module

.eslintrc.json

@@ -6,6 +6,7 @@
     "extends": [
         "airbnb-base"
     ],
+    "ignorePatterns": ["dist/**"],
     "parser": "babel-eslint",
     "parserOptions": {
         "ecmaVersion": 12,

.gitignore

@@ -82,7 +82,7 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-dist
+#dist
 
 # Gatsby files
 .cache/

.jsdoc.json

@@ -4,9 +4,9 @@
         "dictionaries": ["jsdoc"]
     },
     "source": {
-        "include": ["lib", "package.json", "README.md"],
+        "include": ["src", "package.json", "README.md"],
         "includePattern": ".js$",
-        "excludePattern": "(node_modules/|docs)"
+        "excludePattern": "(node_modules/|docs|dist|__tests__)"
     },
     "plugins": [
         "plugins/markdown"

MIGRATING.md

@@ -3,12 +3,14 @@
 ## Migrating from 1.x to 2.x
 There have been several significant changes to the 2.x release of TJBotLib that break compatability with the 1.x release. Please use this guide, the new [TJBot API docs](https://ibmtjbot.github.io/docs/tjbot/2.0.1/), and the [updated recipes](https://github.com/ibmtjbot/tjbot/tree/master/recipes) in the `tjbot` repository, to help you migrate your recipes to the new 2.x API.
 
-### ES6 Module
-TJBot is now packaged as an ES6 module, meaning it can be imported as follows:
+### ES6 / CommonJS Hybrid Module
+TJBotLib is now packaged as hybrid ES6 / CommonJS module, meaning it can be imported as follows:
 
-    import TJBot from 'tjbot';
+    import TJBot from 'tjbot'; // ES6
 
-Because of this new packaging, TJBotLib requires Node 15.x.
+    const TJBot = require('tjbot').default; // CommonJS
+
+Node 15.x+ is required to use TJBotLib as an ES6 module.
 
 ### `async`/`await` Semantics
 TJBot now uses `async`/`await` semantics rather than `Promise` semantics. This change has resulted in much cleaner, and easier to understand code. Thus, functions that used to return promises (e.g. `tj.analyzeTone()`) should now be called with `await`.

README.md

@@ -18,10 +18,27 @@ $ npm install --save tjbot
 
 > 💡 Note: The TJBot library was developed for use on Raspberry Pi. It may be possible to develop and test portions of this library on other Linux-based systems (e.g. Ubuntu), but this usage is not officially supported.
 
-2. Instantiate the `TJBot` object.
+2. Import the TJBot library.
+
+TJBot is packaged as both an ES6 and a CommonJS module (explained in [this guide](https://www.sensedeep.com/blog/posts/2021/how-to-create-single-source-npm-module.html)), which means you may import it using either the ES6 `import` statement or the CommonJS `require` method.
+
+For ES6, import TJBot as follows:
 
 ```
 import TJBot from 'tjbot';
+```
+
+For CommonJS, import TJBot as follows:
+
+```
+const TJBot = require('tjbot').default;
+```
+
+> 💡 Note: For CommonJS, the `TJBot` class is exported under a `.default` reference.
+
+3. Instantiate the `TJBot` object.
+
+```
 const tj = new TJBot();
 tj.initialize([TJBot.HARDWARE.LED_NEOPIXEL, TJBot.HARDWARE.SERVO, TJBot.HARDWARE.MICROPHONE, TJBot.HARDWARE.SPEAKER]);
 ```
@@ -123,7 +140,7 @@ The full list of capabilities can be accessed programatically via `TJBot.CAPABIL
 
 ## TJBot API
 
-Please see [the API docs](https://ibmtjbot.github.io/docs/tjbot/2.0.1/) for documentation of the TJBot API.
+Please see [the API docs](https://ibmtjbot.github.io/docs/tjbot/2.0.2/) for documentation of the TJBot API.
 
 > 💡 Please see the [Migration Guide](MIGRATING.md) for guidance on migrating your code to the latest version of the TJBot API.
 

dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}